1. 接口描述
接口请求域名: dbbrain.tencentcloudapi.com 。
查询某张表的慢查模板概览
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeIndexRecommendAggregationSlowLogs。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-27。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Product | 是 | String | 服务产品类型,支持值包括:"mongodb" - 云数据库 。 示例值:mongodb |
InstanceId | 是 | String | 实例ID。 示例值:cmgo-2jrxxlx |
Db | 是 | String | 数据库名称。 示例值:test |
Collection | 是 | String | 表明。 示例值:test.collection |
Signs.N | 是 | Array of String | 签名。 示例值:d6e6fe0025c258592dd6f442312f26ww |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Aggregation | Aggregation | 查询实例慢查询聚合结果。 注意:此字段可能返回 null,表示取不到有效值。 示例值:{} |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例慢查询聚合结果
输入示例
POST / HTTP/1.1
Host: dbbrain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIndexRecommendAggregationSlowLogs
<公共请求参数>
{
"Product": "abc",
"InstanceId": "abc",
"Db": "abc",
"Collection": "abc",
"Signs": [
"abc"
]
}
输出示例
{
"Response": {
"RequestId": "asdfaskldfanhasdfsd",
"Aggregation": {
"AvgExecTime": 8205,
"AvgDocsExamined": 2765962,
"SlowLogCount": 0,
"SlowLogs": [
"{\"t\":{\"$date\":\"2023-09-18T10:57:32.072+08:00\"},\"s\":\"I\", \"c\":\"COMMAND\", \"id\":51803, \"ctx\":\"conn7221917\",\"msg\":\"Slow query\",\"attr\":{\"type\":\"command\",\"ns\":\"welabel.ground_truth_data\",\"appName\":\"MongoDB Compass\",\"command\":{\"aggregate\":\"ground_truth_data\",\"pipeline\":[{\"$match\":{\"is_skip\":{\"$ne\":true}}},{\"$project\":{\"labels\":{\"$filter\":{\"input\":\"$comments.data.error_labels\",\"as\":\"com\",\"cond\":{\"$eq\":[\"$$com.questionType\",\"single\"]}}},\"ground_truth_id\":1}},{\"$unwind\":{\"path\":\"$labels\"}},{\"$match\":{\"labels.relationshipType\":\"multi_image_group\"}},{\"$limit\":100000},{\"$group\":{\"_id\":{\"uid\":\"$labels.questionId\",\"element_id\":\"$labels.elementId\",\"gt_id\":\"$ground_truth_id\"}}},{\"$limit\":10}],\"allowDiskUse\":true,\"cursor\":{},\"maxTimeMS\":60000,\"lsid\":{\"id\":{\"$uuid\":\"dcda39f2-cb81-47be-ba04-b0078cf6cc7f\"}},\"$clusterTime\":{\"clusterTime\":{\"$timestamp\":{\"t\":1695005847,\"i\":9}},\"signature\":{\"hash\":{\"$binary\":{\"base64\":\"04MsomRxChDbiOVh1kjTHEsL644=\",\"subType\":\"0\"}},\"keyId\":7218831488945487874}},\"$db\":\"welabel\"},\"planSummary\":\"COLLSCAN\",\"numYields\":1067,\"queryHash\":\"A480F99A\",\"planCacheKey\":\"E2805889\",\"ok\":0,\"errMsg\":\"Error in $cursor stage :: caused by :: operation was interrupted\",\"errName\":\"Interrupted\",\"errCode\":11601,\"reslen\":276,\"locks\":{\"ReplicationStateTransition\":{\"acquireCount\":{\"w\":1144}},\"Global\":{\"acquireCount\":{\"r\":1144}},\"Database\":{\"acquireCount\":{\"r\":1144}},\"Collection\":{\"acquireCount\":{\"r\":1144}},\"Mutex\":{\"acquireCount\":{\"r\":77}}},\"protocol\":\"op_msg\",\"durationMillis\":3663}}",
"{\"t\":{\"$date\":\"2023-09-18T10:57:27.730+08:00\"},\"s\":\"I\", \"c\":\"COMMAND\", \"id\":51803, \"ctx\":\"conn7221917\",\"msg\":\"Slow query\",\"attr\":{\"type\":\"command\",\"ns\":\"welabel.ground_truth_data\",\"appName\":\"MongoDB Compass\",\"command\":{\"aggregate\":\"ground_truth_data\",\"pipeline\":[{\"$match\":{\"is_skip\":{\"$ne\":true}}},{\"$unwind\":{\"path\":\"$comments\"}},{\"$project\":{\"labels\":{\"$filter\":{\"input\":\"$comments.data.error_labels\",\"as\":\"com\",\"cond\":{\"$eq\":[\"$$com.questionType\",\"single\"]}}},\"ground_truth_id\":1}},{\"$unwind\":{\"path\":\"$labels\"}},{\"$match\":{\"labels.relationshipType\":\"multi_image_group\"}},{\"$limit\":100000},{\"$group\":{\"_id\":{\"uid\":\"$labels.questionId\",\"element_id\":\"$labels.elementId\",\"gt_id\":\"$ground_truth_id\"}}},{\"$limit\":10}],\"allowDiskUse\":true,\"cursor\":{},\"maxTimeMS\":60000,\"lsid\":{\"id\":{\"$uuid\":\"8532ddbf-2f1c-4bdd-a4f0-af0217f42607\"}},\"$clusterTime\":{\"clusterTime\":{\"$timestamp\":{\"t\":1695005524,\"i\":8}},\"signature\":{\"hash\":{\"$binary\":{\"base64\":\"60J0bCCsS5xTPDOE2yE4yWuxNr0=\",\"subType\":\"0\"}},\"keyId\":7218831488945487874}},\"$db\":\"welabel\"},\"planSummary\":\"COLLSCAN\",\"numYields\":2887,\"queryHash\":\"A1933E73\",\"planCacheKey\":\"77FB924F\",\"ok\":0,\"errMsg\":\"operation was interrupted\",\"errName\":\"Interrupted\",\"errCode\":11601,\"reslen\":237,\"locks\":{\"ReplicationStateTransition\":{\"acquireCount\":{\"w\":3004}},\"Global\":{\"acquireCount\":{\"r\":3004}},\"Database\":{\"acquireCount\":{\"r\":3004}},\"Collection\":{\"acquireCount\":{\"r\":3004}},\"Mutex\":{\"acquireCount\":{\"r\":117}}},\"protocol\":\"op_msg\",\"durationMillis\":10483}}"
],
"SortCount": 0
}
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.UserHasNoStrategy | CAM鉴权错误。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |