微服务平台 TSF 查询任务列表

1. 接口描述

接口请求域名： tsf.tencentcloudapi.com 。

翻页查询任务列表

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTaskRecords。
Version	是	String	公共参数，本接口取值：2018-03-26。
Region	是	String	公共参数，详见产品支持的地域列表。
Offset	否	Integer	翻页偏移量。默认值为0 示例值：0
Limit	否	Integer	翻页查询单页数量。默认值为 20，最大值为 1000 示例值：10
SearchWord	否	String	模糊查询关键字，支持任务ID和任务名称。示例值：taskName
TaskState	否	String	任务启用状态。一共2种状态可选，ENABLED：启用，DISABLED：停用示例值：enabled
GroupId	否	String	部署组ID。前往应用管理点击应用ID进入应用部署列表页面获取部署组ID。示例值：group-abl8j7xy
TaskType	否	String	任务类型。当前只支持一种任务类型。枚举值，java：Java类任务示例值：java
ExecuteType	否	String	任务执行方式，unicast：随机单节点执行，broadcast：广播执行，shard：分片执行示例值：unicast
Ids.N	否	Array of String	任务ID列表。在任务管理列表页第一列查看任务ID。示例值：["task-6a79x94v"]

3. 输出参数

参数名称	类型	描述
Result	TaskRecordPage	任务记录列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询任务列表

输入示例

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

输出示例

{
    "Response": {
        "Result": {
            "Content": [
                {
                    "RetryInterval": 0,
                    "BelongFlowIds": [
                        "flow-6a79x94v"
                    ],
                    "TriggerType": "auto",
                    "TimeOut": 3000,
                    "TaskRule": {
                        "RepeatInterval": 1,
                        "RuleType": "unicast",
                        "Expression": "* 30 * * * *"
                    },
                    "TaskState": "Running",
                    "SuccessRatio": 0,
                    "TaskContent": "this is desc",
                    "TaskArgument": "1,1,1",
                    "AdvanceSettings": {
                        "SubTaskConcurrency": 0
                    },
                    "RetryCount": 0,
                    "SuccessOperator": "null",
                    "TaskId": "task-6a79x94v",
                    "TaskType": "unicast",
                    "ShardCount": 0,
                    "ExecuteType": "unicast",
                    "TaskName": "task-name",
                    "ShardArguments": [
                        {
                            "ShardValue": "1",
                            "ShardKey": 1
                        }
                    ],
                    "GroupId": "group-6a79x94v",
                    "TaskLogId": "tlog-6a79x94v"
                }
            ],
            "TotalCount": 7
        },
        "RequestId": "sj28sk-m2ia2-k2901-9sjwj"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

查询任务列表

本页目录：