查询任务详情

最近更新时间:2024-03-12 02:00:15

我的收藏

1. 接口描述

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

查询任务详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTaskDetail。
Version String 公共参数,本接口取值:2018-03-26。
Region String 公共参数,详见产品支持的 地域列表
TaskId String 任务ID
示例值:task-12345678
TaskLogId String 任务历史ID
示例值:tlog-12345678

3. 输出参数

参数名称 类型 描述
Result TaskRecord 任务详情
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询任务详情

输入示例

https://tsf.tencentcloudapi.com/?Action=DescribeTaskDetail
&TaskId=0
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "RetryInterval": 0,
            "TriggerType": "xx",
            "TimeOut": 0,
            "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",
            "BelongFlowIds": [
                "xx"
            ]
        },
        "RequestId": "xx"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.TaskQueryError 任务查询异常。
InvalidParameter.BadRequest [%s]模块接口[%s]请求不正确(400 BAD REQUEST)。。
InvalidParameterValue.InvalidParameterFormat 参数格式异常。
InvalidParameterValue.TaskParameterInvalid 无效请求参数。
ResourceNotFound.MicroserviceOffline 目标微服务已离线[%s]。。
ResourceNotFound.TaskNotFound 任务不存在。
UnauthorizedOperation.CamTsfRoleNoPermission 协作者身份未授权,需要主账号授予协作者权限,参考 TSF 官网文档「快速入门/准备工作」。
UnauthorizedOperation.CamTsfRoleNotExist 当前主账号未创建TSF_QCSRole或未对子账号授予预设策略QcloudCamSubaccountsAuthorizeRoleFullAccess。请参考产品文档主账号协作者使用说明。。
UnauthorizedOperation.LicenseInactive License未激活。。
UnauthorizedOperation.LicenseUnauthorized 您所购买的服务不支持该操作。
UnauthorizedOperation.NoPrivilege 用户无权限访问该接口。。