GetJobStatus-阿里云帮助中心

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:GetJobStatus

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	Yes	The ID of the asynchronous task that is generated after you call an asynchronous operation.	70ecdaec-bf21-4c11-8ecb-4f77453ceea8

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	5E2BFE96-C0E0-5A98-85C8-633EC803198D
JobStatus	object	The real-time status information of the asynchronous task.
JobId	string	The ID of the asynchronous task.	C664CDE3-9C0B-5792-B17F-6C543783BBBC
JobType	string	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
Completed	string	Indicates whether the asynchronous task is complete. Valid values: True False	False
Status	string	The status of the asynchronous task. Valid values: Success Fail Cancel Running	Success
Error	string	The error message returned if the asynchronous task fails.	Not Found
CreateTime	string	The time when the asynchronous task was created.	1729063449802

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.