Domain name for API request: batch.intl.tencentcloudapi.com.
This API is used to query the details of a job, including internal task (Task) and dependency (Dependence) information.
A maximum of 50 requests can be initiated per second for this API.
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: DescribeJob. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| JobId | Yes | String | Job ID |
| Parameter Name | Type | Description |
|---|---|---|
| JobId | String | Job ID |
| JobName | String | Job name |
| Zone | String | Availability zone information |
| Priority | Integer | Job priority |
| JobState | String | Job state |
| CreateTime | String | Creation Date |
| EndTime | String | End time |
| TaskSet | Array of TaskView | Task view information |
| DependenceSet | Array of Dependence | Information of the dependency among tasks |
| TaskMetrics | TaskMetrics | Task statistical metrics |
| TaskInstanceMetrics | TaskInstanceMetrics | Task instance statistical metrics |
| StateReason | String | Job failure reason |
| Tags | Array of Tag | List of tags bound with the job. Note: This field may return null, indicating that no valid value was found. |
| NextAction | String | Next action Note: This field may return null, indicating that no valid value was found. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
https://batch.intl.tencentcloudapi.com/?Action=DescribeJob
&JobId=job-97zcl3wt
&<Common request parameters>
{
"Response": {
"JobState": "SUCCEED",
"TaskSet": [
{
"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",
"CreateTime": "2018-02-07T09:29:09Z"
}
],
"Zone": "ap-guangzhou-2",
"TaskMetrics": {
"PendingCount": 0,
"FailedCount": 0,
"StartingCount": 0,
"SucceedCount": 4,
"FailedInterruptedCount": 0,
"SubmittedCount": 0,
"RunnableCount": 0,
"RunningCount": 0
},
"JobName": "test job",
"JobId": "job-97zcl3wt",
"Priority": 1,
"StateReason": "",
"TaskInstanceMetrics": {
"PendingCount": 0,
"FailedCount": 0,
"StartingCount": 0,
"SucceedCount": 4,
"FailedInterruptedCount": 0,
"SubmittedCount": 0,
"RunnableCount": 0,
"RunningCount": 0
},
"EndTime": "2018-02-07T09:33:01Z",
"DependenceSet": [
{
"StartTask": "A",
"EndTask": "B"
},
{
"StartTask": "A",
"EndTask": "C"
},
{
"StartTask": "B",
"EndTask": "D"
},
{
"StartTask": "C",
"EndTask": "D"
}
],
"CreateTime": "2018-02-07T09:29:09Z",
"Tags": [
{
"Key": "batch-test-tag-job-key",
"Value": "batch-test-tag-job-value"
}
],
"NextAction": "",
"RequestId": "d1b08863-b8ee-49d4-aa08-f464499f97a0"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
피드백