버전이 지정된 Atlas 관리 API 개요
Atlas는 API 변경 사항을 처리할 때 예측 가능하고 일관적인 환경을 위해 버전이 지정된 Atlas 관리 API를 제공합니다. API 버전 관리는 개별 API 리소스 수준에서 이루어집니다. 따라서 Atlas가 사용 중인 리소스를 더 이상 사용하지 않는 경우 조치를 취해야 합니다. Atlas에서 새 버전을 릴리스한 리소스를 구현하지 않은 경우 아무런 조치를 취할 필요가 없습니다. 이를 통해 프로덕션 환경의 안정성을 유지하고 중단을 최소화하면서 새로운 기능을 계획하고, 호환성이 손상되는 변경을 방지하고, 원활한 통합 프로세스를 보장할 수 있습니다.
버전이 지정된 Atlas 관리 API의 이점
새로운 버전의 Atlas 관리 API는 프로그래밍 방식으로 Atlas에 액세스할 때 전반적인 환경이 크게 향상되었습니다. 버전이 지정된 Atlas 관리 API는 다음을 제공합니다.
호환성이 손상되는 변경과 호환성이 손상되지 않는 변경의 명확한 구분
Atlas는 새 리소스 버전에서 호환성이 손상되는 변경을 포함하여 완전히 새로운 기능을 소개합니다. 호환성이 손상되지 않는 변경이 포함된 기능은 현재의 안정적인 리소스 버전에 계속 추가됩니다. Atlas에서 새 리소스 버전을 도입하면 새 API 리소스 버전에서 개발하고 테스트하는 동안 완전히 사용되지 않을 때까지 현재의 안정적인 리소스 버전을 계속 사용할 수 있습니다.
지원 및 사용 중단 기간 연장
Atlas는 새로운 안정적인 API 리소스 버전을 도입하는 경우에만 리소스 버전을 사용하지 않습니다. Atlas는 프로덕션 환경에서 사용할 수 있도록 이전 리소스 버전을 최대 12개월 동안 계속 지원하여 다음 버전으로의 마이그레이션을 계획하고 실행할 수 있는 시간을 제공합니다.
버전 관리 스키마
버전이 지정된 새로운 Atlas 관리 API(v2)부터 Atlas 관리 API 버전은 Atlas 관리 API 리소스의 수명 주기를 기반으로 합니다.
버전이 지정된 Atlas 관리 API 수명 주기
버전이 지정된 Atlas 관리 API(v2)부터 Atlas 관리 API 엔드포인트는 수명 주기에서 stable, deprecated 및 sunset 단계를 Go합니다.
중요
이 단계는 버전이 지정된 리소스의 Atlas 관리 API(v2)에 있는 Atlas 관리 API 엔드포인트에만 적용됩니다. 이러한 단계는 v1.0 또는 v1.5 리소스의 Atlas 관리 API 엔드포인트에 영향을 주지 않습니다. Atlas는 2023-02-01에 첫 번째 릴리스에서 모든 레거시(v1.0 및 v1.5) Atlas 관리 API 리소스를 stable 상태로 노출합니다.
stableAtlas 는 프로덕션 환경에서 사용할 수 있는 안정적인 엔드포인트를 지원합니다. Atlas 는 모든 안정적인 엔드포인트에 대한 변경 로그 가 포함된 문서를 제공합니다. 이 상태 의 리소스 버전은 호환성이 손상되지 않는 변경 사항으로만 업데이트됩니다.
Atlas는 엔드포인트에 호환성이 손상되는 변경을 도입하면 새 리소스 버전을 생성합니다. 새 리소스 버전이 출시되면 Atlas는 해당 리소스의 현재 안정적인 버전도 자동으로 사용하지 않습니다. Atlas는
2023-02-01의 첫 번째 릴리스에서 모든 레거시(v1.0 및 v1.5) Atlas 관리 API 리소스를 안정적인 상태로 노출합니다. Atlas는 지원 중단 후 24개월 동안 버전이 지정된 Atlas 관리 API의 첫 번째 릴리스(2023-01-01 및 2023-02-01)를 지원합니다./clusters리소스 버전 2023-01-01 (및 이에 상응하는/v1.0/clusters리소스)은 2년의 사용 중단 기간을 가지며 사용 중단된 것으로 표시됩니다.이 상태에서 Atlas 관리 API를 사용하려면 리소스에 요청을 보내고 다음을 HTTP 수락 헤더로 포함하십시오.
Accept: application/vnd.atlas.<yyyy-mm-dd>+json 여기서
<yyyy-mm-dd>값은 문서 및 변경 로그에 나열된 엔드포인트의 릴리스 날짜입니다.Atlas가 406 허용 불가 를 반환합니다. 요청에서 헤더에 존재하지 않는 리소스 버전을 생략하거나 지정하는 경우 오류 응답 코드입니다.
deprecatedAtlas는 새롭고 안정적인 리소스 버전을 도입할 때 리소스 버전을 자동으로 사용하지 않습니다. Atlas는 기존 리소스에 호환성이 손상되는 변경이 도입될 때 새롭고 안정적인 버전을 릴리스합니다.
Atlas는 요청에 대한 응답 헤더에서 더 이상 사용되지 않는 리소스 버전에 대해 알립니다. Atlas는 지원 중단 후 24개월 동안 Atlas Administration API의 첫 번째 릴리스(2023-01-01 및 2023-02-01)를 지원합니다. 이후 Atlas는 더 이상 사용되지 않는 리소스 버전을 자동으로 제거하기 전에 12개월 동안 프로덕션 환경에서 사용할 수 있도록 지원합니다.
예시
다음은 향후 제거될 예정인 사용 중단된 리소스에 대한 요청에 대한 응답 헤더의 예시입니다.
Deprecation: Wed, 1 Feb 2023 00:00:00 GMT Sunset: Sun, 1 Jun 2025 00:00:00 GMT 엔드포인트의 이전 리소스 버전이 제거될 때까지 해당 리소스 버전으로 계속 요청을 보낼 수 있습니다. 그러나 이전 리소스 버전이 제거될 때 중단을 완화하려면 가능한 한 빨리 최신 리소스 버전으로 마이그레이션해야 합니다. 새 리소스 버전으로 마이그레이션하는 방법에 대해 자세히 알아보려면 새 버전이 지정된 Atlas 관리 API로 마이그레이션을 참조하세요.
sunsetAtlas는 1년 간의 지원 중단 이후 리소스 버전을 자동으로 제거합니다. 제거된 리소스 버전에 요청을 보내면 Atlas는 Gone 을 반환합니다.410 오류 응답 코드.
예시
다음 예는 리소스의 수명 주기와 리소스가 버전 관리에 미치는 영향을 보여줍니다.
앞의 그림은 다음을 보여줍니다.
출시일 | 릴리스 세부 정보 | API 라이프사이클 |
2023-06-01 | 버전이 지정된 API의 첫 번째 리소스 릴리스입니다. 사용 중단 기간은 12개월입니다. |
|
2024-06-01 | 새 리소스 버전이 생성되었으며, 이전 버전은 자동으로 더 이상 사용되지 않습니다. |
|
2025-01-01 | 짧은 선셋이 포함된 새로운 스테이블 버전이 생성되었습니다. |
|
API 엔드포인트
버전이 없는 레거시 Atlas 관리 API 엔드포인트의 경우, Atlas는 동일한 버전에 새로운 변경과 호환성이 손상되는 변경을 도입했습니다. 버전이 지정된 Atlas 관리 API(v2)부터 Atlas는 새로운 버전에서만 호환성이 손상되는 변경을 도입합니다. Atlas는 기존 stable 버전에 호환성이 손상되지 않는 변경을 계속 도입할 예정입니다. 리소스의 릴리스 날짜를 사용하여 버전이 지정된 Atlas 관리 API(v2) 엔드포인트의 특정 버전에 요청을 제출합니다.
다음 표에는 레거시 API 엔드포인트 버전, 버전에 해당 버전이 지정된 Atlas 관리 API(v2) 엔드포인트가 있는지 여부, 버전이 지정된 Atlas 관리 API(v2) 리소스의 릴리스 날짜가 나와 있습니다. 버전이 없는 Atlas 관리 API에서 v1.0에 해당하는 버전은 현재 더 이상 사용되지 않는 버전이 있는 Atlas 관리 API에서 2023-01-01 로 표시됩니다.
버전 번호 | v2에서 지원되나요? | v2 리소스 버전( yyyy-mm-dd 형식) |
|---|---|---|
v1.0 | √ | 2023-01-01 |
v1.5 | √ | 2023-02-01 |
다음 단계
다양한 버전의 모든 API 변경 사항을 확인할 수 있는 API 변경 로그 를 검토합니다.
모든 안정적인 리소스 버전과 더 이상 사용되지 않는 리소스 버전에 대한 정보가 포함된 API 사양 을 검토하세요.
마이그레이션 가이드 의 단계에 따라 현재 버전이 없는 Atlas 관리 API에서 버전이 지정된 새 Atlas 관리 API로 마이그레이션합니다.