查看作业详情

最近更新时间:2018-11-08 20:28:48

1. 接口描述

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

用于查看一个作业的详细信息,包括内部任务(Task)和依赖(Dependence)信息。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeJob
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
JobId String 作业标识

3. 输出参数

参数名称 类型 描述
JobId String 作业ID
JobName String 作业名称
Zone String 可用区信息
Priority Integer 作业优先级
JobState String 作业状态
CreateTime String 创建时间
EndTime String 结束时间
TaskSet Array of TaskView 任务视图信息
DependenceSet Array of Dependence 任务间依赖信息
TaskMetrics TaskMetrics 任务统计指标
TaskInstanceMetrics TaskInstanceView 任务实例统计指标
StateReason String 作业失败原因
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询作业详细信息

输入示例

https://batch.tencentcloudapi.com/?Action=DescribeJob
&JobId=job-97zcl3wt
&<公共请求参数>

输出示例

{
  "Response": {
    "CreateTime": "2018-02-07T09:29:09Z",
    "DependenceSet": [
      {
        "EndTaskName": "B",
        "StartTaskName": "A"
      },
      {
        "EndTaskName": "C",
        "StartTaskName": "A"
      },
      {
        "EndTaskName": "D",
        "StartTaskName": "B"
      },
      {
        "EndTaskName": "D",
        "StartTaskName": "C"
      }
    ],
    "EndTime": "2018-02-07T09:33:01Z",
    "JobId": "job-97zcl3wt",
    "JobName": "test job",
    "JobState": "SUCCEED",
    "Priority": 1,
    "RequestId": "d1b08863-b8ee-49d4-aa08-f464499f97a0",
    "TaskInstanceMetrics": {
      "FailedCount": 0,
      "FailedInterruptedCount": 0,
      "PendingCount": 0,
      "RunnableCount": 0,
      "RunningCount": 0,
      "StartingCount": 0,
      "SubmittedCount": 0,
      "SucceedCount": 8
    },
    "TaskMetrics": {
      "FailedCount": 0,
      "FailedInterruptedCount": 0,
      "PendingCount": 0,
      "RunnableCount": 0,
      "RunningCount": 0,
      "StartingCount": 0,
      "SubmittedCount": 0,
      "SucceedCount": 4
    },
    "TaskSet": [
      {
        "CreateTime": "2018-02-07T09:29:09Z",
        "EndTime": "2018-02-07T09:30:31Z",
        "TaskName": "A",
        "TaskState": "SUCCEED"
      },
      {
        "CreateTime": "2018-02-07T09:29:09Z",
        "EndTime": "2018-02-07T09:31:49Z",
        "TaskName": "B",
        "TaskState": "SUCCEED"
      },
      {
        "CreateTime": "2018-02-07T09:29:09Z",
        "EndTime": "2018-02-07T09:31:48Z",
        "TaskName": "C",
        "TaskState": "SUCCEED"
      },
      {
        "CreateTime": "2018-02-07T09:29:09Z",
        "EndTime": "2018-02-07T09:33:01Z",
        "TaskName": "D",
        "TaskState": "SUCCEED"
      }
    ],
    "Zone": "ap-guangzhou-2"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

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