تعيين الإصدار

يجب أن يوفر كل طلب عميل إصدار API صريحًا كمعلمة سلسلة استعلام. على سبيل المثال: https://{myconfig}.azconfig.io/kv?api-version=1.0.

api-version يتم التعبير عنه بتنسيق SemVer (رئيس.ثانوي). لا يتم دعم التفاوض على النطاق أو الإصدار.

تنطبق هذه المقالة على إصدار واجهة برمجة التطبيقات 1.0.

يوضح التالي ملخصًا للاستجابات المحتملة للخطأ التي تم إرجاعها بواسطة الخادم عندما لا يمكن مطابقة إصدار واجهة برمجة التطبيقات المطلوب.

إصدار واجهة برمجة التطبيقات غير محدد

يحدث هذا الخطأ عندما يقوم عميل بإجراء طلب دون توفير إصدار واجهة برمجة التطبيقات.

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=utf-8
{
  "type": "https://azconfig.io/errors/invalid-argument",
  "title": "API version is not specified",
  "name": "api-version",
  "detail": "An API version is required, but was not specified.",
  "status": 400
}

إصدار API غير معتمد

يحدث هذا الخطأ عندما لا يتطابق إصدار API المطلوب من العميل مع أي من إصدارات واجهة برمجة التطبيقات المدعومة من قبل الخادم.

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=utf-8
{
  "type": "https://azconfig.io/errors/invalid-argument",
  "title": "Unsupported API version",
  "name": "api-version",
  "detail": "The HTTP resource that matches the request URI '{request uri}' does not support the API version '{api-version}'.",
  "status": 400
}

إصدار API غير صالح

يحدث هذا الخطأ عندما يقوم عميل بإجراء طلب باستخدام إصدار API، ولكن القيمة مشوهة أو لا يمكن تحليلها بواسطة الخادم.

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=utf-8  
{
  "type": "https://azconfig.io/errors/invalid-argument",
  "title": "Invalid API version",
  "name": "api-version",
  "detail": "The HTTP resource that matches the request URI '{request uri}' does not support the API version '{api-version}'.",
  "status": 400
}

إصدار API غامض

يحدث هذا الخطأ عندما يطلب عميل إصدار API غامضًا للخادم (على سبيل المثال، قيم مختلفة متعددة).

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=utf-8
{
  "type": "https://azconfig.io/errors/invalid-argument",
  "title": "Ambiguous API version",
  "name": "api-version",
  "detail": "The following API versions were requested: {comma separated api versions}. At most, only a single API version may be specified. Please update the intended API version and retry the request.",
  "status": 400
}