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

  • مقالة
  • قراءة خلال 2 دقائق

يجب أن يوفر كل طلب عميل إصدار واجهة برمجة تطبيقات صريح كمعلمة سلسلة استعلام. على سبيل المثال: 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
}

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

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

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
}

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

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

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
}

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

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

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
}