atlas api

Atlas CLI 통해 'atlas api <tag> <operationId>' 명령을 사용하여 Atlas 관리 API 의 모든 기능에 액세스합니다.

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

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

Atlas API 하위 명령은 MongoDB Atlas 관리자 API 에서 자동으로 생성되며 관리자 API 에 대한 전체 커버리지를 제공합니다. 관리자 API 역량에는 자체 출시 수명 주기가 있으며, 이는 제공된 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/api/doc/atlas-admin-api-v2/operation/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` 옵션이 필요합니다. 엔드포인트에 지원되는 형식을 확인하려면 다음을 수행합니다. API 문서( https://www.mongodb.com/ko-kr/docs/atlas/reference/api-resources-spec/v2/)에서 콘텐츠 응답 유형 예시를 확인하세요. 자세한 내용을 보려면 `atlas api <tag> <operationId> --help` 를 실행하세요.
`-o, --out-file`	문자열	거짓	출력을 저장할 파일 경로입니다. 기본값 으로 결과는 터미널에 표시됩니다.
`--file`	문자열	거짓	작업에 필요한 경우 요청 본문 콘텐츠의 파일 경로입니다. 또는 표준 입력(`stdin`)을 통해 입력을 제공합니다.
`-h, --help`	부울	거짓	현재 명령에 대한 도움말입니다.

옵션

이름	유형	필수 사항	설명
-h, --help		거짓	API 도움말

상속된 옵션

이름	유형	필수 사항	설명
-P, --profile	문자열	거짓	구성 파일 에서 사용할 프로필의 이름입니다. Atlas CLI 의 프로필에 대해 학습 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings를 참조하세요.

관련 명령

atlas api accessTracking - Atlas 데이터베이스 배포에 대한 인증 시도에 대한 액세스 로그를 반환합니다.
atlas api 활동 피드 -
atlas api aiModels - AI 모델에 대한 API 키 및 속도 제한을 반환, 추가, 편집 및 제거합니다.
atlas api alertConfigurations - 경고를 trigger하는 조건과 MongoDB 클라우드가 사용자에게 알림을 보내는 방법을 반환하고 편집합니다.
atlas api 경고 - 정의한 경고 조건에 따라 MongoDB 클라우드가 트리거하는 경고를 반환하고 승인합니다.
atlas api atlasSearch - 지정된 클러스터 에 대한 Atlas 검색 인덱스를 반환, 추가, 편집 및 제거합니다.
atlas api 감사 - MongoDB 클라우드 프로젝트에 대한 데이터베이스 감사 설정을 반환하고 편집합니다.
atlas api awsClustersDns - AWS의 MongoDB 클라우드 데이터베이스 배포를 위한 사용자 지정 DNS 구성을 반환하고 편집합니다.
atlas api 클라우드 백업 - 클라우드 백업 스냅샷, 스냅샷 내보내기 버킷, 복원 작업 및 예정 관리합니다.
atlas api cloudMigrationService - 클라우드 마이그레이션 서비스를 관리합니다.
atlas api cloudProviderAccess - Atlas 에서 AWS IAM 역할을 반환, 추가, 권한 부여 및 제거합니다.
atlas api clusterOutageSimulation - 클러스터 장애 시뮬레이션을 반환, 시작 또는 종료합니다.
atlas api 클러스터 - 데이터베이스 배포를 반환, 추가, 편집 및 제거합니다.
atlas api collectionLevelMetrics - 지정된 클러스터 또는 프로세스에 대해 고정된 네임스페이스를 반환, 추가 및 편집합니다.
atlas api customDatabaseRoles - 사용자 지정 데이터베이스 사용자 권한 역할을 반환, 추가, 편집 및 제거합니다.
atlas api dataFederation - 연합 데이터베이스 인스턴스를 반환, 추가, 편집 및 제거합니다.
atlas api 데이터베이스 사용자 - 반환, 추가, 편집 및 제거합니다.
atlas api encryptionAtRestUsingCustomerKeyManagement - 고객 키 관리 구성을 사용하여 미사용 데이터 암호화를 반환하고 편집합니다.
atlas api 이벤트 - 이벤트를 반환합니다.
atlas api federatedAuthentication - 역할 매핑 및 연결된 조직 구성과 같은 페더레이션 관련 기능을 반환, 추가, 편집 및 제거합니다.
atlas api flexClusters - flex cluster를 반환, 추가, 편집 및 제거합니다.
atlas api flexRestoreJobs - flex 데이터베이스 배포를 위한 복원 작업을 반환하고 추가합니다.
atlas api flexSnapshots - flex 데이터베이스 배포 스냅샷을 반환하고 다운로드 요청합니다.
atlas api 글로벌 클러스터 - 글로벌 클러스터 managed 네임스페이스 및 사용자 지정 구역 매핑을 반환, 추가 및 제거합니다.
Atlas API 청구서 - 청구서를 반환합니다.
atlas api ldapConfiguration - LDAP 구성을 반환, 편집, 확인 및 제거합니다.
atlas api 유지 관리 기간 - 유지 관리 기간을 반환, 편집 및 제거합니다.
atlas api mongoDbCloudUsers - MongoDB 클라우드 사용자를 반환, 추가 및 편집합니다.
atlas api monitoringAndLogs - 데이터베이스 배포 모니터링 및 로깅 데이터를 반환합니다.
atlas api networkPeering - 네트워크 피어링 컨테이너 및 피어링 연결을 반환, 추가, 편집 및 제거합니다.
atlas api onlineArchive - 온라인 아카이브를 반환, 추가, 편집 또는 제거합니다.
atlas api 조직 - MongoDB 클라우드에서 조직 단위를 반환, 추가 및 편집합니다.
atlas api performanceAdvisor - 데이터베이스 배포 위한 추천 인덱스와 느린 쿼리 데이터를 반환합니다.
atlas api privateEndpointServices - 비공개 엔드포인트 서비스를 반환, 추가, 편집 및 제거합니다.
atlas api programmaticApiKeys - MongoDB 클라우드 API 사용하기 위한 액세스 토큰을 반환, 추가, 편집 및 제거합니다.
Atlas api projectIpAccessList - Atlas 에서 데이터베이스 배포에 대한 네트워크 액세스 제한을 반환, 추가, 편집 및 제거합니다.
atlas api 프로젝트 - MongoDB 클라우드에서 클러스터 및 사용자 컬렉션을 반환, 추가 및 편집합니다.
atlas api pushBasedLogExport - mongod, mongos 및 감사 로그를 AWS S3 버킷으로 지속적으로 내보낼 수 있습니다.
Atlas API queryShapeInsights -
atlas api ResourcePolicies - 조직 내에서 Atlas 리소스 정책을 구성하고 관리 .
atlas api rollingIndex - 롤링 방식으로 데이터베이스 배포에 인덱스 하나를 생성합니다.
atlas api root - MongoDB Cloud 빌드 와 이 리소스 요청하는 액세스 토큰을 설명하는 세부 정보를 반환합니다.
atlas api serviceAccounts - 서비스 계정 및 시크릿을 관리하기 위한 엔드포인트입니다.
atlas api streams - Streams 작업 공간을 반환, 추가, 편집 및 제거합니다.
atlas api 팀 - 팀을 반환, 추가, 편집 또는 제거합니다.
atlas api ThirdPartyIntegrations - 타사 서비스 통합 구성을 반환, 추가, 편집 및 제거합니다.
atlas api x509Authentication - 사용자 관리형 X.509 구성을 반환, 편집 및 제거합니다.

돌아가기

초대

액세스 추적