インデックス削除の提案を取得する
Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用する サービス アカウント を作成します。
Performance Advisor によって決定されたインデックス削除の提案を取得します。
ベース URL: https://cloud.mongodb.com/api/public/v 1.0
Resource
GET /groups/{PROJECT-ID}/performanceAdvisor/dropIndexSuggestions
リクエスト パス パラメーター
Parameter | タイプ | 説明 |
|---|---|---|
プロジェクトID | string | （必須）このMongoDBデプロイを所有するプロジェクトの一意の識別子。グループとプロジェクトは同義語です。グループ ID はプロジェクトIDと同じです。 |
リクエスト クエリ パラメータ
clusterId または hostId のいずれかが必要です。
Parameter | タイプ | 説明 |
|---|---|---|
pretty | ブール値 | レスポンス本体を pretty-print にするかどうかを示します 形式。 |
envelope | ブール値 | 応答をエンベロープでラップするかどうかを示します。 |
clusterId | string | レプリカセットまたはシャーディングされたクラスターの一意の識別子です。 |
hostId | string | インデックス削除の提案が必要なスタンドアロンインスタンスの一意の識別子。 |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
|---|---|---|
| ドキュメントの配列 | 削除の候補と見なされた未使用のインデックスに関する情報。 |
| ドキュメントの配列 | 削除の候補である 非表示のインデックス に関する情報。 |
| ドキュメントの配列 | 既存のインデックスと重複する可能性があり、削除が検討されている冗長なインデックスに関する情報。 |
リクエストの例
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": [] }