DescribeBatchTask-阿里云帮助中心

Queries the status of a batch 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

polardb:DescribeBatchTask

none

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
BatchId	string	No	The ID of the batch task.	pcb-xxx

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB
BatchId	string	The ID of the batch task.	pcb-xxx
TaskName	string	The name of the task.	batch_task_test
TaskType	string	The type of the task.	polarclaw_install_skills
Status	string	The task status. Valid values: COMPLETED : The task is completed. DISPATCHING : The task is being dispatched. FAILED : The task has failed. RUNNING : The task is running.	RUNNING
TotalCount	integer	The total number of subtasks.	10
SuccessCount	integer	The number of successful subtasks.	8
TaskBegin	string	The time when the task started.	2026/05/28T16:38:20Z
TaskEnd	string	The time when the task ended.	2026/05/28T15:23:47Z
SubTasks	array<object>	A list of subtasks.
	object	A subtask.
TaskId	string	The ID of the subtask.	629271331
InstanceId	string	The instance ID.	pc-pz5f6mvi1p84t35d7
Status	string	The status of the subtask. Valid values: COMPLETED : The subtask is completed. FAILED : The subtask has failed. PAUSE : The subtask is paused. RUNNING : The subtask is running. TEMP_TERMINATED : The subtask is temporarily terminated. WAITING : The subtask is waiting to be executed. HUMAN_PROCESSING : The subtask is being manually processed. BLOCKING : The subtask is blocked.	COMPLETED
TaskBegin	string	The time when the subtask started.	2026/05/28T17:38:20Z
TaskEnd	string	The time when the subtask ended.	2026/05/28T20:38:20Z
ErrorMsg	string	The error message.	aliuid:1422133474238823 assumeOssRole not exist,serviceName:aliyunesarealtimelogpushossrole
ApplicationType	string

Examples

Success response

JSON format

{
  "RequestId": "25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB",
  "BatchId": "pcb-xxx",
  "TaskName": "batch_task_test",
  "TaskType": "polarclaw_install_skills",
  "Status": "RUNNING ",
  "TotalCount": 10,
  "SuccessCount": 8,
  "TaskBegin": "2026/05/28T16:38:20Z",
  "TaskEnd": "2026/05/28T15:23:47Z",
  "SubTasks": [
    {
      "TaskId": "629271331",
      "InstanceId": "pc-pz5f6mvi1p84t35d7",
      "Status": "COMPLETED",
      "TaskBegin": "2026/05/28T17:38:20Z",
      "TaskEnd": "2026/05/28T20:38:20Z",
      "ErrorMsg": "aliuid:1422133474238823 assumeOssRole not exist,serviceName:aliyunesarealtimelogpushossrole"
    }
  ],
  "ApplicationType": ""
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.