Atlas cluster 검색 인덱스 설명
클러스터의 검색 인덱스에 대한 세부 정보를 반환합니다.
이 명령을 사용하려면 프로젝트 데이터 액세스 읽기/쓰기 역할이 있는 API 키로 또는 사용자 계정으로 인증해야 합니다.
구문
명령 구문
atlas clusters search indexes describe <indexId> [options]
arguments
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
indexId | 문자열 | true | 인덱스의 ID입니다. |
옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
--clusterName | 문자열 | true | 클러스터의 이름입니다. 자세한 내용은 https://dochub.mongodb.org/core/create-cluster-api를 참조하세요. |
-h, --help | 거짓 | 설명 도움말 | |
-o, --output | 문자열 | 거짓 | 출력 형식입니다. 유효한 값은 json, json-path, go-템플릿 또는 go-템플릿 파일입니다. 전체 출력을 보려면 -o json 옵션을 사용합니다. |
--projectId | 문자열 | 거짓 | 사용할 프로젝트를 식별하는 16진수 문자열입니다. 이 옵션은 구성 파일 또는 환경 변수의 설정을 재정의합니다. |
상속된 옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
-P, --profile | 문자열 | 거짓 | 구성 파일에서 사용할 프로필의 이름입니다. Atlas CLI의 프로필에 대해 자세히 알아보려면 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings를 참조하세요. |
출력
명령이 성공하면 Atlas CLI는 다음 샘플과 유사한 출력을 반환합니다. 괄호 안의 값은 사용자의 값을 나타냅니다.
ID NAME DATABASE COLLECTION TYPE <IndexID> <Name> <Database> <CollectionName> <Type>
예시
# Return the JSON-formatted details for the search index with the ID 5f1f40842f2ac35f49190c20 for the cluster named myCluster: atlas clusters search indexes describe 5f1f40842f2ac35f49190c20 --clusterName myCluster --output json