공개 미리 보기: <https:// 피드백 .mongodb.com/forums/930808-atlas-cli>:에서 피드백 보내주세요. ' Atlas API <tag> <operationId> ' 구문과 함께 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 확인하세요. 예시 들어 |
<operationId> | 문자열 | true | camelCase에 있는 Atlas 관리 API 엔드포인트의 식별자입니다. operationId를 찾으려면 엔드포인트에 대한 API 설명서 URL 확인하세요. 예시 를 들어 |
하위 명령 옵션
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 엔드포인트에 대해 다음 옵션을 사용할 수 있습니다.
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
| 문자열 | 거짓 | 명령에 대한 Atlas 관리 API 의 버전을 지정합니다. 기본값은 최신 API 버전 또는 프로필의 |
| 문자열 | 거짓 | 출력 형식입니다. 기본값 은
엔드포인트에 지원되는 형식을 확인하려면 다음을 수행합니다.
|
| 문자열 | 거짓 | 출력을 저장할 파일 경로입니다. 기본값 으로 결과는 터미널에 표시됩니다. |
| 문자열 | 거짓 | 작업에 필요한 경우 요청 본문 콘텐츠의 파일 경로입니다. 또는 표준 입력( |
| 부울 | 거짓 | 현재 명령에 대한 도움말입니다. |
옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
-h, --help | 거짓 | API 도움말 |
상속된 옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
-P, --profile | 문자열 | 거짓 | 구성 파일 에서 사용할 프로필의 이름입니다. Atlas CLI 의 프로필에 대해 학습 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings를 참조하세요. |
관련 명령
Atlas API accessTracking - Public Preview: 다음에서 피드백 제공하세요.: Atlas 데이터베이스 배포에 대한 인증 시도에 대한 액세스 로그를 반환합니다.
Atlas API alertConfigurations - Public Preview: 다음에서 피드백 제공해 주세요. 경고를 트리거하다 조건과 MongoDB Cloud가 사용자에게 알림을 보내는 방법을 반환하고 편집합니다.
Atlas API 경고 - 공개 미리 보기: 다음에서 피드백 제공하세요. 정의한 경고 조건에 따라 MongoDB Cloud가 트리거하는 경고를 반환하고 확인합니다.
Atlas API atlasSearch - 공개 미리 보기: 다음에서 피드백 제공하세요. 지정된 클러스터 에 대한 Atlas Search 인덱스를 반환, 추가, 편집 및 제거합니다.
Atlas API 감사 - 공개 미리 피드백: MongoDB Cloud 프로젝트에 대한 데이터베이스 감사 설정을 반환하고 편집합니다.
Atlas API awsClustersDns - Public Preview: 데이터베이스 에서 피드백 Amazon Web Services 주세요 .
Atlas API cloudBackups - Public Preview: Cloud Backup 스냅샷, 스냅샷 내보내기 버킷, 복원 작업 및 일정을 피드백 합니다.
Atlas API cloudMigrationService - Public Preview: 다음에서 피드백 제공해 주세요. Manages 클라우드 마이그레이션 Service.
Atlas API cloudProviderAccess - 공개 미리 보기: Atlas 에서 Amazon Web Services IAM 역할 반환, 추가, 권한 부여 및 제거에서 피드백 제공하세요.
Atlas API clusterOutageSimulation - 공개 미리 보기: 다음에서 피드백 제공하세요. 클러스터 중단 시뮬레이션을 반환, 시작 또는 종료합니다.
Atlas API cluster - Public Preview: 데이터베이스 배포 반환, 추가, 편집 및 제거에서 피드백 제공하세요.
Atlas API collectionLevelMetrics - Public Preview: 다음에서 피드백 제공하세요. 지정된 클러스터 또는 프로세스 에 대해 고정된 네임스페이스를 반환, 추가 및 편집합니다.
Atlas API customDatabaseRoles - Public Preview: 다음에서 피드백 제공해 주세요. 사용자 지정 데이터베이스 사용자 권한 역할을 반환, 추가, 편집 및 제거합니다.
Atlas API dataFederation - Public Preview: 다음에서 피드백 제공해 주세요: 연합 데이터베이스 인스턴스 반환, 추가, 편집 및 제거.
Atlas API dataLakePipelines - 공개 미리 보기: Atlas Data Lake 파이프라인 및 관련 실행 피드백 반환, 편집 및 제거합니다.
Atlas API databaseUsers - 공개 미리 보기: 데이터베이스 사용자 반환, 추가, 편집 및 제거에서 피드백 제공하세요.
Atlas API encryptionAtRestUsingCustomerKeyManagement - 공개 미리 보기: 다음에서 피드백 제공하세요. 고객 키 관리 구성을 사용하여 미사용 데이터 암호화를 반환하고 편집합니다.
Atlas API 이벤트 - 공개 미리 보기: 다음에서 피드백 제공하세요. 반환 이벤트.
Atlas API federatedAuthentication - Public Preview: 다음에서 피드백 제공하세요. 역할 매핑 및 연결된 조직 구성과 같은 페더레이션 관련 기능을 반환, 추가, 편집 및 제거합니다.
Atlas API flexRestoreJobs - Public Preview: 다음에서 피드백 제공해 주세요. Flex 데이터베이스 배포를 위한 복원 작업을 반환하고 추가합니다.
Atlas API flexSnapshots - Public Preview: 다음에서 피드백 제공하세요. 반환 및 Flex 데이터베이스 배포 스냅샷 다운로드 요청.
Atlas API globalClusters - Public Preview: 다음에서 피드백 제공해 주세요. Global Cluster(글로벌 클러스터) managed 형 네임스페이스 및 사용자 지정 구역 매핑을 반환, 추가 및 제거합니다.
Atlas API ldapConfiguration - 공개 미리 보기: 다음에서 피드백 제공하세요. LDAP 구성 반환, 편집, 확인 및 제거.
Atlas API legacyBackup - Public Preview: 다음에서 피드백 제공해 주세요. 레거시 백업 스냅샷, 복원 작업, 일정 및 체크포인트를 관리합니다.
Atlas API maintenanceWindows - Public Preview: Windows 에서 피드백 제공해 주세요.
Atlas API mongoDbCloudUsers - 공개 미리 보기: MongoDB Cloud 사용자 반환, 추가 및 편집에서 피드백 제공하세요.
Atlas API monitoringAndLogs - Public Preview: 다음에서 피드백 제공해 주세요. 데이터베이스 배포 모니터링 및 로깅 데이터를 반환합니다.
Atlas API networkPeering - Public Preview: 다음에서 피드백 제공해 주세요. 네트워크 피어링 컨테이너 및 피어링 연결을 반환, 추가, 편집 및 제거합니다.
Atlas API onlineArchive - Public Preview: 온라인 피드백 반환, 추가, 편집 또는 제거합니다.
Atlas API 조직 - 공개 미리 보기: MongoDB Cloud의 조직 단위 반환, 추가 및 편집에서 피드백 제공하세요.
Atlas API performanceAdvisor - Public Preview: 다음에서 피드백 제공하세요. 데이터베이스 배포 위한 추천 인덱스 및 느린 쿼리 데이터를 반환합니다.
Atlas API privateEndpointServices - Public Preview: 다음에서 피드백 제공하세요. 비공개 엔드포인트 서비스를 반환, 추가, 편집 및 제거합니다.
Atlas API 프로그래밍 API 키 - 공개 미리 보기: MongoDB Cloud API 사용하기 위한 액세스 토큰 반환, 추가, 편집 및 제거에서 피드백 제공하세요.
Atlas API projectIpAccessList - Public Preview: 다음에서 피드백 제공해 주세요. Atlas 의 데이터베이스 배포에 대한 네트워크 액세스 제한을 반환, 추가, 편집 및 제거합니다.
Atlas API 프로젝트 - 공개 미리 보기: MongoDB Cloud의 클러스터 및 사용자 컬렉션 반환, 추가 및 편집에서 피드백 제공하세요.
Atlas API pushBasedLogExport - Public Preview: 다음에서 피드백 제공해 주세요. mongod, mongos 및 감사 로그의 로그를 Amazon Web Services S3 버킷으로 지속적으로 푸시할 수 있습니다.
Atlas API 리소스 정책 - 공개 미리 보기: 다음에서 피드백 제공하세요. 조직 내에서 Atlas 리소스 정책 구성 및 관리 .
Atlas API 롤링 인덱스 - 공개 미리 보기: 다음에서 피드백 제공해 주세요. 롤링 방식으로 데이터베이스 배포 에 인덱스 하나를 생성합니다.
Atlas API 루트 - 공개 미리 보기: 다음에서 피드백 제공해 주세요. MongoDB Cloud 빌드 와 이 리소스 요청하는 액세스 토큰을 설명하는 세부 정보를 반환합니다.
Atlas API 서비스 계정 - 공개 미리 보기: 서비스 계정 및 비밀 관리를 위한 엔드포인트에서 피드백 제공하세요.
Atlas API SharedTierRestoreJobs - Public Preview: 다음에서 피드백 제공하세요. 공유 계층 데이터베이스 배포를 위한 복원 작업을 반환하고 추가합니다.
Atlas API SharedTierSnapshots - Public Preview: 다음에서 피드백 제공하세요. 반환 및 공유 계층 데이터베이스 배포 스냅샷 다운로드 요청.
Atlas API 스트림 - 공개 미리 보기: 스트림 인스턴스 반환, 추가, 편집 및 제거에서 피드백 제공하세요.
Atlas API 팀 - 공개 미리 보기: 팀 반환, 추가, 편집 또는 제거에서 피드백 제공하세요.
Atlas API ThirdPartyIntegrations - Public Preview: 다음에서 피드백 제공해 주세요. 타사 서비스 통합 구성을 반환, 추가, 편집 및 제거합니다.
Atlas API x509Authentication - Public Preview: 다음에서 피드백 제공해 주세요. 사용자 관리형 X.509 구성 반환, 편집 및 제거.