Sdílet prostřednictvím

Správa verzí

  • Článek

Každý požadavek klienta musí jako parametr řetězce dotazu poskytovat explicitní verzi rozhraní API. Příklad: https://{myconfig}.azconfig.io/kv?api-version=1.0.

api-version je vyjádřeno ve formátu SemVer (major.minor). Vyjednávání rozsahu nebo verze se nepodporuje.

Tento článek se týká rozhraní API verze 1.0.

Následující část obsahuje souhrn možných chybových odpovědí vrácených serverem v případě, že se požadovaná verze rozhraní API nedá shodovat.

Nespecifikovaná verze rozhraní API

K této chybě dochází, když klient odešle požadavek bez zadání verze rozhraní 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
}

Nepodporovaná verze rozhraní API

K této chybě dochází v případě, že klient požadoval verzi rozhraní API, která neodpovídá žádné z podporovaných verzí rozhraní API serverem.

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
}

Neplatná verze rozhraní API

K této chybě dochází, když klient odešle požadavek s verzí rozhraní API, ale hodnota je poškozená nebo ji server nemůže analyzovat.

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
}

Nejednoznačná verze rozhraní API

K této chybě dochází, když klient požádá o verzi rozhraní API, která je pro server nejednoznačná (například několik různých hodnot).

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
}