查询任务详情

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

1. 接口描述

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

查询任务详情

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

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

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeTaskDetail
Version String 公共参数,本接口取值:2018-03-26
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
TaskId String 任务ID
示例值:
TaskLogId String 任务历史ID
示例值:

3. 输出参数

参数名称 类型 描述
Result TaskRecord 任务详情
示例值:查看
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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

5. 示例

示例1 查询任务详情

输入示例

https://tsf.api3.<no value>/?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"
    }
}