1. 接口描述
接口请求域名： dcdb.tencentcloudapi.com 。
本接口（DescribeUserTasks）用于拉取用户任务列表
默认接口请求频率限制：200次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeUserTasks。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-11。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Statuses.N | 否 | Array of Integer | 任务的状态列表。0-任务启动中；1-任务运行中；2-任务成功；3-任务失败 |
| InstanceIds.N | 否 | Array of String | 实例ID列表 |
| FlowTypes.N | 否 | Array of Integer | 任务类型列表，当前支持的任务类型有：0-回档任务；1-创建实例任务；2-扩容任务；3-迁移任务；4-删除实例任务；5-重启任务 |
| StartTime | 否 | String | 任务的创建时间 |
| EndTime | 否 | String | 任务的结束时间 |
| UTaskIds.N | 否 | Array of Integer | 任务ID的数组 |
| Limit | 否 | Integer | 每次最多返回多少条任务，取值范围为(0,100]，不传的话默认值为20 示例值：20 |
| Offset | 否 | Integer | 返回任务默认是按照创建时间降序排列，从偏移值Offset处开始返回 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 任务总数 示例值：6 |
| FlowSet | Array of UserTaskInfo | 任务列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 拉取用户任务列表
输入示例
https://dcdb.tencentcloudapi.com/?Action=DescribeUserTasks
&<公共请求参数>输出示例
{
"Response": {
"TotalCount": 6,
"RequestId": "136034",
"FlowSet": [
{
"Status": 2,
"InstanceId": "tdsqlshard-d7tnnu13",
"RegionId": 1,
"InputData": "{\"AppId\":1251664966,\"UserType\":1,\"Uin\":\"1410643447\",\"Operator\":\"1410643447\",\"Ids\":[10182],\"RetreatedTime\":\"2016-02-18 04:01:40\"}",
"CreateTime": "2016-03-17 16:08:10",
"AppId": 251000022,
"UserTaskType": 0,
"EndTime": "2016-03-17 16:10:48",
"InstanceName": "tdsqlshard-d7tnnu13",
"Id": 23,
"ErrMsg": ""
},
{
"Status": 2,
"InstanceId": "tdsqlshard-d7tnnu13",
"RegionId": 1,
"InputData": "{\"AppId\":1251664966,\"UserType\":1,\"Uin\":\"1410643447\",\"Operator\":\"1410643447\",\"Ids\":[10182],\"RetreatedTime\":\"2016-02-11 01:21:37\"}",
"CreateTime": "2016-03-10 20:57:05",
"AppId": 251000022,
"UserTaskType": 0,
"EndTime": "2016-03-10 20:59:09",
"InstanceName": "tdsqlshard-d7tnnu13",
"Id": 22,
"ErrMsg": ""
},
{
"Status": 2,
"InstanceId": "tdsqlshard-7aqf6abn",
"RegionId": 1,
"InputData": "{\"AppId\":1251664966,\"UserType\":1,\"Uin\":\"1410643447\",\"Operator\":\"1410643447\",\"Ids\":[10182],\"RetreatedTime\":\"2016-02-18 01:21:37\"}",
"CreateTime": "2016-03-10 19:19:54",
"AppId": 251000022,
"UserTaskType": 0,
"EndTime": "2016-03-10 19:22:54",
"InstanceName": "tdsqlshard-7aqf6abn",
"Id": 21,
"ErrMsg": ""
},
{
"Status": 3,
"InstanceId": "tdsqlshard-7aqf6abn",
"RegionId": 1,
"InputData": "{\"AppId\":1251664966,\"UserType\":1,\"Uin\":\"1410643447\",\"Operator\":\"1410643447\",\"Ids\":[10160],\"RetreatedTime\":\"2016-01-01 01:30:30\"}",
"CreateTime": "2016-01-29 18:14:44",
"AppId": 251000022,
"UserTaskType": 0,
"EndTime": "2016-01-29 18:22:13",
"InstanceName": "tdsqlshard-7aqf6abn",
"Id": 18,
"ErrMsg": "pickValidBinlog error"
},
{
"Status": 3,
"InstanceId": "tdsqlshard-7aqf6abn",
"RegionId": 1,
"InputData": "{\"AppId\":1251664966,\"UserType\":1,\"Uin\":\"1410643447\",\"Operator\":\"1410643447\",\"Ids\":[10160],\"RetreatedTime\":\"2015-12-30 03:48:33\"}",
"CreateTime": "2016-01-18 20:01:47",
"AppId": 251000022,
"UserTaskType": 0,
"EndTime": "2016-01-18 20:09:16",
"InstanceName": "tdsqlshard-7aqf6abn",
"Id": 16,
"ErrMsg": "pickValidBinlog error"
},
{
"Status": 3,
"InstanceId": "tdsqlshard-7aqf6abn",
"RegionId": 1,
"InputData": "{\"AppId\":1251664966,\"UserType\":1,\"Uin\":\"1410643447\",\"Operator\":\"1410643447\",\"Ids\":[10160],\"RetreatedTime\":\"2015-12-29 03:48:33\"}",
"CreateTime": "2016-01-18 19:37:18",
"AppId": 251000022,
"UserTaskType": 0,
"EndTime": "2016-01-18 19:44:47",
"InstanceName": "tdsqlshard-7aqf6abn",
"Id": 15,
"ErrMsg": "pickValidBinlog error"
}
]
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.OperateDatabaseFailed | 数据库操作失败。 |
| UnauthorizedOperation.PermissionDenied | 没有权限操作该接口或资源。 |