Bagikan melalui

Penerapan versi

  • Artikel

Setiap permintaan klien harus menyediakan versi API eksplisit sebagai parameter string kueri. Misalnya: https://{myconfig}.azconfig.io/kv?api-version=1.0.

api-version dinyatakan dalam format SemVer (mayor.minor). Rentang atau negosiasi versi tidak didukung.

Artikel ini berlaku untuk API versi 1.0.

Berikut adalah ringkasan kemungkinan respons kesalahan yang dikembalikan oleh server saat versi API yang diminta tidak dapat dicocokkan.

Versi API tidak ditentukan

Kesalahan ini terjadi ketika klien membuat permintaan tanpa memberikan versi API.

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
}

Versi API tidak didukung

Kesalahan ini terjadi ketika versi API yang diminta klien tidak cocok dengan salah satu versi API yang didukung oleh server.

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
}

Versi API tidak valid

Kesalahan ini terjadi ketika klien membuat permintaan dengan versi API, tetapi nilainya salah atau tidak dapat diuraikan oleh server.

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
}

Versi API ambigu

Kesalahan ini terjadi saat klien meminta versi API yang ambigu ke server (misalnya, beberapa nilainya berbeda).

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
}