StorageGRID Tenant Management API 버전 관리
테넌트 관리 API는 버전 관리를 사용하여 서비스 중단 없는 업그레이드를 지원합니다.
예를 들어, 이 요청 URL은 API 버전 4를 지정합니다.
https://hostname_or_ip_address/api/v4/authorize
API의 주 버전은 이전 버전과 호환되지 않는 변경 사항이 있을 때 업데이트됩니다. 반대로 API의 부 버전은 이전 버전과 호환되는 변경 사항이 있을 때 업데이트됩니다. 호환되는 변경 사항에는 새로운 엔드포인트 또는 새로운 속성 추가가 포함됩니다.
다음 예시는 변경 유형에 따라 API 버전이 어떻게 증가하는지 보여줍니다.
| API 변경 유형 | 이전 버전 | 새 버전 |
|---|---|---|
이전 버전과 호환됩니다 |
2.1 |
2.2 |
이전 버전과 호환되지 않습니다 |
2.1 |
3.0 |
StorageGRID 소프트웨어를 처음 설치할 때는 최신 버전의 API만 활성화됩니다. 하지만 StorageGRID의 새 기능 릴리스로 업그레이드할 때는 적어도 하나의 StorageGRID 기능 릴리스 동안 이전 버전의 API를 계속 사용할 수 있습니다.
|
|
지원되는 버전을 구성할 수 있습니다. "그리드 관리 API"에 대한 Swagger API 문서의 config 섹션을 참조하십시오. 모든 API 클라이언트를 최신 버전으로 업데이트한 후에는 이전 버전에 대한 지원을 비활성화해야 합니다. |
오래된 요청은 다음과 같은 방식으로 더 이상 사용되지 않는 것으로 표시됩니다.
-
응답 헤더는 "Deprecated: true"입니다.
-
JSON 응답 본문에 "deprecated": true가 포함되어 있습니다.
-
nms.log 파일에 더 이상 사용되지 않음을 알리는 경고 메시지가 추가됩니다. 예를 들면 다음과 같습니다.
Received call to deprecated v2 API at POST "/api/v2/authorize"
현재 릴리스에서 지원되는 API 버전 확인
지원되는 API 주요 버전 목록을 반환하려면 GET /versions API 요청을 사용하십시오. 이 요청은 Swagger API 문서의 config 섹션에 있습니다.
GET https://{{IP-Address}}/api/versions
{
"responseTime": "2023-06-27T22:13:50.750Z",
"status": "success",
"apiVersion": "4.0",
"data": [
2,
3,
4
]
}
요청에 사용할 API 버전 지정
API 버전은 경로 매개변수 (/api/v4) 또는 헤더 (Api-Version: 4)를 사용하여 지정할 수 있습니다. 두 값을 모두 제공하는 경우 헤더 값이 경로 값을 재정의합니다.
curl https://[IP-Address]/api/v4/grid/accounts curl -H "Api-Version: 4" https://[IP-Address]/api/grid/accounts