Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas CLI
/
명령.

atlas api

이 페이지의 내용

실험적: 실험적:<tag> <operationId> ' Atlas API ' 구문으로 Atlas CLI 사용하여 Atlas 관리 API 의 모든 기능에 액세스합니다.

이 실험적 기능 Atlas CLI 사용하여 모든 Atlas 관리 API 엔드포인트와 직접 상호 작용 수 있도록 하여 스크립트 개발을 간소화합니다.

Atlas 관리 API 에 대한 자세한 내용은 https://www.mongodb.com/ko-kr/docs/atlas/reference/api-resources-spec/v2/ 를 참조하세요. - Atlas 관리 API 시작하기 : https://www.mongodb.com/ko-kr/docs/atlas/configure-api-access/#std-label-atlas-admin-api-access

이 실험적 기능 Atlas CLI 사용하여 모든 Atlas 관리 API 엔드포인트와 직접 상호 작용 수 있도록 하여 스크립트 개발을 간소화합니다.

구문

명령 구문
atlas api <tag> <operationId> [options]

중요

<tag> 및 <operationId> 는 모두 camelCase여야 합니다.

arguments

이름
유형
필수 사항
설명

<tag>

문자열

true

camelCase에서 Atlas 관리 API 작업의 범주입니다. 태그를 지정하다 찾아 형식을 지정하려면 엔드포인트의 API 문서 URL 확인하세요. #tag/ 이후에 표시되지만 camelCase로 변경해야 합니다. Atlas API 설명서는 https://www.mongodb.com/ko-kr/docs/atlas/reference/api-resources-spec/v2/를 참조하세요.

예시 들어 https://www.mongodb.com/ko-kr/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs에서 태그를 지정하다 Monitoring-and-Logs입니다. camelCase에서는 monitoringAndLogs입니다.

<operationId>

문자열

true

camelCase에 있는 Atlas 관리 API 엔드포인트의 식별자입니다. operationId를 찾으려면 엔드포인트에 대한 API 설명서 URL 확인하세요. operation/ 뒤에 표시됩니다. Atlas API 설명서는 https://www.mongodb.com/ko-kr/docs/atlas/reference/api-resources-spec/v2/를 참조하세요.

예시 를 들어 https://www.mongodb.com/ko-kr/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusters에서 operationId는 listClusters입니다.

하위 명령 옵션

Atlas 관리 API 엔드포인트에 대한 경로 및 쿼리 매개변수를 플래그로 전달합니다. 예시 들어 엔드포인트가 /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}인 경우 Atlas CLI 명령은 다음과 같습니다.

atlas api <tag> <operationId> --orgId <ORG_ID> --invoiceId <INVOICE_ID>

참고

--orgId 및 --projectId 는 프로필에서 가져오므로 일반적으로 지정할 필요가 없습니다. 프로필에 설정하다 있지 않은 경우에만 지정하세요.

엔드포인트에 해당하는 경우 --file 옵션 또는 표준 입력(stdin)을 사용하여 요청 본문을 전달합니다. 예시 를 들면 다음과 같습니다.

atlas api clusters create --file cluster-config.json

또한 모든 Atlas 관리 API 엔드포인트에 대해 다음 옵션을 사용할 수 있습니다.

이름
유형
필수 사항
설명

--api-version

문자열

거짓

명령에 대한 Atlas 관리 API 의 버전을 지정합니다. 기본값은 최신 API 버전 또는 프로필의 api_version 에 대해 구성한 값입니다.

--out

문자열

거짓

출력 형식입니다. 기본값 은 json이지만 지원되는 형식은 엔드포인트에 따라 다를 수 있습니다.

  • 대부분의 엔드포인트는 json을 출력합니다. json 이(가) 지원되는 경우 고 (Go) 템플릿을 사용할 수도 있습니다.

  • 일부 엔드포인트는 json 및 csv를 지원 json, csv 또는 고 (Go) 템플릿을 사용할 수 있습니다.

  • 특정 엔드포인트는 바이너리 데이터( 예시: gzip 형식의 로그)를 출력하므로 --out 옵션이 필요합니다.

엔드포인트에 지원되는 형식을 확인하려면 다음을 수행합니다.

-o, --out-file

문자열

거짓

출력을 저장할 파일 경로입니다. 기본값 으로 결과는 터미널에 표시됩니다.

--file

문자열

거짓

작업에 필요한 경우 요청 본문 콘텐츠의 파일 경로입니다. 또는 표준 입력(stdin)을 통해 입력을 제공합니다.

-h, --help

부울

거짓

현재 명령에 대한 도움말입니다.

옵션

이름
유형
필수 사항
설명

-h, --help

거짓

API 도움말

상속된 옵션

이름
유형
필수 사항
설명

-P, --profile

문자열

거짓

구성 파일에서 사용할 프로필의 이름입니다. Atlas CLI의 프로필에 대해 자세히 알아보려면 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings를 참조하세요.

관련 명령

돌아가기

승인 취소

다음

액세스 추적