Bereiche, URLs und Anfrageformat

Diese Referenz beschreibt, wie URLs der REST-API aufgebaut sind, welche Header Anfragen und Antworten tragen und wie Anfrage- und Antwort-Bodys formatiert sind. Die Vorgänge selbst finden Sie in der API-Referenz.

URL-StrukturLink kopieren

Eine Anfrage-URL besteht aus diesen Teilen:

https://<api-host>/api/v1/scopes/<project-id>/<service>/<collection>/<resource-id>/actions/<action>

Einige Beispiele:

Codieren Sie jedes Pfadsegment, das Sie einfügen, etwa eine ID oder einen Namen, für die Verwendung in einer URL.

ID eines Projekts ermittelnLink kopieren

Die Bereichs-ID in einem Pfad ist die ID eines Projekts. Sie finden sie an zwei Stellen:

• Die Adresse der Konsole. Jede Seite eines Projekts hat nach dem Sprachcode eine Adresse der Form /t/<tenant-id>/s/<subscription-id>/project/<project-id>/…. Der Teil nach /project/ ist die Projekt-ID.
• Die API. GET /account/whoami gibt die Mandanten, Abonnements und Projekte zurück, auf die Sie zugreifen können, mit ihren IDs.

{
  "tenants": [
    {
      "id": "acme",
      "name": "Acme Corp",
      "subscriptions": [
        {
          "id": "acme-production",
          "tenantId": "acme",
          "name": "Production",
          "currency": "TRY",
          "defaultRegion": "ist-1",
          "projects": [
            {
              "id": "acme-production-web-platform",
              "subscriptionId": "acme-production",
              "name": "web-platform",
              "region": "ist-1"
            }
          ]
        }
      ]
    }
  ]
}

Abonnement- und Projekt-IDs ändern sich nicht, wenn Sie Abonnements oder Projekte umbenennen. Lesen Sie die IDs aus GET /account/whoami, statt sie aus Namen abzuleiten.

Wenn Sie whoami mit einem API-Token oder einem Dienstkontoschlüssel aufrufen, listet es nur den Mandanten auf, zu dem die Anmeldedaten gehören.

DiensteLink kopieren

In der API heißt eine Größe Flavor: flavors listet die Größen auf. Einige Pfade liegen nicht unter einem Projekt:

Ein Pfad, der zu keinem Dienst passt, gibt 404 Not Found zurück.

MethodenLink kopieren

AnfrageheaderLink kopieren

AntwortheaderLink kopieren

Body-FormatLink kopieren

• JSON. Anfrage- und Antwort-Bodys sind JSON. Feldnamen stehen in Camel Case, z. B. deletionProtection oder subscriptionId.
• Felder ohne Wert. In einer Antwort wird ein optionales Feld ohne Wert weggelassen, statt auf null gesetzt zu werden. Ein Feld, das das Schema immer enthält, ist vorhanden und ist null, wenn es keinen Wert hat.
• Zeitstempel. ISO-8601-Zeichenfolgen in UTC, z. B. 2026-10-08T09:30:00Z.
• IDs. Opake Zeichenfolgen. Verwenden Sie sie genau so, wie die API sie zurückgibt.
• Listen. Ein Listenvorgang gibt { "data": [...], "meta": {...} } zurück. Siehe Paginierung.
• Fehler. Eine Fehlerantwort hat einen eigenen Body. Siehe Fehler.

BeträgeLink kopieren

Geldbeträge sind Ganzzahlen in Zehntausendsteln der Währungseinheit. Ein Feld, dessen Name auf Minor endet, enthält eine solche Ganzzahl, und ein Geldobjekt enthält eine in amount, mit der Währung in currency:

{ "amount": 125000, "currency": "TRY" }

Dieser amount entspricht 12,5 Einheiten seiner Währung: Teilen Sie durch 10.000, um den Betrag in der Währungseinheit zu erhalten. Lesen Sie diese Ganzzahlen nicht als Cent.

BeispielLink kopieren

curl "https://<api-host>/api/v1/scopes/<project-id>/compute/instances?page=1&pageSize=50" \
  -H "Authorization: Bearer $PC_TOKEN"

• <api-host>: der Hostname der API.
• <project-id>: die ID des Projekts.
• PC_TOKEN: eine Umgebungsvariable, die Ihr API-Token enthält.

Zugehöriger InhaltLink kopieren

• REST-API-Übersicht
• Mit API-Tokens authentifizieren
• Paginierung
• API-Referenz