1. 接口描述
接口请求域名： dcdb.api3.fincloud.tencent.com。
本接口（DescribeUserTasks）用于拉取用户任务列表
默认接口请求频率限制：20次/秒。
接口更新时间：2023-11-14 14:11:07。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeUserTasks |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-04-11 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Statuses | 否 | 否 | Array of Int64 | 任务的状态列表。0-任务启动中；1-任务运行中；2-任务成功；3-任务失败 示例值： [0,1,2] |
| InstanceIds | 否 | 否 | Array of String | 实例ID列表 示例值： ["tdsqlshard-hqtjy5d1","tdsqlshard-hqtjy5d1"] |
| FlowTypes | 否 | 否 | Array of Int64 | 任务类型列表，当前支持的任务类型有：0-回档任务；1-创建实例任务；2-扩容任务；3-迁移任务；4-删除实例任务；5-重启任务 示例值： [0,1] |
| StartTime | 否 | 否 | String | 任务的创建时间 示例值： 2024-11-14 17:18:05 |
| EndTime | 否 | 否 | String | 任务的结束时间 示例值： 2024-11-14 17:18:05 |
| UTaskIds | 否 | 否 | Array of Int64 | 任务ID的数组 示例值： [11,22] |
| Limit | 否 | 否 | Int64 | 每次最多返回多少条任务，取值范围为(0,100]，不传的话默认值为20 示例值： 20 |
| Offset | 否 | 否 | Int64 | 返回任务默认是按照创建时间降序排列，从偏移值Offset处开始返回 示例值： 0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 任务总数 示例值： 6 |
| FlowSet | Array of UserTaskInfo | 任务列表 示例值：查看 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| UnauthorizedOperation.PermissionDenied | 没有权限操作该接口或资源。 |
| InternalError.OperateDatabaseFailed | 数据库操作失败。 |