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

1. 接口描述

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

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

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

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

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
JobId String 作业ID
示例值:job-97zcl3wt
JobName String 作业名称
示例值:test job
JobDescription String 作业描述
示例值:xxx
Priority Integer 作业优先级,任务(Task)和任务实例(TaskInstance)会继承作业优先级
示例值:1
Tasks Array of Task 任务信息
Dependences Array of Dependence 依赖信息
Tags Array of Tag 作业绑定的标签列表。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

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

输出示例

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

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.Job 指定作业不存在。