DescribeBatchTasks-阿里云帮助中心

Queries the status of batch tasks.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
TaskType	string	No	The type of the batch task.	polarclaw_install_skills
Status	array	No	The task statuses. Note If you omit this parameter, the operation returns tasks of all statuses.
	string	No	The task status. Valid values: COMPLETED : The task is completed. DISPATCHING : The task is being dispatched. FAILED : The task failed. RUNNING : The task is running.	RUNNING
StartTime	string	No	The start time of the query range. Specify the time in UTC format.	2026-04-06T20:51:40Z
EndTime	string	No	The end time of the query range. Specify the time in UTC format.	2026-04-06T20:52:40Z
PageSize	integer	No	The number of entries to return on each page.	30
PageNumber	integer	No	The page number. The value must be a positive integer. The default is 1.	1

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	925B84D9-CA72-432C-95CF-738C22******
TaskList	array<object>	The task list.
	object	The details of a task.
BatchId	string	The batch ID.	pcb-xxx
TaskName	string	The task name.	batch_task_test
TaskType	string	The task type.	polarclaw_install_skills
Status	string	The task status.	RUNNING
TotalCount	integer	The total number of subtasks in the batch.	8
SuccessCount	integer	The number of successfully completed subtasks in the batch.	4
TaskBegin	string	The task start time.	2026-04-06 20:51:44
TaskEnd	string	The task end time.	2026-04-06 22:43:26
TotalCount	integer	The total number of tasks that match the query, ignoring pagination.	6
PageSize	integer	The number of entries returned per page.	30
PageNumber	integer	The page number of the returned results.	1

Examples

Success response

JSON format

{
  "RequestId": "925B84D9-CA72-432C-95CF-738C22******",
  "TaskList": [
    {
      "BatchId": "pcb-xxx",
      "TaskName": "batch_task_test",
      "TaskType": "polarclaw_install_skills",
      "Status": "RUNNING",
      "TotalCount": 8,
      "SuccessCount": 4,
      "TaskBegin": "2026-04-06 20:51:44",
      "TaskEnd": "2026-04-06 22:43:26"
    }
  ],
  "TotalCount": 6,
  "PageSize": 30,
  "PageNumber": 1
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.