tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeJobSubmitInfo

Last updated: 2023-05-04 15:47:08

1. API Description

Domain name for API request: batch.tencentcloudapi.com.

This API is used to query the submission information of the specified job, with the return including the job submission information used as input parameters in the JobId and SubmitJob APIs.

A maximum of 2 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeJobSubmitInfo.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
JobId Yes String Job ID

3. Output Parameters

Parameter Name Type Description
JobId String Job ID
JobName String Job name
JobDescription String Job description
Priority Integer Job priority. Tasks (Task) and task instances (TaskInstance) inherit the job priority
Tasks Array of Task Information of tasks in the job
Dependences Array of Dependence Dependency information
Tags Array of Tag List of tags bound with the job.
Note: This field may return null, indicating that no valid value was found.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining job submission information

Input Example

https://batch.tencentcloudapi.com/?Action=DescribeJobSubmitInfo
&JobId=job-97zcl3wt
&<Common request parameters>

Output Example

{
    "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InvalidParameter.JobIdMalformed Invalid job ID format.
ResourceNotFound.Job The specified job does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy