Atlas CLI Atlas CLI 에서 모든 Atlas 관리 API 엔드포인트에 직접 액세스 할 수 있는 api 하위 명령을 제공합니다. 이 기능 Atlas 관리 API 의 모든 역량 사용할 수 있는 강력하고 안정적인 방법입니다. 전체 Atlas 관리 API 에 대한 액세스 제공하므로 모든 작업 스크립트 하거나 자동화할 수 있으며 명령줄 인터페이스를 사용하면 얻을 수 있는 이점이 있습니다.
Atlas 관리 API 와의 전체 기능 패리티.
새로운 Atlas 관리 API 리소스 및 엔드포인트에 더 빠르게 액세스 .
자동화 위한 예측 가능한 통합 명령 구조입니다.
원하는 API 버전을 고정할 수 있어 CLI 업데이트 하더라도 스크립트를 안정적으로 유지할 수 있습니다.
작업이 완료될 때까지 명령을 감시할 수 있는 기능입니다.
이 튜토리얼에서는 Atlas CLI 명령에서 Atlas 관리 API 사용하는 방법을 보여 줍니다.
참고
API 하위 명령은 Atlas 관리 API 에서 자동으로 생성되며 전체 Atlas 관리 API (미리 보기 리소스 포함)에 대한 액세스 제공합니다. 이 Atlas CLI 기능 의 이점을 얻으려면 Atlas 관리 API 에 대해 어느 정도 익숙해야 하며 기본값 입력 및 출력이 API 미디어 유형의 직접 매핑이라는 점을 이해해야 합니다.
구문
Atlas 관리 API 와 함께 Atlas CLI 사용하려면 다음 형식으로 명령을 실행 .
atlas api <tag> <operationId> [options]|--file <fileName>.json --version <api-resource-version>
arguments
Argument | 필요성 | 설명 | ||
|---|---|---|---|---|
| 필수 사항 | API 리소스 에 대한 Atlas 관리 API 문서 URL 에 사용된 태그를 지정하다 의 이름입니다. 태그를 지정하다 는 Atlas 관리 API 문서 URL 에서 하이픈으로 구분됩니다. 그러나 Atlas CLI 명령 구문에서 카멜 케이스로 변환해야 합니다. 예시를 들어, Atlas 관리 API 리소스에 대한 다음 URL 가정해 보겠습니다. 앞의 URL 의 리소스 에 액세스하려면 명령 구문에서 더 많은 예시는예시를참조하세요. | ||
| 필수 사항 | API 엔드포인트에 대한 Atlas 관리 API 문서 URL 에 있는 작업의 식별자 입니다. 값은 카멜 케이스 형식입니다. 예시 Atlas 관리 API 엔드포인트 작업에 대한 다음 URL 가정해 보겠습니다. 앞의 URL의 엔드포인트에서 지원하는 작업을 수행하려면 명령에 표시된 대로 더 많은 예제는 예제를 참조하세요. |
옵션
명령을 사용하여 API 경로, 쿼리 및 요청 본문 매개변수를 옵션으로 전달할 수 있습니다. 명령을 사용하거나 JSON 파일 사용하여 옵션을 직접 지정할 수 있습니다. 이 명령은 다음 옵션도 지원합니다.
옵션 | 필요성 | 설명 |
|---|---|---|
| 조건부 | 작업에 대한 API 경로, 쿼리 및 요청 본문 매개변수가 포함된 JSON 파일입니다. 이는 명령으로 직접 지정하지 않은 작업에 필요한 경로, 쿼리 또는 요청 본문 매개변수가 있는 경우에만 필요합니다. |
| 옵션 | 사용할 API 리소스 버전입니다. 스크립트를 특정 API 버전에 고정하는 데 사용하는 것이 좋습니다. 생략하면 명령은 기본적으로 최신 버전(또는 프로필에 구성된 버전)을 사용합니다. 그러나 스크립트가 안정적으로 유지되도록 버전을 명시적으로 설정하는 것이 좋습니다. 이렇게 하면 호환되지 않을 수 있는 변경 사항이 포함된 새 API 버전이 릴리스될 때 스크립트가 손상되는 것을 방지할 수 있습니다. |
| 옵션 | 작업이 완료될 때까지 감시할지 여부를 지정하는 플래그입니다. |
예시
Atlas 관리 API 사용하는 다음 Atlas CLI 명령은 지정된 프로젝트 의 지정된 호스팅하다 에 대한 로그 메시지 범위 포함된 압축(.gz) 로그 파일 조회 방법을 보여 줍니다.
atlas api monitoringAndLogs getHostLogs --groupId 5e2211c17a3e5a48f5497de3 --hostName mycluster-shard-00-02.7hgjn.mongodb.net --logName mongodb --output gzip --version 2025-03-12
Atlas 관리 API 사용하는 다음 Atlas CLI 명령은 --file 옵션을 사용하여 클러스터 만드는 방법을 보여 줍니다.
atlas api clusters createCluster --groupId 5e2211c17a3e5a48f5497de3 --file cluster-config.json --version 2025-03-12
클러스터의 구성 파일 만드는 방법에 대해 자세히 학습하려면 클러스터 구성 파일을 참조하세요.
Atlas 관리 API 사용하는 다음 Atlas CLI 명령은 리전 cloud 제공자 중단을 시뮬레이션하는 방법을 보여줍니다. 이 시뮬레이션을 통해 프로덕션과 별도로 제어된 환경에서 애플리케이션의 페일오버 동작 및 재해 복구 절차를 테스트할 수 있습니다. 이 명령은 다음 설정이 포함된 outage_simulation.json 파일 사용합니다.
{ "outageFilters": [ { "cloudProvider": "AWS", "regionName": "US_EAST_1", "type": "REGION" } ] }
atlas api clusterOutageSimulation startOutageSimulation --groupId 5e2211c17a3e5a48f5497de3 --clusterName myCluster --file outage_simulation.json --version 2025-03-12
{"clusterName":"myCluster","groupId":"5e2211c17a3e5a48f5497de3","id":"6808ed9bed0b0b51caee336b","outageFilters":[{"cloudProvider":"AWS","regionName":"US_EAST_1","type":"REGION"}],"startRequestDate":"2025-04-23T13:39:39Z","state":"START_REQUESTED"}