지정된 클러스터의 샤드에 걸쳐 하나의 컬렉션을 얼마나 효율적으로 분산시킬 수 있는지 분석합니다.
Atlas API 하위 명령은 MongoDB Atlas 관리자 API 에서 자동으로 생성되며 관리자 API 에 대한 전체 커버리지를 제공합니다. 관리자 API 역량에는 자체 출시 수명 주기가 있으며, 이는 제공된 API 엔드포인트 문서 링크를 통해 확인할 수 있습니다.
This endpoint accepts the request and returns immediately: the Location header carries the URI of the operation that tracks the analysis. Poll that operation until its status is terminal, then follow its resultHref to read the analysis. MongoDB Cloud validates and authorizes the request before accepting it, so a rejected submission returns a 4xx status and never an operation in a failed state. A namespace that is well formed but absent cannot be detected before the analysis runs and surfaces as a failed operation.
이 명령은 자동으로 생성되며 Atlas API 엔드포인트 https://www.mongodb.com/ko-kr/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupclustershardkeyanalysis.와 1:1 에 해당합니다.
자세한 내용과 예시는 위에 링크된 참조 API 문서를 참조하세요.
구문
명령 구문
atlas api shardKeyAnalyzer createShardKeyAnalysis [options]옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
--clusterName | 문자열 | true | 분석할 컬렉션이 포함된 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다. |
--envelope | envelope | 거짓 | 애플리케이션이 응답을 엔벨로프 JSON 객체 로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스 할 수 없습니다. 이 문제를 해결하려면 쿼리 에서 envelope=true 를 설정하다 . 결과 목록을 반환하는 엔드포인트는 결과 객체 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다. |
--file | 문자열 | 거짓 | API 요청 파일 의 경로입니다. 표준 입력을 대신 사용하려면 비워 두세요 - 둘 중 하나를 제공해야 하지만 둘 다 제공할 수는 없습니다. |
--groupId | 문자열 | true | 프로젝트 식별하는 고유한 24-16진수 문자열입니다. [/groups](# 태그를 지정하다 /Projects/operation/listProjects) 엔드포인트를 사용하여 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 . 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다. |
-h, --help | 거짓 | createShardKeyAnalysis에 대한 도움말 | |
-o, --output | 문자열 | 거짓 | 기본 설정 API 형식은 ["JSON", go- Template] 일 수 있습니다. 이 값의 기본값은 "JSON" 입니다. |
--outputFile | 문자열 | 거짓 | API 출력을 쓰기 (write) 파일 입니다. 이 플래그는 엔드포인트의 출력이 바이너리(예: gzip)이고 명령이 파이프되지 않은 경우(예: Atlas 명령 > out.zip)에 필요합니다. |
--pretty | 거짓 | 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. | |
--version | 문자열 | 거짓 | Atlas API 엔드포인트 [options: "2025-03-12"]를 호출할 때 사용할 API 버전입니다. 사용자가 설정하다 하지 않은 경우 기본값은 최신 버전이거나 설정하다 경우 프로필의 api_version 구성 값입니다. 이 값의 기본값은 '2025-03-12'입니다. |
상속된 옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
-P, --profile | 문자열 | 거짓 | 구성 파일 에서 사용할 프로필의 이름입니다. Atlas CLI 의 프로필에 대해 학습 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings를 참조하세요. |