Versionshantering

Varje klientbegäran måste tillhandahålla en explicit API-version som en frågesträngsparameter. Exempel: https://{myconfig}.azconfig.io/kv?api-version=1.0.

api-version uttrycks i SemVer-format (major.minor). Intervall- eller versionsförhandling stöds inte.

Den här artikeln gäller FÖR API version 1.0.

Följande beskriver en sammanfattning av möjliga felsvar som returneras av servern när den begärda API-versionen inte kan matchas.

API-version ospecificerad

Det här felet uppstår när en klient gör en begäran utan att ange en API-version.

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-version som inte stöds

Det här felet uppstår när en klient begärd API-version inte matchar någon av de API-versioner som stöds av servern.

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
}

Ogiltig API-version

Det här felet uppstår när en klient gör en begäran med en API-version, men värdet är felaktigt eller inte kan parsas av servern.

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
}

Tvetydig API-version

Det här felet uppstår när en klient begär en API-version som är tvetydig till servern (till exempel flera olika värden).

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
}