拉取用户任务列表

最近更新时间: 2026-09-17 00:05:09

1. 接口描述

接口请求域名： dcdb.api3.fincloud.tencent.cn。

本接口（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	数据库操作失败。

5. 示例

示例1 拉取用户任务列表

输入示例

https://dcdb.api3.fincloud.tencent.cn/?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"
      }
    ]
  }
}