Grid Management API 버전 관리
Grid Management API는 버전 관리를 사용하여 무중단 업그레이드를 지원합니다.
예를 들어 이 요청 URL은 API의 버전 3을 지정합니다.
"https://hostname_or_ip_address/api/v3/authorize`
테넌트 관리 API의 주요 버전은 이전 버전과 * _호환되지 않는 _ * 변경 사항이 있을 때 충돌합니다. 테넌트 관리 API의 부 버전은 * _ 이(가) 이전 버전과 호환된다는 변경 사항이 있을 때 충돌합니다. 호환 가능한 변경 사항에는 새 끝점 또는 새 속성 추가가 포함됩니다. 다음 예제에서는 변경 유형에 따라 API 버전을 충돌하는 방법을 보여 줍니다.
API 변경 유형입니다 | 이전 버전 | 새 버전 |
---|---|---|
이전 버전과 호환 가능합니다 |
2.1 |
2.2 |
이전 버전과 호환되지 않습니다 |
2.1 |
3.0 |
StorageGRID 소프트웨어를 처음 설치하는 경우 가장 최신 버전의 그리드 관리 API만 활성화됩니다. 그러나 StorageGRID의 새 기능 릴리즈로 업그레이드하면 하나 이상의 StorageGRID 기능 릴리즈에 대한 이전 API 버전에 계속 액세스할 수 있습니다.
Grid Management API를 사용하여 지원되는 버전을 구성할 수 있습니다. 자세한 내용은 Swagger API 설명서의 ""구성"" 섹션을 참조하십시오. 최신 버전을 사용하도록 모든 Grid Management API 클라이언트를 업데이트한 후에는 이전 버전에 대한 지원을 비활성화해야 합니다. |
오래된 요청은 다음과 같은 방법으로 더 이상 사용되지 않는 것으로 표시됩니다.
-
응답 헤더가 "DEPRECATED:TRUE"입니다.
-
JSON 응답 본문에는 "DEPRECATED"가 포함됩니다. TRUE
-
더 이상 사용되지 않는 경고가 NMS.log에 추가됩니다. 예를 들면 다음과 같습니다.
Received call to deprecated v1 API at POST "/api/v1/authorize"
현재 릴리즈에서 지원되는 API 버전을 확인합니다
다음 API 요청을 사용하여 지원되는 API 주요 버전 목록을 반환합니다.
GET https://{{IP-Address}}/api/versions { "responseTime": "2019-01-10T20:41:00.845Z", "status": "success", "apiVersion": "3.0", "data": [ 2, 3 ] }
요청에 대한 API 버전을 지정합니다
PATH 파라미터('/api/v3')나 header('api-Version:3')를 이용하여 API 버전을 지정할 수 있다. 두 값을 모두 제공하면 헤더 값이 경로 값을 재정의합니다.
curl https://[IP-Address]/api/v3/grid/accounts curl -H "Api-Version: 3" https://[IP-Address]/api/grid/accounts