인덱스 제거 제안 받기

이 페이지의 내용

Resource
요청 경로 매개변수
요청 쿼리 매개변수
요청 본문 매개변수
응답
요청 예시
응답 예시

Cloud Manager는 2024년 8월 30일부터 더 이상 MongoDB 3.6 및 4.0에 대한 자동화, 백업 및 모니터링을 지원하지 않습니다. MongoDB 배포를 업그레이드하거나 Atlas로 마이그레이션하세요.

Cloud Manager 에 대한 프로그래밍 방식의 액세스 를 위한 OAuth 2.0 인증 은 Preview 기능 으로 제공됩니다.: 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다. OAuth 2.0 인증 을 사용하려면 Cloud Manager 공개 API 에 대한 요청에 사용할서비스 계정을 만듭니다.

Performance Advisor 의결정에 따라 인덱스 제거 제안을 검색합니다.

기본 URL: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /groups/{PROJECT-ID}/performanceAdvisor/dropIndexSuggestions

요청 경로 매개변수

Parameter	유형	설명
프로젝트 ID	문자열	(필수) 이 MongoDB deployment 소유한 프로젝트 의 고유 식별자입니다. 그룹과 프로젝트는 동의어입니다. 그룹 ID 프로젝트 ID 와 동일합니다.

요청 쿼리 매개변수

clusterId 또는 hostId 중 하나가 필요합니다.

Parameter	유형	설명
pretty	부울	응답 본문이 프리티프린트 에 있어야 하는지 여부를 나타냅니다. 형식.
envelope	부울	응답을 엔벨로프에 래핑할지 여부를 나타냅니다.
clusterId	문자열	복제본 세트 또는 샤딩된 클러스터 의 고유 식별자입니다. `hostId`를 사용하는 독립형 인스턴스 에 대한 인덱스 제거 제안을 원하는 경우 이 매개 변수를 `null` 로 설정합니다.
hostId	문자열	인덱스 제거 제안을 원하는 독립형 인스턴스 의 고유 식별자입니다. `clusterId` 이 `null`인 경우 필수입니다.

요청 본문 매개변수

이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.

응답

이름	유형	설명
`unusedIndexes`	문서 배열	제거 후보로 간주되는 미사용 인덱스에 대한 정보입니다.
`hiddenIndexes`	문서 배열	제거 후보인 숨겨진 인덱스에 대한 정보입니다.
`redundantIndexes`	문서 배열	기존 인덱스와 겹칠 수 있으며 제거가 고려되는 중복 인덱스에 대한 정보입니다.

요청 예시

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET 'https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/performanceAdvisor/dropIndexSuggestions?clusterId={clusterId}&pretty=true'

응답 예시

{
    "hiddenIndexes": [
        {
            "shardIds": ["shard-0"],
            "accessCount": 0,
            "index": [
                {
                    "_fts": "text"
                },
                {
                    "_ftsx": 1
                }
            ],
            "name": "product_description_reviews_text",
            "namespace": "inventory.products",
            "since": "2024-10-02T18:02:22Z",
            "sizeBytes": 4096
        },
        {
            "shardIds": ["shard-0"],
            "accessCount": 0,
            "index": [
                {
                    "unseenFeature": 1
                }
            ],
            "name": "unseenFeature_1",
            "namespace": "inventory.products",
            "since": "2024-10-02T18:02:22Z",
            "sizeBytes": 4096
        }
    ],
    "redundantIndexes": [
        {
            "shardIds": ["shard-0"],
            "accessCount": 0,
            "index": [
                {
                    "category": 1
                }
            ],
            "name": "category_1",
            "namespace": "inventory.products",
            "relatedIndexes": [
                {
                    "accessCount": 1,
                    "index": [
                        {
                            "category": 1
                        },
                        {
                            "price": -1
                        }
                    ],
                    "name": "category_1_price_-1",
                    "namespace": "inventory.products",
                    "since": "2024-10-02T18:02:22Z",
                    "sizeBytes": 4096
                }
            ],
            "since": "2024-10-02T18:02:22Z",
            "sizeBytes": 4096
        }
    ],
    "unusedIndexes": []
}

돌아가기