1. 接口描述
接口请求域名: mongodb.tencentcloudapi.com 。
本接口(DescribeCurrentOp)用于查询云数据库实例的当前正在执行的操作。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCurrentOp。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 指定要查询的实例 ID,例如:cmgo-p8vn。请登录 MongoDB 控制台在实例列表复制实例 ID。 示例值:cmgo-p8vn |
Ns | 否 | String | 操作所属的命名空间 namespace,格式为 db.collection。 示例值:data.user |
MillisecondRunning | 否 | Integer | 设置查询筛选条件为操作任务已经执行的时间。 - 默认值为0,取值范围为[0, 3600000],单位:毫秒。 - 结果将返回超过设置时间的操作。 示例值:20 |
Op | 否 | String | 设置查询筛选条件为操作任务类型。取值包括:none、update、insert,query、command、getmore、remove 和 killcursors。 示例值:update |
ReplicaSetName | 否 | String | 筛选条件,分片名称。 示例值:cmgo-nh1o****_0 |
State | 否 | String | 设置查询筛选条件为节点角色。 - primary:主节点。 - secondary:从节点。 示例值:primary |
Limit | 否 | Integer | 单次请求返回的数量,默认值为100,取值范围为[0,100] 示例值:10 |
Offset | 否 | Integer | 偏移量,默认值为0,取值范围为[0,10000] 示例值:1 |
OrderBy | 否 | String | 返回结果集排序的字段,目前支持:"MicrosecsRunning"/"microsecsrunning",默认为升序排序 示例值:MicrosecsRunning |
OrderByType | 否 | String | 返回结果集排序方式,可能的取值:"ASC"/"asc"或"DESC"/"desc" 示例值:ASC |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 符合查询条件的操作总数。 示例值:19 |
CurrentOps | Array of CurrentOp | 当前操作列表。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询云数据库实例的当前操作
查询云数据库实例的当前操作
输入示例
POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCurrentOp
<公共请求参数>
{
"InstanceId": "cmgo-p8vn****"
}
输出示例
{
"Response": {
"TotalCount": 1,
"CurrentOps": [
{
"OpId": 1804858933,
"Ns": "db.****",
"Query": "",
"Op": "command",
"ReplicaSetName": "salve-1",
"NodeName": "salve-1",
"Operation": "****",
"State": "Primary",
"MicrosecsRunning": 30353723,
"ExecNode": "从节点"
}
],
"RequestId": "66956cf3-2d10-4c68-87c0-7bd558deae7e"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter.PermissionDenied | 当前子账号无权执行该操作。 |
InvalidParameterValue.NotFoundInstance | 未找到实例。 |
InvalidParameterValue.QueryOutOfRange | 查询offset超出范围。 |
InvalidParameterValue.RegionNotSupportOperation | 当前地域尚不支持该操作。 |
InvalidParameterValue.ReplicaNotFound | 未找到副本集/分片。 |