IP-Adressen auflisten
GET
/api/v1/
operationIdgetServerIps
- Erforderliche Stufe
- Nur Lesen
- Kontingent
- Lesen, 3.600 Aufrufe pro Stunde
Adressen des VPS (primäre IPv4- und IPv6-Adresse, zusätzliche Adressen) mit ihrem aktuellen Reverse DNS. Nicht paginierte Liste.
Die Adressen stammen aus dem Inventar, nicht vom Hypervisor. Nur der Reverse-Eintrag hängt von einem externen Aufruf ab: Schlägt dieser fehl, hat reverse den Wert null, statt die gesamte Antwort scheitern zu lassen.
Pfadparameter
-
vmidstring erforderlich -
Bezeichner des VPS. Er muss zum Konto und zum Umfang des Schlüssels gehören.
Antworten
200
Adressen des VPS
{
"data": [
{
"address": "31.207.34.214",
"type": "IPv4",
"primary": true,
"reverse": "vps116807.serveur-vps.net"
},
{
"address": "2a00:7ee0:9:1:11:6807:1:1",
"type": "IPv6",
"primary": true,
"reverse": "vps116807.serveur-vps.net"
},
{
"address": "51.83.12.98",
"type": "IPv4",
"primary": false,
"reverse": null
}
],
"meta": {
"page": 1,
"per_page": 3,
"total": 3,
"total_pages": 1
}
}
Felder der Antwort 10
-
dataobject[]erforderlich -
addressstring -
typestring -
primarybooleanPrimäre Adresse des VPS
-
reversestringReverse DNS;
null, wenn nicht vorhanden oder nicht aufgelöst -
metaobjecterforderlichPaginierung. Nicht paginierte Listen geben alles zurück, und
metagibt die zurückgegebene Anzahl wieder. -
pageinteger (int64)Zurückgegebene Seite
-
per_pageinteger (int64)Seitengröße
-
totalinteger (int64)Gesamtzahl der Elemente
-
total_pagesinteger (int64)Gesamtzahl der Seiten
401
Authentifizierung abgelehnt: invalid_token — Header Authorization fehlt oder ist fehlerhaft, oder Schlüssel unbekannt; access_disabled — API-Zugang für dieses Konto gesperrt, oder API-Dienst vorübergehend von LWS abgeschaltet.
invalid_token — Header Authorization fehlt oder ist fehlerhaft, oder Schlüssel unbekannt; access_disabled — API-Zugang für dieses Konto gesperrt, oder API-Dienst vorübergehend von LWS abgeschaltet.Header Authorization fehlt oder ist fehlerhaft, oder Schlüssel unbekannt
{
"type": "https://docs.lws.fr/kvm/errors/invalid-token",
"title": "Authentification invalide",
"status": 401,
"code": "invalid_token",
"detail": "Clé inconnue ou révoquée.",
"request_id": "3f9a1c07b2e45d18"
}
API-Zugang für dieses Konto gesperrt, oder API-Dienst vorübergehend von LWS abgeschaltet
{
"type": "https://docs.lws.fr/kvm/errors/access-disabled",
"title": "Accès API désactivé",
"status": 401,
"code": "access_disabled",
"detail": "L'accès API est désactivé pour ce compte. Réactivez-le depuis la page « API / MCP » du panel.",
"request_id": "3f9a1c07b2e45d18"
}
Felder der Antwort 18
-
typestring (uri)erforderlich -
titlestringerforderlichKurztitel
-
statusinteger (int64)erforderlichHTTP-Status
-
codestringerforderlichStabiler Maschinencode (siehe „Fehler“ in Erste Schritte)
-
detailstringerforderlichAusführliche Meldung
-
request_idstringerforderlichBezeichner der Anfrage, an den Support weiterzugeben
-
errorsobjectvalidation_failed: Meldung je fehlerhaftem Parameter -
required_levelstringinsufficient_scope: vom Vorgang geforderte Stufe -
task_idstringtask_already_running: laufende Aufgabe auf diesem VPS -
familystringrate_limited: ausgeschöpfte Kontingentgruppe -
limitinteger (int64)rate_limited: stündliche Obergrenze der Gruppe -
retry_afterinteger (int64)rate_limited: Sekunden bis zum nächsten Versuch -
lockstringserver_locked: vom Hypervisor gesetzte Sperre (backup,snapshot,suspended…) -
reasonstringserver_locked:operation_in_progress– ein Vorgang läuft, versuchen Sie es nachRetry-Aftererneut;suspended– der VPS befindet sich im Ruhezustand, starten Sie ihn zuerst;support_notified– ungewöhnliche Sperre, das LWS-Team ist informiert und kümmert sich darum -
maintenanceobjectserver_maintenance: Art des Eingriffs, Beginn und voraussichtliches Ende (nullbei einem Vorfall) -
kindstring -
started_atstring (date-time) -
expected_endstring (date-time)
403
Zugriff verweigert: ip_not_allowed — aufrufende Adresse nicht zugelassen.
ip_not_allowed — aufrufende Adresse nicht zugelassen.{
"type": "https://docs.lws.fr/kvm/errors/ip-not-allowed",
"title": "Adresse non autorisée",
"status": 403,
"code": "ip_not_allowed",
"detail": "L'adresse 203.0.113.10 ne figure pas parmi les adresses autorisées de ce compte.",
"request_id": "3f9a1c07b2e45d18"
}
Felder der Antwort 18
-
typestring (uri)erforderlich -
titlestringerforderlichKurztitel
-
statusinteger (int64)erforderlichHTTP-Status
-
codestringerforderlichStabiler Maschinencode (siehe „Fehler“ in Erste Schritte)
-
detailstringerforderlichAusführliche Meldung
-
request_idstringerforderlichBezeichner der Anfrage, an den Support weiterzugeben
-
errorsobjectvalidation_failed: Meldung je fehlerhaftem Parameter -
required_levelstringinsufficient_scope: vom Vorgang geforderte Stufe -
task_idstringtask_already_running: laufende Aufgabe auf diesem VPS -
familystringrate_limited: ausgeschöpfte Kontingentgruppe -
limitinteger (int64)rate_limited: stündliche Obergrenze der Gruppe -
retry_afterinteger (int64)rate_limited: Sekunden bis zum nächsten Versuch -
lockstringserver_locked: vom Hypervisor gesetzte Sperre (backup,snapshot,suspended…) -
reasonstringserver_locked:operation_in_progress– ein Vorgang läuft, versuchen Sie es nachRetry-Aftererneut;suspended– der VPS befindet sich im Ruhezustand, starten Sie ihn zuerst;support_notified– ungewöhnliche Sperre, das LWS-Team ist informiert und kümmert sich darum -
maintenanceobjectserver_maintenance: Art des Eingriffs, Beginn und voraussichtliches Ende (nullbei einem Vorfall) -
kindstring -
started_atstring (date-time) -
expected_endstring (date-time)
404
Ressource nicht gefunden: vm_not_found — VPS existiert nicht oder liegt außerhalb des Umfangs des Schlüssels.
vm_not_found — VPS existiert nicht oder liegt außerhalb des Umfangs des Schlüssels.{
"type": "https://docs.lws.fr/kvm/errors/vm-not-found",
"title": "VPS introuvable",
"status": 404,
"code": "vm_not_found",
"detail": "Aucun VPS 999999 sur ce compte.",
"request_id": "3f9a1c07b2e45d18"
}
Felder der Antwort 18
-
typestring (uri)erforderlich -
titlestringerforderlichKurztitel
-
statusinteger (int64)erforderlichHTTP-Status
-
codestringerforderlichStabiler Maschinencode (siehe „Fehler“ in Erste Schritte)
-
detailstringerforderlichAusführliche Meldung
-
request_idstringerforderlichBezeichner der Anfrage, an den Support weiterzugeben
-
errorsobjectvalidation_failed: Meldung je fehlerhaftem Parameter -
required_levelstringinsufficient_scope: vom Vorgang geforderte Stufe -
task_idstringtask_already_running: laufende Aufgabe auf diesem VPS -
familystringrate_limited: ausgeschöpfte Kontingentgruppe -
limitinteger (int64)rate_limited: stündliche Obergrenze der Gruppe -
retry_afterinteger (int64)rate_limited: Sekunden bis zum nächsten Versuch -
lockstringserver_locked: vom Hypervisor gesetzte Sperre (backup,snapshot,suspended…) -
reasonstringserver_locked:operation_in_progress– ein Vorgang läuft, versuchen Sie es nachRetry-Aftererneut;suspended– der VPS befindet sich im Ruhezustand, starten Sie ihn zuerst;support_notified– ungewöhnliche Sperre, das LWS-Team ist informiert und kümmert sich darum -
maintenanceobjectserver_maintenance: Art des Eingriffs, Beginn und voraussichtliches Ende (nullbei einem Vorfall) -
kindstring -
started_atstring (date-time) -
expected_endstring (date-time)
429
Kontingent überschritten: rate_limited — stündliches Kontingent der Gruppe ausgeschöpft.
rate_limited — stündliches Kontingent der Gruppe ausgeschöpft.{
"type": "https://docs.lws.fr/kvm/errors/rate-limited",
"title": "Quota dépassé",
"status": 429,
"code": "rate_limited",
"detail": "Quota dépassé pour les opérations de type « read » : 3600 appels par heure. Réessayez dans 37 seconde(s).",
"request_id": "3f9a1c07b2e45d18",
"family": "read",
"limit": 3600,
"retry_after": 37
}
Felder der Antwort 18
-
typestring (uri)erforderlich -
titlestringerforderlichKurztitel
-
statusinteger (int64)erforderlichHTTP-Status
-
codestringerforderlichStabiler Maschinencode (siehe „Fehler“ in Erste Schritte)
-
detailstringerforderlichAusführliche Meldung
-
request_idstringerforderlichBezeichner der Anfrage, an den Support weiterzugeben
-
errorsobjectvalidation_failed: Meldung je fehlerhaftem Parameter -
required_levelstringinsufficient_scope: vom Vorgang geforderte Stufe -
task_idstringtask_already_running: laufende Aufgabe auf diesem VPS -
familystringrate_limited: ausgeschöpfte Kontingentgruppe -
limitinteger (int64)rate_limited: stündliche Obergrenze der Gruppe -
retry_afterinteger (int64)rate_limited: Sekunden bis zum nächsten Versuch -
lockstringserver_locked: vom Hypervisor gesetzte Sperre (backup,snapshot,suspended…) -
reasonstringserver_locked:operation_in_progress– ein Vorgang läuft, versuchen Sie es nachRetry-Aftererneut;suspended– der VPS befindet sich im Ruhezustand, starten Sie ihn zuerst;support_notified– ungewöhnliche Sperre, das LWS-Team ist informiert und kümmert sich darum -
maintenanceobjectserver_maintenance: Art des Eingriffs, Beginn und voraussichtliches Ende (nullbei einem Vorfall) -
kindstring -
started_atstring (date-time) -
expected_endstring (date-time)
502
Abhängigkeit nicht erreichbar: upstream_unavailable — VPS-Inventar vorübergehend nicht verfügbar.
upstream_unavailable — VPS-Inventar vorübergehend nicht verfügbar.{
"type": "https://docs.lws.fr/kvm/errors/upstream-unavailable",
"title": "Service momentanément indisponible",
"status": 502,
"code": "upstream_unavailable",
"detail": "Inventaire des VM indisponible.",
"request_id": "3f9a1c07b2e45d18"
}
Felder der Antwort 18
-
typestring (uri)erforderlich -
titlestringerforderlichKurztitel
-
statusinteger (int64)erforderlichHTTP-Status
-
codestringerforderlichStabiler Maschinencode (siehe „Fehler“ in Erste Schritte)
-
detailstringerforderlichAusführliche Meldung
-
request_idstringerforderlichBezeichner der Anfrage, an den Support weiterzugeben
-
errorsobjectvalidation_failed: Meldung je fehlerhaftem Parameter -
required_levelstringinsufficient_scope: vom Vorgang geforderte Stufe -
task_idstringtask_already_running: laufende Aufgabe auf diesem VPS -
familystringrate_limited: ausgeschöpfte Kontingentgruppe -
limitinteger (int64)rate_limited: stündliche Obergrenze der Gruppe -
retry_afterinteger (int64)rate_limited: Sekunden bis zum nächsten Versuch -
lockstringserver_locked: vom Hypervisor gesetzte Sperre (backup,snapshot,suspended…) -
reasonstringserver_locked:operation_in_progress– ein Vorgang läuft, versuchen Sie es nachRetry-Aftererneut;suspended– der VPS befindet sich im Ruhezustand, starten Sie ihn zuerst;support_notified– ungewöhnliche Sperre, das LWS-Team ist informiert und kümmert sich darum -
maintenanceobjectserver_maintenance: Art des Eingriffs, Beginn und voraussichtliches Ende (nullbei einem Vorfall) -
kindstring -
started_atstring (date-time) -
expected_endstring (date-time)