Obter sugestões de remoção de índice
Nesta página
- A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.
- O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .
Recupera sugestões de remoção de índice conforme determinado pelo Performance Advisor.
URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/performanceAdvisor/dropIndexSuggestions
Parâmetros do caminho da solicitação
Parâmetro | Tipo | Descrição |
|---|---|---|
ID do projeto | string | (Obrigatório) Identificador exclusivo do projeto que possui essa implantação do MongoDB . Grupos e projetos são termos sinônimos. O ID do grupo é igual ao ID do projeto. |
Solicitar parâmetros de query
É necessário clusterId ou hostId.
Parâmetro | Tipo | Descrição |
|---|---|---|
pretty | booleano | Indica se o corpo da resposta deve estar em um prettyprint formato. |
envelope | booleano | Indica se deseja ou não envolver a resposta em um envelope. |
clusterId | string | Identificador único de um conjunto de réplicas ou cluster fragmentado. Defina este parâmetro como |
hostId | string | Identificador exclusivo da instância autônomo para a qual você deseja sugestões de remoção de índice. Obrigatório se |
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
Nome | Tipo | Descrição |
|---|---|---|
| matriz de documentos | Informações sobre índices não utilizados considerados candidatos à remoção. |
| matriz de documentos | Informações sobre índices ocultos que são candidatos à remoção. |
| matriz de documentos | Informações sobre índices redundantes que podem se sobrepor aos existentes e são considerados para remoção. |
Exemplo de solicitação
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'
Exemplo de resposta
{ "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": [] }