Kapsamlar, URL’ler ve istek biçimi

Bu referans, REST API URL’lerinin nasıl oluşturulduğunu, isteklerin ve yanıtların hangi başlıkları taşıdığını ve istek ve yanıt gövdelerinin nasıl biçimlendirildiğini açıklar. İşlemlerin kendisi için bkz. API referansı.

URL yapısıBağlantıyı kopyalayın

Bir istek URL’si şu bölümlerden oluşur:

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

Bazı örnekler:

Yola eklediğiniz ID veya ad gibi her bölümü URL’de kullanılmak üzere kodlayın.

Projenin ID’sini bulmaBağlantıyı kopyalayın

Yoldaki kapsam ID’si bir projenin ID’sidir. Bunu iki yerde bulabilirsiniz:

• Konsolun adresi. Bir projenin her sayfasının adresi, dil kodundan sonra /t/<tenant-id>/s/<subscription-id>/project/<project-id>/… biçimindedir. /project/ sonrasındaki bölüm proje ID’sidir.
• API. GET /account/whoami, erişebildiğiniz kuruluşları, abonelikleri ve projeleri ID’leriyle birlikte döndürür.

{
  "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"
            }
          ]
        }
      ]
    }
  ]
}

Abonelik ve proje ID’leri, bunları yeniden adlandırdığınızda değişmez. ID’leri adlardan türetmek yerine GET /account/whoami yanıtından okuyun.

whoami işlemini bir API belirteci veya servis hesabı anahtarıyla çağırdığınızda yalnızca kimlik bilgisinin ait olduğu kuruluş listelenir.

HizmetlerBağlantıyı kopyalayın

API’de boyuta flavor denir: flavors boyutları listeler. Birkaç yol bir projenin altında değildir:

Hiçbir hizmetle eşleşmeyen bir yol 404 Not Found döndürür.

YöntemlerBağlantıyı kopyalayın

İstek başlıklarıBağlantıyı kopyalayın

Yanıt başlıklarıBağlantıyı kopyalayın

Gövde biçimiBağlantıyı kopyalayın

• JSON. İstek ve yanıt gövdeleri JSON’dur. Alan adları deletionProtection veya subscriptionId gibi camelCase biçimindedir.
• Değeri olmayan alanlar. Bir yanıtta değeri olmayan isteğe bağlı bir alan, null olarak ayarlanmaz, yanıta hiç eklenmez. Şemanın her zaman içerdiği bir alan ise yanıtta bulunur ve değeri yoksa null olur.
• Zaman damgaları. UTC’ye göre ISO 8601 dizeleri; örneğin 2026-10-08T09:30:00Z.
• ID’ler. Opak dizeler. Bunları API’nin döndürdüğü şekliyle, birebir kullanın.
• Listeler. Bir listeleme işlemi { "data": [...], "meta": {...} } döndürür. Bkz. Sayfalama.
• Hatalar. Hata yanıtının kendine ait bir gövdesi vardır. Bkz. Hatalar.

TutarlarBağlantıyı kopyalayın

Para tutarları, para biriminin on binde biri cinsinden tam sayılardır. Adı Minor ile biten bir alan böyle bir tam sayı taşır; para nesnesi ise bu tam sayıyı amount içinde, para birimini de currency içinde taşır:

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

Bu amount, para biriminin 12,5 birimidir: tutarı para birimi cinsinden bulmak için 10.000’e bölün. Bu tam sayıları kuruş olarak okumayın.

ÖrnekBağlantıyı kopyalayın

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

• <api-host>: API’nin ana bilgisayar adı.
• <project-id>: projenin ID’si.
• PC_TOKEN: API belirtecinizi tutan bir ortam değişkeni.

İlgili içerikBağlantıyı kopyalayın

• REST API’ye genel bakış
• API belirteçleriyle kimlik doğrulama
• Sayfalama
• API referansı