有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

用于查询指定任务的详细信息,包括任务内部的任务实例信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTask。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
JobId String 作业ID
示例值:job-97zcl3wt
TaskName String 任务名称
示例值:A
Offset Integer 偏移量
示例值:0
Limit Integer 返回数量。默认取值100,最大取值1000。
示例值:100
Filters.N Array of Filter 过滤条件,详情如下:
  • task-instance-type - String - 是否必填: 否 - 按照任务实例状态进行过滤(SUBMITTED:已提交;PENDING:等待中;RUNNABLE:可运行;STARTING:启动中;RUNNING:运行中;SUCCEED:成功;FAILED:失败;FAILED_INTERRUPTED:失败后保留实例)。
  • 3. 输出参数

    参数名称 类型 描述
    JobId String 作业ID
    示例值:job-97zcl3wt
    TaskName String 任务名称
    示例值:A
    TaskState String 任务状态
    示例值:SUCCEED
    CreateTime String 创建时间
    示例值:2018-02-07T09:29:09Z
    EndTime String 结束时间
    示例值:2018-02-07T09:30:31Z
    TaskInstanceTotalCount Integer 任务实例总数
    示例值:2
    TaskInstanceSet Array of TaskInstanceView 任务实例信息
    TaskInstanceMetrics TaskInstanceMetrics 任务实例统计指标
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询任务详情

    输入示例

    https://batch.tencentcloudapi.com/?Action=DescribeTask
    &JobId=job-97zcl3wt
    &TaskName=A
    &Filters.0.Name=task-instance-state
    &Filters.0.Values.0=SUCCEED
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "TaskInstanceSet": [
                {
                    "TaskInstanceIndex": 1,
                    "RedirectInfo": {
                        "StderrRedirectFileName": "stderr.job-97zcl3wt.A.1.log",
                        "StdoutRedirectFileName": "stdout.job-97zcl3wt.A.1.log",
                        "StdoutRedirectPath": "cos://dondonbatch-1251783334.cosgz.myqcloud.com/hello2/logs/",
                        "StderrRedirectPath": "cos://dondonbatch-1251783334.cosgz.myqcloud.com/hello2/logs/"
                    },
                    "RunningTime": "2018-02-07T09:29:55Z",
                    "LaunchTime": "2018-02-07T09:29:09Z",
                    "StateReason": "",
                    "StateDetailedReason": "xx",
                    "ComputeNodeInstanceId": null,
                    "EndTime": "2018-02-07T09:30:23Z",
                    "TaskInstanceState": "SUCCEED",
                    "CreateTime": "2018-02-07T09:29:09Z",
                    "ExitCode": 0
                },
                {
                    "TaskInstanceIndex": 0,
                    "RedirectInfo": {
                        "StderrRedirectFileName": "stderr.job-97zcl3wt.A.0.log",
                        "StdoutRedirectFileName": "stdout.job-97zcl3wt.A.0.log",
                        "StdoutRedirectPath": "cos://dondonbatch-1251783334.cosgz.myqcloud.com/hello2/logs/",
                        "StderrRedirectPath": "cos://dondonbatch-1251783334.cosgz.myqcloud.com/hello2/logs/"
                    },
                    "RunningTime": "2018-02-07T09:30:02Z",
                    "LaunchTime": "2018-02-07T09:29:09Z",
                    "StateReason": "",
                    "StateDetailedReason": "xx",
                    "ComputeNodeInstanceId": null,
                    "EndTime": "2018-02-07T09:30:31Z",
                    "TaskInstanceState": "SUCCEED",
                    "CreateTime": "2018-02-07T09:29:09Z",
                    "ExitCode": 0
                }
            ],
            "TaskState": "SUCCEED",
            "JobId": "job-97zcl3wt",
            "TaskInstanceMetrics": {
                "PendingCount": 0,
                "FailedCount": 0,
                "StartingCount": 0,
                "SucceedCount": 2,
                "FailedInterruptedCount": 0,
                "SubmittedCount": 0,
                "RunnableCount": 0,
                "RunningCount": 0
            },
            "TaskInstanceTotalCount": 2,
            "TaskName": "A",
            "EndTime": "2018-02-07T09:30:31Z",
            "CreateTime": "2018-02-07T09:29:09Z",
            "RequestId": "f4723b24-e080-4599-b12d-b7eb657faefe"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameter.JobIdMalformed 非法的作业ID格式。
    ResourceNotFound.Task 指定作业任务不存在。