1. 接口描述
接口请求域名: dbbrain.tencentcloudapi.com 。
查询MongoDB实时会话列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeMongoDBProcessList。 |
| Version | 是 | String | 公共参数,本接口取值:2021-05-27。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例 ID。可通过 DescribeDiagDBInstances 接口获取。 示例值:cmgo-ag8kko4r |
| Product | 是 | String | 服务产品类型,支持值:mongodb 示例值:mongodb |
| ID | 否 | Integer | 线程的ID,用于筛选线程列表。 示例值:123 |
| Host | 否 | String | 线程的操作主机地址,用于筛选线程列表。 示例值:127.0.0.1 |
| DB | 否 | String | 线程的操作数据库,用于筛选线程列表,如果是多个 使用 ',' 分割 示例值:test_db |
| Type | 否 | String | 命令类型 ,如果是多个 使用 ',' 分割 示例值:update |
| Time | 否 | Integer | 线程的操作时长最小值,单位秒,用于筛选操作时长大于该值的线程列表。 示例值:10 |
| Limit | 否 | Integer | 返回数量,默认20。 示例值:20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ProcessList | MongoDBProcessList | 数据 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeMongoDbProcessList示例
DescribeMongoDbProcessList示例
输入示例
POST / HTTP/1.1
Host: dbbrain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMongoDbProcessList
<公共请求参数>
{
"InstanceId": "cmgo-3bfxr69z",
"Product": "mongodb"
}
输出示例
{
"Response": {
"ProcessList": {
"Data": [
{
"Command": "{\"shard\": \"cmgo-8hnz2qj1_1\",\"type\": \"op\",\"host\": \"TENCENT64.site:7037\",\"desc\": \"conn15849513\",\"connectionId\": {\"$numberInt\":\"158",
"DB": "follows_1600088807.$cmd",
"Host": "9.222.21.122:53642",
"ID": 1798318411,
"InstanceNodeId": "mongos-3",
"IsInternalIp": true,
"ShardName": "cmgo-8hnz2qj1_1",
"Time": 97677.001,
"Type": "command",
"User": "mongouser"
}
],
"Names": [
"ID",
"Host",
"DB",
"Command",
"Time",
"Type"
]
},
"RequestId": "96422ce1-7ffd-40c8-a8fd-304331bd7270"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.UserHasNoStrategy | CAM鉴权错误。 |