버전 관리

각 클라이언트 요청은 명시적인 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
}