Compartir vía

Control de versiones

  • Artículo

Cada solicitud de cliente debe proporcionar la versión de API explícita como parámetro de cadena de la consulta. Por ejemplo: https://{myconfig}.azconfig.io/kv?api-version=1.0.

api-version se expresa con el formato SemVer (principal.secundaria). No se admite la negociación del rango ni de la versión.

Este artículo se aplica a la API versión 1.0.

A continuación se incluye un resumen de las posibles respuestas de error que devuelve el servidor cuando no se puede encontrar una coincidencia con la versión de API solicitada.

Versión de API sin especificar

Este error aparece cuando un cliente realiza una solicitud sin proporcionar una versión de la 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ón de API no admitida

Este error aparece cuando una versión de API solicitada por el cliente no coincide con ninguna de las versiones de API admitidas por el servidor.

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ón de API no válida

Este error aparece cuando un cliente realiza una solicitud con una versión de API, pero el valor tiene un formato incorrecto o no se puede analizar en el servidor.

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ón de API ambigua

Este error aparece cuando un cliente solicita una versión de API que es ambigua para el servidor (por ejemplo, varios valores diferentes).

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
}