Xətalar

Sorğu uğursuz olduqda API HTTP xəta statusu və xətanı təsvir edən JSON gövdəsi qaytarır. Bu istinad formatı, kodları və onlarla necə davranmağı sadalayır.

Xəta formatıKeçidi kopyalayın

{
  "code": "VALIDATION_FAILED",
  "message": "2 fields failed validation: name, sizeGb",
  "field": "name",
  "details": {
    "errors": [
      { "field": "name", "code": "string_too_short", "message": "String should have at least 1 character" },
      { "field": "sizeGb", "code": "missing", "message": "Field required" }
    ]
  }
}

API 400 Bad Request statusundan istifadə etmir: əməliyyatın sxeminə uyğun gəlməyən sorğu 422 Unprocessable Entity qaytarır.

Status kodları və xəta kodlarıKeçidi kopyalayın

Bəzi sorğular regionun təklif etmədiyi imkan üçün də 404 Not Found qaytarır, məsələn, regionun təmin edə bilmədiyi saxlanma zamanı şifrləməni tələb etdikdə. Mesaj imkanı və regionu göstərir. Təkrar cəhd bu cavabı dəyişə bilməz.

İdxal edilmiş layihələrKeçidi kopyalayın

Bu kodlar yalnız platforma operatorunun sizin üçün mövcud resursları ilə birlikdə idxal etdiyi layihələrdə görünür:

Yoxlama xətalarıKeçidi kopyalayın

Etibarsız sorğu üçün 422 Unprocessable Entity cavabı bütün problemləri bir dəfəyə details.errors daxilində sadalayır. Hər elementdə bunlar var:

• field: sahənin sorğudakı yolu, səviyyələr arasında nöqtələrlə, problem bütövlükdə gövdəyə aid olduqda isə null.
• code: problemin növü, məsələn, missing və ya string_too_short.
• message: ingilis dilində təsvir.

Yuxarı səviyyədəki field birinci elementi təsvir edir, message isə bütün sahələri sadalayır. Sorğunu yenidən göndərməzdən əvvəl sadalanan bütün sahələri düzəldin.

Sorğu limitiKeçidi kopyalayın

API şlüzü hər giriş məlumatının sorğu göndərmə sürətini məhdudlaşdırır. Hər API tokeninin, xidmət hesabı açarının və konsol seansının öz limiti var, giriş məlumatı olmayan sorğular isə mənbə IP ünvanı üzrə məhdudlaşdırılır. Limit davamlı sürətdən yuxarı qısa sıçrayışlara imkan verir.

API tokeni və ya xidmət hesabı açarı üçün limit hər giriş məlumatına və əlavə olaraq hər tenant-a, tenant-ın bütün giriş məlumatları üzrə birlikdə tətbiq olunur. Belə sorğunun hər cavabı bu başlıqları daşıyır:

Limiti aşdıqda şlüz RATE_LIMITED kodu, "retryable": true və gözləmə saniyələrinin sayını (ən azı 1) göstərən Retry-After başlığı ilə 429 Too Many Requests cavabını qaytarır. Növbəti sorğunu göndərməzdən əvvəl ən azı bu qədər gözləyin.

Bu limit REST API-yə göndərilən sorğulara aiddir. Tətbiq giriş məlumatlarının (application credential) limitləri üçün OpenStack API limitləri səhifəsinə baxın.

Asinxron əməliyyatlarda xətalarKeçidi kopyalayın

202 Accepted sorğusunun işi uğursuz olduqda əməliyyatın state sahəsi FAILED olur, error sahəsində isə yuxarıdakı formatda xəta olur. Uğurlu əməliyyat tələb etdiyiniz nəyisə təmin etmək mümkün olmadıqda eyni formatda warning daşıya bilər. Sinxron və asinxron sorğular bölməsinə baxın.

API-nin qarşısındakı şəbəkədən gələn cavablarKeçidi kopyalayın

Yerləşdirmə zamanı API-nin qarşısındakı proksi yuxarıdakı xəta formatında olmayan, məsələn, adi mətn gövdəsi ilə 500, 502, 503 və ya 504 cavabı qaytara bilər. Belə cavab sorğunuzun API-yə çatmadığını bildirir. Onu artan fasilələrlə və eyni Idempotency-Key ilə yenidən göndərin.

Xətalarda təkrar cəhdKeçidi kopyalayın

• Cavabda "retryable": true olduqda, həmçinin xəta formatında olmayan 500, 502, 503 və ya 504 cavabından sonra yenidən cəhd edin. Eyni Idempotency-Key dəyərini yenidən göndərin. İdempotent sorğular səhifəsinə baxın.
• Hər təkrar cəhddən əvvəl daha uzun gözləyin, məsələn, 1, 2, 4, sonra isə 8 saniyə. 429 cavabından sonra ən azı Retry-After vaxtı qədər gözləyin.
• Digər 4xx xətalarını dəyişiklik etmədən təkrarlamayın. Əvvəlcə sorğunu, giriş məlumatını və ya resursun vəziyyətini düzəldin.

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

• REST API icmalı
• API tokenləri ilə autentifikasiyadan keçin
• İdempotent sorğular