拉取用户任务列表

最近更新时间: 2024-10-18 10:38:30

1. 接口描述

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

本接口(DescribeUserTasks)用于拉取用户任务列表

默认接口请求频率限制:20次/秒。

接口更新时间:2023-02-07 20:23:07。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeUserTasks
Version String 公共参数,本接口取值:2018-04-11
Region String 公共参数,详见产品支持的地域列表(TODO)
Statuses Array of Int64 任务的状态列表。0-任务启动中;1-任务运行中;2-任务成功;3-任务失败
InstanceIds Array of String 实例ID列表
FlowTypes Array of Int64 任务类型列表,当前支持的任务类型有:0-回档任务;1-创建实例任务;2-扩容任务;3-迁移任务;4-删除实例任务;5-重启任务
StartTime String 任务的创建时间
EndTime String 任务的结束时间
UTaskIds Array of Int64 任务ID的数组
Limit Int64 每次最多返回多少条任务,取值范围为(0,100],不传的话默认值为20
Offset Int64 返回任务默认是按照创建时间降序排列,从偏移值Offset处开始返回

3. 输出参数

参数名称 类型 描述
TotalCount Int64 任务总数
FlowSet UserTaskInfo 任务列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
UnauthorizedOperation.PermissionDenied
InternalError.OperateDatabaseFailed