Miqyaslar, URL-lər və sorğu formatı

Bu istinad REST API URL-lərinin necə qurulduğunu, sorğuların və cavabların hansı başlıqları daşıdığını, sorğu və cavab gövdələrinin necə formatlandığını təsvir edir. Əməliyyatların özləri üçün API istinadı səhifəsinə baxın.

URL strukturuKeçidi kopyalayın

Sorğu URL-i bu hissələrdən ibarətdir:

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

Bəzi nümunələr:

Yola daxil etdiyiniz hər seqmenti, məsələn, ID-ni və ya adı URL-də istifadə üçün kodlaşdırın.

Layihənin ID-sini tapınKeçidi kopyalayın

Yoldakı miqyas ID-si layihənin ID-sidir. Onu iki yerdə tapa bilərsiniz:

• Konsolun ünvanı. Layihənin hər səhifəsinin ünvanı dil kodundan sonra /t/<tenant-id>/s/<subscription-id>/project/<project-id>/… formasındadır. /project/ seqmentindən sonra gələn hissə layihənin ID-sidir.
• API. GET /account/whoami girişiniz olan tenant-ları, abunəlikləri (subscription) və layihələri ID-ləri ilə birlikdə qaytarı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"
            }
          ]
        }
      ]
    }
  ]
}

Abunəliyin və layihənin adını dəyişdikdə onların ID-ləri dəyişmir. ID-ləri adlardan çıxarmaq əvəzinə onları GET /account/whoami cavabından oxuyun.

whoami əməliyyatını API tokeni (API token) və ya xidmət hesabının (service account) açarı ilə çağırdıqda o, yalnız həmin giriş məlumatının aid olduğu tenant-ı sadalayır.

XidmətlərKeçidi kopyalayın

API-də ölçü (size) flavor adlanır: flavors ölçüləri sadalayır. Bir neçə yol layihəyə aid deyil:

Heç bir xidmətə uyğun gəlməyən yol 404 Not Found qaytarır.

MetodlarKeçidi kopyalayın

Sorğu başlıqlarıKeçidi kopyalayın

Cavab başlıqlarıKeçidi kopyalayın

Gövdə formatıKeçidi kopyalayın

• JSON. Sorğu və cavab gövdələri JSON formatındadır. Sahə adları camel case üslubunda yazılır, məsələn, deletionProtection və ya subscriptionId.
• Dəyəri olmayan sahələr. Cavabda dəyəri olmayan ixtiyari sahəyə null verilmir, o, ümumiyyətlə daxil edilmir. Sxemin həmişə daxil etdiyi sahə isə cavabda olur və dəyəri olmadıqda null olur.
• Vaxt göstəriciləri. UTC üzrə ISO 8601 sətirləri, məsələn, 2026-10-08T09:30:00Z.
• ID-lər. Daxili quruluşu açıqlanmayan sətirlər. Onlardan API-nin qaytardığı kimi, dəyişmədən istifadə edin.
• Siyahılar. Siyahı əməliyyatı { "data": [...], "meta": {...} } qaytarır. Səhifələmə səhifəsinə baxın.
• Xətalar. Xəta cavabının öz gövdəsi var. Xətalar səhifəsinə baxın.

MəbləğlərKeçidi kopyalayın

Pul məbləğləri valyuta vahidinin on mində birləri ilə ifadə olunan tam ədədlərdir. Adı Minor ilə bitən sahədə belə tam ədəd olur, pul obyektində isə bu ədəd amount sahəsində, valyuta currency sahəsində verilir:

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

Bu amount öz valyutasının 12,5 vahidinə bərabərdir: məbləği valyuta vahidi ilə almaq üçün onu 10.000-ə bölün. Bu tam ədədləri qəpik kimi oxumayın.

NümunəKeçidi 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 host adı.
• <project-id>: layihənin ID-si.
• PC_TOKEN: API tokeninizi saxlayan mühit dəyişəni.

Əlaqəli məzmunKeçidi kopyalayın

• REST API icmalı
• API tokenləri ilə autentifikasiyadan keçin
• Səhifələmə
• API istinadı