All Products
Search
Document Center

DataWorks:GetJobStatus

Last Updated:Dec 05, 2024

Queries the status information of an asynchronous task. After you call an asynchronous operation, an asynchronous task is generated. You can call the GetJobStatus operation to query the status of the asynchronous task.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdstringYes

The ID of the asynchronous task that is generated after you call an asynchronous operation.

70ecdaec-bf21-4c11-8ecb-4f77453ceea8

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

5E2BFE96-C0E0-5A98-85C8-633EC803198D
JobStatusobject

The real-time status information of the asynchronous task.

JobIdstring

The ID of the asynchronous task.

C664CDE3-9C0B-5792-B17F-6C543783BBBC
JobTypestring

The type of the asynchronous task. Valid values:

  • Create: The asynchronous task is used to create an object.
  • Update: The asynchronous task is used to update an object.
  • Cancel: The asynchronous task is used to cancel an operation.
Create
Completedstring

Indicates whether the asynchronous task is complete. Valid values: True False

False
Statusstring

The status of the asynchronous task. Valid values:

  • Success
  • Fail
  • Cancel
  • Running
Success
Errorstring

The error message returned if the asynchronous task fails.

Not Found
CreateTimestring

The time when the asynchronous task was created.

1729063449802

Examples

Sample success responses

JSONformat

{
  "RequestId": "5E2BFE96-C0E0-5A98-85C8-633EC803198D",
  "JobStatus": {
    "JobId": "C664CDE3-9C0B-5792-B17F-6C543783BBBC",
    "JobType": "Create",
    "Completed": "False",
    "Status": "Success",
    "Error": "Not Found",
    "CreateTime": "1729063449802"
  }
}

Error codes

For a list of error codes, visit the Service error codes.