QueryAsyncTask

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.

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
aimiaobi:QueryAsyncTask	get	All Resource ``	None	None

Action

Access level

Resource type

Condition key

Dependent action

aimiaobi:QueryAsyncTask

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AgentKey	string	Yes	Unique ID of the workspace: AgentKey	33a2658aaabf4c24b45d50e575125311_p_beebot_public
TaskId	string	No	Unique task ID The system automatically generates the TaskId by default. If subsequent tasks use the same TaskId, they belong to the same conversation group.	3f7045e099474ba28ceca1b4eb6d6e21

Response elements

Element	Type	Description	Example
	object	PlainResult
Code	string	Status code	success
Data	object	Business data
CreateTime	string	Creation date	2021-07-25 14:34:33
CreateUser	string	Creator	"12121"
TaskCode	string	Task ID, indicates the specific task.	MaterialDocumentUpload
TaskErrorMessage	string	Task execution error message	error
TaskId	string	Unique task ID	3f7045e099474ba28ceca1b4eb6d6e21
TaskIntermediateResult	string	Intermediate task execution result. When a task has multiple steps, save the output of each step here. When resuming from a pause, read the intermediate result and continue from there.	"{}"
TaskName	string	Task name	Task name
TaskParam	string	Task execution input parameters, JSON format	"{\"fileKey\":\"oss://default/xxxx/xxxx/xxx\",\"fileName\":\"xxxxx.doc\"}"
TaskProgressMessage	string	Task execution progress message	"{}"
TaskResult	string	Task execution result message	"{}"
TaskRetryCount	string	Number of task retries	"3"
TaskStatus	integer	Task execution status: 0-Pending, 1-Executing, 2-Execution successful, 3-Paused, 4-Execution failed (retryable), 5-Execution failed (not retryable), 6-Task canceled.	1
UpdateTime	string	Update date	2023-04-27 18:07:43
UpdateUser	string	Updater	"12121"
HttpStatusCode	integer	HTTP status code	200
Message	string	Error description	success
RequestId	string	Unique request ID	867C4ABE-4381-5BC2-9810-5A5F334F71CF
Success	boolean	Success status: true for success, false for failure.	true

Examples

Success response JSON format

{
  "Code": "success",
  "Data": {
    "CreateTime": "2021-07-25 14:34:33",
    "CreateUser": "\"12121\"\n",
    "TaskCode": "MaterialDocumentUpload",
    "TaskErrorMessage": "error",
    "TaskId": "3f7045e099474ba28ceca1b4eb6d6e21",
    "TaskIntermediateResult": "\"{}\"",
    "TaskName": "Task name",
    "TaskParam": "\"{\\\"fileKey\\\":\\\"oss://default/xxxx/xxxx/xxx\\\",\\\"fileName\\\":\\\"xxxxx.doc\\\"}\"",
    "TaskProgressMessage": "\"{}\"",
    "TaskResult": "\"{}\"",
    "TaskRetryCount": "\"3\"",
    "TaskStatus": 1,
    "UpdateTime": "2023-04-27 18:07:43",
    "UpdateUser": "\"12121\""
  },
  "HttpStatusCode": 200,
  "Message": "success",
  "RequestId": "867C4ABE-4381-5BC2-9810-5A5F334F71CF",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

​Try it now

​RAM authorization

​Request parameters

​Response elements

​Examples

​Error codes