Управление версиями

  • Статья

Каждый клиентский запрос должен предоставлять явную версию API в качестве параметра строки запроса. Например: https://{myconfig}.azconfig.io/kv?api-version=1.0.

api-version выражается в формате SemVer (major.minor). Согласование диапазона или версии не поддерживается.

Эта статья относится к API версии 1.0.

Ниже приведена сводка возможных сообщений об ошибках, возвращаемых сервером, если запрашиваемая версия API не может быть сопоставлена.

Версия API не указана

Эта ошибка возникает, когда клиент выполняет запрос без предоставления версии 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
}

Неподдерживаемая версия API

Эта ошибка возникает, когда запрошенная версия 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
}