제안된 모든 인덱스를 삭제로 반환

얻다 /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions

Performance Advisor가 삭제하도록 제안하는 인덱스를 반환합니다. Performance Advisor는 쓰기 성능을 개선하고 저장 공간을 확보하기 위해 사용되지 않거나 중복되거나 숨겨진 인덱스를 삭제할 것을 제안합니다. 이 리소스를 사용하려면, 요청하는 서비스 계정 또는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

경로 매개변수

  • groupId 문자열 필수 사항

    프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.

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

    형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

  • clusterName 문자열 필수 사항

    클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

    형식은 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ 패턴 과 일치해야 합니다.

응답

  • 200 application/vnd.atlas.2024-08-05+json

    확인

    응답 속성 숨기기 응답 속성 표시 객체
    • hiddenIndexes 배열[객체]

      Performance Advisor 제거 제안하는 숨겨진 인덱스에 대한 정보가 포함된 문서가 포함된 목록입니다.

      Hide hiddenIndexes attributes 숨겨진 인덱스 속성 표시 객체
      • accessCount integer(int64)

        인덱스 의 사용 횟수(마지막 재시작 이후)입니다.

      • index 배열[객체]

        인덱스 및 정렬 순서에서 키를 지정하는 문서가 포함된 목록입니다.

        정렬 순서와 쌍을 이루는 하나의 인덱스 키입니다. 1 값은 오름차순 정렬 순서를 나타냅니다. -1 값은 내림차순 정렬을 나타냅니다. 키가 여러 개인 인덱스의 키는 인덱스 에 표시되는 순서와 동일한 순서로 표시됩니다.

        정렬 순서와 쌍을 이루는 하나의 인덱스 키입니다. 1 값은 오름차순 정렬 순서를 나타냅니다. -1 값은 내림차순 정렬을 나타냅니다. 키가 여러 개인 인덱스의 키는 인덱스 에 표시되는 순서와 동일한 순서로 표시됩니다.

      • 이름 문자열

        인덱스 의 이름입니다.

      • namespace 문자열

        지정된 호스팅하다 의 네임스페이스 를 식별하는 사람이 읽을 수 있는 레이블입니다. 리소스 이 매개변수 값을 <database>.<collection>로 표현합니다.

      • shards array[string]

        인덱스 발견된 샤드를 지정하는 문자열이 포함된 목록입니다.

      • 이후 문자열(날짜-시간)

        인덱스 를 가장 최근에 사용한 날짜입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

      • sizeBytes integer(int64)

        인덱스 의 크기입니다.

    • redundantIndexes 배열[객체]

      Performance Advisor 제거 제안하는 중복 인덱스에 대한 정보가 포함된 문서가 포함된 목록입니다.

      Hide redundantIndexes attributes RedundantIndexes 속성 표시 객체
      • accessCount integer(int64)

        인덱스 의 사용 횟수(마지막 재시작 이후)입니다.

      • index 배열[객체]

        인덱스 및 정렬 순서에서 키를 지정하는 문서가 포함된 목록입니다.

        정렬 순서와 쌍을 이루는 하나의 인덱스 키입니다. 1 값은 오름차순 정렬 순서를 나타냅니다. -1 값은 내림차순 정렬을 나타냅니다. 키가 여러 개인 인덱스의 키는 인덱스 에 표시되는 순서와 동일한 순서로 표시됩니다.

        정렬 순서와 쌍을 이루는 하나의 인덱스 키입니다. 1 값은 오름차순 정렬 순서를 나타냅니다. -1 값은 내림차순 정렬을 나타냅니다. 키가 여러 개인 인덱스의 키는 인덱스 에 표시되는 순서와 동일한 순서로 표시됩니다.

      • 이름 문자열

        인덱스 의 이름입니다.

      • namespace 문자열

        지정된 호스팅하다 의 네임스페이스 를 식별하는 사람이 읽을 수 있는 레이블입니다. 리소스 이 매개변수 값을 <database>.<collection>로 표현합니다.

      • shards array[string]

        인덱스 발견된 샤드를 지정하는 문자열이 포함된 목록입니다.

      • 이후 문자열(날짜-시간)

        인덱스 를 가장 최근에 사용한 날짜입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

      • sizeBytes integer(int64)

        인덱스 의 크기입니다.

    • unusedIndexes 배열[객체]

      Performance Advisor 제거 하도록 제안하는 미사용 인덱스에 대한 정보가 포함된 문서가 포함된 목록입니다.

      사용하지 않는 인덱스 속성 숨기기 사용하지 않는 인덱스 속성 표시 객체
      • accessCount integer(int64)

        인덱스 의 사용 횟수(마지막 재시작 이후)입니다.

      • index 배열[객체]

        인덱스 및 정렬 순서에서 키를 지정하는 문서가 포함된 목록입니다.

        정렬 순서와 쌍을 이루는 하나의 인덱스 키입니다. 1 값은 오름차순 정렬 순서를 나타냅니다. -1 값은 내림차순 정렬을 나타냅니다. 키가 여러 개인 인덱스의 키는 인덱스 에 표시되는 순서와 동일한 순서로 표시됩니다.

        정렬 순서와 쌍을 이루는 하나의 인덱스 키입니다. 1 값은 오름차순 정렬 순서를 나타냅니다. -1 값은 내림차순 정렬을 나타냅니다. 키가 여러 개인 인덱스의 키는 인덱스 에 표시되는 순서와 동일한 순서로 표시됩니다.

      • 이름 문자열

        인덱스 의 이름입니다.

      • namespace 문자열

        지정된 호스팅하다 의 네임스페이스 를 식별하는 사람이 읽을 수 있는 레이블입니다. 리소스 이 매개변수 값을 <database>.<collection>로 표현합니다.

      • shards array[string]

        인덱스 발견된 샤드를 지정하는 문자열이 포함된 목록입니다.

      • 이후 문자열(날짜-시간)

        인덱스 를 가장 최근에 사용한 날짜입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

      • sizeBytes integer(int64)

        인덱스 의 크기입니다.

  • 400 application/json

    잘못된 요청입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 401 application/json

    승인되지 않았습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 403 application/json

    Forbidden.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 404 application/json

    찾을 수 없습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 429 application/json

    요청이 너무 많습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 500 application/json

    내부 서버 오류입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

