查询实例的索引推荐信息

最近更新时间:2024-03-12 01:24:41

我的收藏

1. 接口描述

接口请求域名: dbbrain.tencentcloudapi.com 。

查询实例的索引推荐信息,包括索引统计相关信息,推荐索引列表,无效索引列表等。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeIndexRecommendInfo。
Version String 公共参数,本接口取值:2021-05-27。
Region String 公共参数,详见产品支持的 地域列表
Product String 服务产品类型,支持值包括:"mongodb" - 云数据库 。
示例值:mongodb
InstanceId String 实例ID。
示例值:cmgo-2jrxxlx

3. 输出参数

参数名称 类型 描述
CollectionNum Integer 索引推荐的集合数量。
示例值:100
IndexNum Integer 索引推荐的索引数量。
示例值:1
Items Array of MongoDBIndex 索引项。
示例值:
Level Integer 优化级别,1-4,优先级从高到低。
示例值:1
Optimized Integer 历史优化数。
示例值:11
OptimizedCount Integer 累计优化条数。
示例值:33
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 mongodb索引推荐

查询mongodb数据比较慢的时候,可以通过该接口进行获取推荐的索引列表

输入示例

POST / HTTP/1.1
Host: dbbrain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIndexRecommendInfo
<公共请求参数>

{
    "Product": "mongodb",
    "InstanceId": "cmog-ahshjbdwe"
}

输出示例

{
    "Response": {
        "CollectionNum": 0,
        "IndexNum": 0,
        "Items": [
            {
                "ClusterId": "abc",
                "Collection": "abc",
                "Db": "abc",
                "Level": 0,
                "Score": 0,
                "IndexesToBuild": [
                    {
                        "Id": 0,
                        "IndexCommand": "abc",
                        "IndexStr": "abc",
                        "Level": 0,
                        "Score": 0,
                        "Signs": [
                            "abc"
                        ],
                        "Status": 0
                    }
                ],
                "IndexesToDrop": [
                    {
                        "IndexStr": "abc",
                        "Score": 0,
                        "Reason": "abc",
                        "IndexCommand": "abc",
                        "IndexName": "abc"
                    }
                ]
            }
        ],
        "Level": 0,
        "Optimized": 0,
        "OptimizedCount": 0,
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.UserHasNoStrategy CAM鉴权错误。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。