DescribeBatchTasks - 查询批量任务状态

更新时间:
复制 MD 格式

查询批量任务状态。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeBatchTasks

none

*全部资源

*

无 无

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

TaskType

string

否

批量任务类型

polarclaw_install_skills

Status

array

否

任务状态列表

说明

若该参数留空,默认查询所有状态的计划任务。

string

否

任务状态

枚举值:

  • COMPLETED :

    已完成

  • DISPATCHING :

    调度中

  • FAILED :

    失败

  • RUNNING :

    运行中

RUNNING

StartTime

string

否

创建时间开始点

时间采用 ISO 8601 格式,时区为 UTC(格式:YYYY-MM-DDTHH:mm:ssZ)。

2026-04-06T20:51:40Z

EndTime

string

否

创建时间结束点

时间采用 ISO 8601 格式,时区为 UTC(格式:YYYY-MM-DDTHH:mm:ssZ)。

2026-04-06T20:52:40Z

PageSize

integer

否

每页记录数。

30

PageNumber

integer

否

页码,取值为大于 0 且不超过 Integer 数据类型的最大值,默认值为 1。

1

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

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

TaskList

array<object>

任务情况

object

子任务列表

BatchId

string

批量任务 id

pcb-xxx

TaskName

string

模型服务描述

batch_task_test

TaskType

string

任务类型

polarclaw_install_skills

Status

string

任务状态

RUNNING

TotalCount

integer

不考虑分页因素,满足这些限制条件的总任务数。

8

SuccessCount

integer

批量任务成功数量。

4

TaskBegin

string

任务开始时间

2026-04-06 20:51:44

TaskEnd

string

任务结束时间

2026-04-06 22:43:26

TotalCount

integer

不考虑分页因素,满足这些限制条件的总任务数。

6

PageSize

integer

每页记录数

30

PageNumber

integer

页码。

1

示例

正常返回示例

JSON格式

{
  "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
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。