获取作业的提交信息

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

1. 接口描述

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

用于查询指定作业的提交信息,其返回内容包括 JobId 和 SubmitJob 接口中作为输入参数的作业提交信息

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

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
JobId String 作业ID
JobName String 作业名称
JobDescription String 作业描述
Priority Integer 作业优先级,任务(Task)和任务实例(TaskInstance)会继承作业优先级
Tasks Array of Task 任务信息
Dependences Array of Dependence 依赖信息
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取作业的提交信息

输入示例

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

输出示例

{
  "Response": {
    "Dependences": [
      {
        "EndTask": "B",
        "StartTask": "A"
      },
      {
        "EndTask": "C",
        "StartTask": "A"
      },
      {
        "EndTask": "D",
        "StartTask": "B"
      },
      {
        "EndTask": "D",
        "StartTask": "C"
      }
    ],
    "JobDescription": "xxx",
    "JobId": "job-97zcl3wt",
    "JobName": "test job",
    "Priority": 1,
    "RequestId": "1a69db97-95ff-4bf7-9eb2-875ea6e5737b",
    "Tasks": [
      {
        "Application": {
          "Command": "python -c \"fib=lambda n:1 if n&lt=2 else fib(n-1)+fib(n-2); print(fib(20))\" ",
          "DeliveryForm": "LOCAL"
        },
        "ComputeEnv": {
          "EnvData": {
            "ImageId": "img-bd78fy2t",
            "InstanceType": "S1.SMALL1"
          },
          "EnvType": "MANAGED"
        },
        "FailedAction": "TERMINATE",
        "MaxRetryCount": 0,
        "RedirectInfo": {
          "StderrRedirectPath": "cos://bucket-appid..cosgz.myqcloud.com/hello2/logs/",
          "StdoutRedirectPath": "cos://bucket-appid.cosgz.myqcloud.com/hello2/logs/"
        },
        "TaskInstanceNum": 2,
        "TaskName": "A"
      },
      {
        "Application": {
          "Command": "python -c \"fib=lambda n:1 if n&lt=2 else fib(n-1)+fib(n-2); print(fib(20))\" ",
          "DeliveryForm": "LOCAL"
        },
        "ComputeEnv": {
          "EnvData": {
            "ImageId": "img-bd78fy2t",
            "InstanceType": "S1.SMALL1"
          },
          "EnvType": "MANAGED"
        },
        "FailedAction": "TERMINATE",
        "MaxRetryCount": 0,
        "RedirectInfo": {
          "StderrRedirectPath": "cos://bucket-appid.cosgz.myqcloud.com/hello2/logs/",
          "StdoutRedirectPath": "cos://bucket-appid.cosgz.myqcloud.com/hello2/logs/"
        },
        "TaskInstanceNum": 2,
        "TaskName": "B"
      },
      {
        "Application": {
          "Command": "python -c \"fib=lambda n:1 if n&lt=2 else fib(n-1)+fib(n-2); print(fib(20))\" ",
          "DeliveryForm": "LOCAL"
        },
        "ComputeEnv": {
          "EnvData": {
            "ImageId": "img-bd78fy2t",
            "InstanceType": "S1.SMALL1"
          },
          "EnvType": "MANAGED"
        },
        "FailedAction": "TERMINATE",
        "MaxRetryCount": 0,
        "RedirectInfo": {
          "StderrRedirectPath": "cos://bucket-appid.cosgz.myqcloud.com/hello2/logs/",
          "StdoutRedirectPath": "cos://bucket-appid.cosgz.myqcloud.com/hello2/logs/"
        },
        "TaskInstanceNum": 2,
        "TaskName": "C"
      },
      {
        "Application": {
          "Command": "python -c \"fib=lambda n:1 if n&lt=2 else fib(n-1)+fib(n-2); print(fib(20))\" ",
          "DeliveryForm": "LOCAL"
        },
        "ComputeEnv": {
          "EnvData": {
            "ImageId": "img-bd78fy2t",
            "InstanceType": "S1.SMALL1"
          },
          "EnvType": "MANAGED"
        },
        "FailedAction": "TERMINATE",
        "MaxRetryCount": 0,
        "RedirectInfo": {
          "StderrRedirectPath": "cos://bucket-appid.cosgz.myqcloud.com/hello2/logs/",
          "StdoutRedirectPath": "cos://bucket-appid.cosgz.myqcloud.com/hello2/logs/"
        },
        "TaskInstanceNum": 2,
        "TaskName": "D"
      }
    ]
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

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