Query Task Details via GetTask API for Workflow Automation - Cloud Architect Design Tools - Alibaba Cloud - Cloud Architect Design Tools

Retrieves information about a 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

bpstudio:GetTask

get

*BPStudioVirtual

acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	No	The ID of the task.	2615

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	A07FFDF2-78FA-1B48-9E38-88E833A93187
Message	string	The error message.	Success
Data	object	The details of the task.
Id	integer	The ID of the task.	1333
Name	string	The name of the task.	test_name
ProcessId	string	The flow ID.	64QQBC02**FA3W3G
AppId	string	The application ID.	JXT**LZJ568665D6
InstanceIds	string	The ID of the attached application.	{\"app\":\"JJXT**LZJ568665D6\"}
ErrorMessage	string	The error message.	SyntaxError
Status	string	FINISH: The task is complete. BINDING: The application is being attached.	FINISH
GmtCreate	string	The time when the task was created.	2025-08-21 14:07:02
Code	integer	The return code.	200

Examples

Success response

JSON format

{
  "RequestId": "A07FFDF2-78FA-1B48-9E38-88E833A93187",
  "Message": "Success",
  "Data": {
    "Id": 1333,
    "Name": "test_name",
    "ProcessId": "64QQBC02**FA3W3G",
    "AppId": "JXT**LZJ568665D6",
    "InstanceIds": "{\\\"app\\\":\\\"JJXT**LZJ568665D6\\\"}",
    "ErrorMessage": "SyntaxError",
    "Status": "FINISH ",
    "GmtCreate": "2025-08-21 14:07:02"
  },
  "Code": 200
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermissions	No permissions.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.