All Products
Search
Document Center

DataWorks:GetJobStatus

Last Updated:Jan 12, 2026

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:GetJobStatusget
*All Resources
*
    none
none

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.

Change history

Change timeSummary of changesOperation
No change history