GetAIWorkflowTask-阿里云帮助中心

Retrieves the details of a workflow 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

ice:GetAIWorkflowTask

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	No	The ID of the workflow task.	******-266c-4bb8-b20c-6faa******

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	****11-DB8D-4A9A-875B-275798****
WorkflowTask	object	The information about the workflow task.
TaskId	string	The ID of the workflow task.	******-67fd-43aa-9cc1-3e7f******
Status	string	The task state. Valid values: running stopped failed partial-succeeded succeeded Valid values: running : stopped : failed : partial-succeeded : succeeded :	succeeded
Inputs	string	The input parameters of the workflow task.	{\"source_language_id\":\"en\",\"live_id\":123,\"live_url\":{\"url\":\"rtmp://test.com.cn/video/638d9088fe4f15ce\"}}
CreateTime	string	The time when the task was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2025-07-28T02:17:26Z
FinishTime	string	The time when the task was complete. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2025-08-19T02:28:22Z
Workflow	object	The workflow template information.
WorkflowId	string	The ID of the workflow template.	**3f44-f1f6-477e-9364-c5e6c49e**
Name	string	The name of the workflow template.	RealtimeTranslation
Status	string	Workflow template status. Valid values: Draft Published Editing	Draft
Type	string	The scenario type of the template.	Live
CreateTime	string	The time when the template was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2025-08-20T01:35:04Z
ModifiedTime	string	The time when the template was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2025-08-20T01:35:04Z
Version	string	The template version.	**ec0a-e3b9-40b1-abf2-6549d00e**
Graph	string	The workflow's topological structure.	{ "nodes":[...], "edges":[...] }
NodeResults	string	The results of the workflow nodes. The structure of this JSON varies based on the workflow's configuration.	{...}
UserData	string	The user-defined data.	{"NotifyAddress":"http://xx.xx.xxx"}
Outputs	string	The node output.	{ "result":"test" }
Version	string	The version of the workflow template that was executed.	**ec0a-e3b9-40b1-abf2-6549d00e**

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "WorkflowTask": {
    "TaskId": "********-67fd-43aa-9cc1-3e7f********",
    "Status": "succeeded",
    "Inputs": "{\\\"source_language_id\\\":\\\"en\\\",\\\"live_id\\\":123,\\\"live_url\\\":{\\\"url\\\":\\\"rtmp://test.com.cn/video/638d9088fe4f15ce\\\"}}",
    "CreateTime": "2025-07-28T02:17:26Z",
    "FinishTime": "2025-08-19T02:28:22Z",
    "Workflow": {
      "WorkflowId": "****3f44-f1f6-477e-9364-c5e6c49e****",
      "Name": "RealtimeTranslation",
      "Status": "Draft",
      "Type": "Live",
      "CreateTime": "2025-08-20T01:35:04Z",
      "ModifiedTime": "2025-08-20T01:35:04Z",
      "Version": "****ec0a-e3b9-40b1-abf2-6549d00e****",
      "Graph": "{\n\"nodes\":[...],\n\"edges\":[...]\n}"
    },
    "NodeResults": "{...}",
    "UserData": "{\"NotifyAddress\":\"http://xx.xx.xxx\"}",
    "Outputs": "{\n\"result\":\"test\"\n}",
    "Version": "****ec0a-e3b9-40b1-abf2-6549d00e****"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.