查询任务列表

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

1. 接口描述

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

翻页查询任务列表

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

接口更新时间：2024-09-14 11:55:39。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeTaskRecords
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Offset	否	否	Uint64	翻页偏移量。示例值：
Limit	否	否	Uint64	翻页查询单页数量。示例值：
SearchWord	否	否	String	模糊查询关键字，支持任务ID和任务名称。示例值：
TaskState	否	否	String	任务启用状态。enabled/disabled 示例值：
GroupId	否	否	String	分组ID。示例值：
TaskType	否	否	String	任务类型。示例值：
ExecuteType	否	否	String	任务触发类型，UNICAST、BROADCAST。示例值：
Ids	否	否	Array of String	无示例值：

3. 输出参数

参数名称	类型	描述
Result	TaskRecordPage	任务记录列表示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
UnauthorizedOperation.LicenseUnauthorized	您所购买的服务不支持该操作。
UnauthorizedOperation.LicenseInactive	License未激活。。
UnauthorizedOperation.CamTsfRoleNoPermission	协作者身份未授权，需要主账号授予协作者权限，参考 TSF 官网文档「快速入门/准备工作」。
UnauthorizedOperation.CamTsfRoleNotExist	当前主账号未创建TSF_QCSRole或未对子账号授予预设策略QcloudCamSubaccountsAuthorizeRoleFullAccess。请参考产品文档主账号协作者使用说明。。
ResourceNotFound.TaskNotFound	任务不存在。
MissingParameter.TaskParameterMissed	缺少必填参数。
InvalidParameterValue.TaskParameterInvalid	无效请求参数。
UnauthorizedOperation.NoPrivilege	用户无权限访问该接口。。
ResourceNotFound.MicroserviceOffline	目标微服务已离线[%s]。。

5. 示例

示例1 查询任务列表

输入示例

https://tsf.api3.<no value>/?Action=DescribeTaskRecords
&Offset=0
&Limit=10
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "Content": [
                {
                    "RetryInterval": 0, 
                    "BelongFlowIds": [
                        "xx"
                    ], 
                    "TriggerType": "xx", 
                    "TimeOut": 3000, 
                    "TaskRule": {
                        "RepeatInterval": 1, 
                        "RuleType": "xx", 
                        "Expression": "xx"
                    }, 
                    "TaskState": "xx", 
                    "SuccessRatio": 0, 
                    "TaskContent": "xx", 
                    "TaskArgument": "xx", 
                    "AdvanceSettings": {
                        "SubTaskConcurrency": 0
                    }, 
                    "RetryCount": 0, 
                    "SuccessOperator": "xx", 
                    "TaskId": "xx", 
                    "TaskType": "xx", 
                    "ShardCount": 0, 
                    "ExecuteType": "xx", 
                    "TaskName": "xx", 
                    "ShardArguments": [
                        {
                            "ShardValue": "xx", 
                            "ShardKey": 1
                        }
                    ], 
                    "GroupId": "xx", 
                    "TaskLogId": "xx"
                }
            ], 
            "TotalCount": 7
        }, 
        "RequestId": "xx"
    }
}