GET /API/Atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions
atlas api performanceAdvisor listGroupClusterPerformanceAdvisorDropIndexSuggestions --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.ListGroupClusterPerformanceAdvisorDropIndexSuggestionsApiParams{}
	sdkResp, httpResp, err := client.PerformanceAdvisorApi.
		ListGroupClusterPerformanceAdvisorDropIndexSuggestionsWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions?pretty=true"
응답 예시(200)
{
  "hiddenIndexes": [
    {
      "accessCount": 42,
      "index": [
        {}
      ],
      "name": "string",
      "namespace": "string",
      "shards": [
        "string"
      ],
      "since": "2025-05-04T09:42:00Z",
      "sizeBytes": 42
    }
  ],
  "redundantIndexes": [
    {
      "accessCount": 42,
      "index": [
        {}
      ],
      "name": "string",
      "namespace": "string",
      "shards": [
        "string"
      ],
      "since": "2025-05-04T09:42:00Z",
      "sizeBytes": 42
    }
  ],
  "unusedIndexes": [
    {
      "accessCount": 42,
      "index": [
        {}
      ],
      "name": "string",
      "namespace": "string",
      "shards": [
        "string"
      ],
      "since": "2025-05-04T09:42:00Z",
      "sizeBytes": 42
    }
  ]
}
응답 예시(400)
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
응답 예시(401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
응답 예시(403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
응답 예시(404)
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
응답 예시(429)
{
  "error": 429,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Too Many Requests",
  "errorCode": "RATE_LIMITED"
}
응답 예시(500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}