atlas api atlasSearch listSearchIndex

지정된 컬렉션의 모든 Atlas Search 인덱스를 반환합니다.

Atlas API 하위 명령은 MongoDB Atlas 관리자 API 에서 자동으로 생성되며 관리자 API 에 대한 전체 커버리지를 제공합니다. 관리자 API 역량에는 자체 출시 수명 주기가 있으며, 이는 제공된 API 엔드포인트 문서 링크를 통해 확인할 수 있습니다.

Atlas Search 인덱스에는 인덱싱된 필드와 인덱스를 만드는 데 사용된 분석기가 포함되어 있습니다. 이 리소스를 사용하려면 요청 서비스 계정 또는 API 키에 프로젝트 데이터 액세스 읽기 쓰기 역할이 있어야 합니다.

이 명령은 자동으로 생성되었으며 1:1 과 Atlas API 엔드포인트 https://www.mongodb.com/ko-kr/docs/api/doc/atlas-admin-api-v2/작업/operation-listgroupclustersearchindex.에 해당합니다.

자세한 내용과 예시는 위에 링크된 참조 API 문서를 참조하세요.

구문

명령 구문

atlas api atlasSearch listSearchIndex [options]

옵션

이름	유형	필수 사항	설명
--clusterName	문자열	true	하나 이상의 Atlas Search 인덱스가 있는 컬렉션을 포함하는 클러스터의 이름입니다.
--collectionName	문자열	true	하나 이상의 Atlas Search 인덱스가 포함된 컬렉션의 이름입니다.
--databaseName	문자열	true	1개 이상의 Atlas Search 인덱스가 있는 컬렉션이 포함된 데이터베이스를 식별하는 레이블입니다.
--envelope	envelope	거짓	애플리케이션이 응답을 엔벨로프 JSON 객체 로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스 할 수 없습니다. 이 문제를 해결하려면 쿼리 에서 envelope=true 를 설정하다 . 결과 목록을 반환하는 엔드포인트는 결과 객체 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
--groupId	문자열	true	프로젝트 식별하는 고유한 24-16진수 문자열입니다. [/groups](# 태그를 지정하다 /Projects/operation/listProjects) 엔드포인트를 사용하여 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 . 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
-h, --help		거짓	listSearchIndex에 대한 도움말
-o, --output	문자열	거짓	기본 설정 API 형식은 ["JSON", go- Template] 일 수 있습니다. 이 값의 기본값은 "JSON" 입니다.
--outputFile	문자열	거짓	API 출력을 쓰기 (write) 파일 입니다. 이 플래그는 엔드포인트의 출력이 바이너리(예: gzip)이고 명령이 파이프되지 않은 경우(예: Atlas 명령 > out.zip)에 필요합니다.
--pretty		거짓	응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.
--version	문자열	거짓	API 호출 시 사용할 API 버전 [옵션: "2024-05-30"], 기본값은 최신 버전 또는 프로필 api_version 구성 값( 설정하다 경우) 이 값 기본값은 '2024-05-30".

상속된 옵션

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

예시

atlas api atlasSearch listSearchIndex --version 2024-05-30 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8

돌아가기

listClusterSearchIndexes

updateClusterFtsIndex