Join us Sept 17 at .local NYC! Use code WEB50 to save 50% on tickets. Learn more >
MongoDB Event
Docs Menu
Docs Home
/ /
Atlas CLI
/ / / /

Atlas API performanceAdvisor listSuggestedIndexes

공개 미리 보기: 피드백 제공하세요: Performance Advisor 제안하는 인덱스를 반환합니다.

공개 미리 보기: MongoDB Atlas 관리자 API 에서 자동으로 생성된 Atlas API 하위 명령은 관리자 API 에 대한 전체 기능을 제공하며 현재 공개 미리 보기로 제공됩니다( 피드백 https://feedback.mongodb.com/forums/930808-Atlas-cli). 관리자 API 기능에는 자체 출시하다 수명 주기가 있으며, 이는 제공된 API 엔드포인트 문서 링크를 통해 확인할 수 있습니다.

Performance Advisor는 MongoDB가 느리다고 판단한 쿼리를 모니터링하고 쿼리 성능을 향상시키기 위해 새 인덱스를 추천합니다. 이 리소스를 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 읽기 전용 역할이 필요합니다.

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

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

명령 구문
atlas api performanceAdvisor listSuggestedIndexes [options]
이름
유형
필수 사항
설명

--duration

int

거짓

쿼리가 cluster의 관리형 네임스페이스 중에서 추천 인덱스를 찾는 동안 표현된 시간입니다. 이 매개변수는 해당 값을 밀리초 단위로 표현합니다.

  • 이후 매개변수를 지정하지 않으면 엔드포인트는 현재 시간 이전의 기간을 포함하는 데이터를 반환합니다.

  • 기간 또는 이후 매개변수를 모두 지정하지 않으면 엔드포인트는 이전 24시간 동안의 데이터를 반환합니다.

--envelope

envelope

거짓

애플리케이션이 응답을 엔벨로프 JSON 객체 로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스 할 수 없습니다. 이 문제를 해결하려면 쿼리 에서 envelope=true 를 설정하다 . 결과 목록을 반환하는 엔드포인트는 결과 객체 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

--groupId

문자열

true

프로젝트 식별하는 고유한 24-16진수 문자열입니다. [/groups](# 태그를 지정하다 /Projects/operation/listProjects) 엔드포인트를 사용하여 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 .

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

-h, --help

거짓

listSuggestedIndexes에 대한 도움말

--includeCount

거짓

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

--itemsPerPage

int

거짓

페이지당 응답이 반환하는 항목 수입니다.

--nExamples

int

거짓

추천 인덱스의 이점을 누릴 수 있는 최대 예시 쿼리 수입니다.

--nIndexes

int

거짓

추천할 최대 인덱스를 나타내는 숫자입니다.

--namespaces

.

거짓

추천 인덱스를 조회 할 네임스페이스입니다. 네임스페이스 데이터베이스 한 개와 .: <database>.<collection>로 작성된 컬렉션 리소스 한 개로 구성됩니다. 여러 네임스페이스를 포함하려면 각 네임스페이스 사이에 앰퍼샌드(&)로 구분하여 매개변수를 여러 번 전달합니다. 모든 네임스페이스에 대한 결과를 반환하려면 이 매개변수를 생략합니다.

-o, --output

문자열

거짓

기본 설정 API 형식은 ["JSON", go- Template] 일 수 있습니다. 이 값의 기본값은 "JSON" 입니다.

--outputFile

문자열

거짓

API 출력을 쓰기 (write) 파일 입니다. 이 플래그는 엔드포인트의 출력이 바이너리(예: gzip)이고 명령이 파이프되지 않은 경우(예: Atlas 명령 > out.zip)에 필요합니다.

--pageNum

int

거짓

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

--pretty

거짓

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

--processId

mongod

true

MongoDB 프로세스 제공하는 호스팅하다 와 포트의 조합입니다. 호스팅하다 MongoDB 프로세스 (mongod 또는 mongos)를 실행하는 호스팅하다 의 호스트 이름, FQDN, IPv4 주소 또는 IPv6 주소 여야 합니다. 포트는 MongoDB 프로세스 요청을 수신하는 IANA 포트여야 합니다.

--since

int

거짓

쿼리 추천 인덱스를 조회하는 날짜 및 시간입니다. 이 매개변수는 [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time) 이후 경과된 시간(밀리초)으로 값을 표현합니다.

  • 기간 매개변수를 지정하지 않으면 엔드포인트는 이후 값과 현재 시간을 포함하는 데이터를 반환합니다.

  • 기간 또는 이후 매개변수를 모두 지정하지 않으면 엔드포인트는 이전 24시간 동안의 데이터를 반환합니다.

--version

문자열

거짓

API 호출 시 사용할 API 버전 [옵션: "2023-01-01"], 기본값은 최신 버전 또는 프로필 api_version 구성 값( 설정하다 경우) 이 값 기본값은 '2023-01-01".

이름
유형
필수 사항
설명

-P, --profile

문자열

거짓

구성 파일 에서 사용할 프로필의 이름입니다. Atlas CLI 의 프로필에 대해 학습 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings를 참조하세요.

atlas api performanceAdvisor listSuggestedIndexes --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId [processId]

이 페이지의 내용