All Products
Search

This Product

    PolarDB:DescribeBatchTasks

    Document Center

    PolarDB:DescribeBatchTasks

    Last Updated:Sep 24, 2026

    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

    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:DescribeBatchTasks

    none

    *All Resource

    *

    		 None None

    Request syntax

    POST  HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    TaskType

    string

    No

    The batch task type.

    polarclaw_install_skills
    Status

    array

    No

    The list of task statuses.

    Note

    If this parameter is left empty, scheduled tasks in all statuses are queried by default.

    string

    No

    The task status.

    Valid values:

    • COMPLETED :

      Completed.

    • DISPATCHING :

      Dispatching.

    • FAILED :

      Failed.

    • RUNNING :

      Running.

    RUNNING
    StartTime

    string

    No

    The start of the creation time range.

    The time is in ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).

    2026-04-06T20:51:40Z
    EndTime

    string

    No

    The end of the creation time range.

    The time is in ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).

    2026-04-06T20:52:40Z
    PageSize

    integer

    No

    The number of records per page.

    30
    PageNumber

    integer

    No

    The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1.

    1

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    Id of the request

    925B84D9-CA72-432C-95CF-738C22******
    TaskList

    array<object>

    The task information.

    object

    The list of subtasks.

    BatchId

    string

    The batch task ID.

    pcb-xxx
    TaskName

    string

    The description of the model service.

    batch_task_test
    TaskType

    string

    The task type.

    polarclaw_install_skills
    Status

    string

    The task status.

    RUNNING
    TotalCount

    integer

    The total number of tasks that meet the filter conditions, regardless of pagination.

    8
    SuccessCount

    integer

    The number of successful batch tasks.

    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 meet the filter conditions, regardless of pagination.

    6
    PageSize

    integer

    The number of records per page.

    30
    PageNumber

    integer

    The page number.

    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.