DescribeClusterTasks - 查询集群任务列表

您可以调用DescribeClusterTasks接口,查询集群下的任务列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cs:DescribeClusterTasksget
*Cluster
acs:cs:{#regionId}:{#accountId}:cluster/{#cluster_id}

请求语法

GET /clusters/{cluster_id}/tasks HTTP/1.1

请求参数

名称类型必填描述示例值
cluster_idstring

集群 id。

c23421cfa74454bc8b37163fd19af****
page_sizeinteger

每页显示数量。

20
page_numberinteger

当前页码。

1

返回参数

名称类型描述示例值
object

Schema of Response

page_infoobject

分页信息。

page_sizelong

每页数量。

10
page_numberlong

页数。

1
total_countlong

结果总数。

10
tasksarray<object>

任务数组。

taskobject

任务详情。

task_idstring

任务 ID。

install-addons-c3xxxxxx
task_typestring

任务类型。

cluster_addon_install
statestring

任务状态。

success
createdstring

创建时间。

2022-08-03T10:11:33+08:00
updatedstring

更新时间。

2022-08-03T10:12:03.482+08:00
errorobject

任务错误信息。

messagestring

错误信息。

Addon status not match
codestring

错误码。

BadRequest
requestIdstring

请求 ID。

0527ac9a-c899-4341-a21a-xxxxxxxxx

示例

正常返回示例

JSON格式

{
  "page_info": {
    "page_size": 10,
    "page_number": 1,
    "total_count": 10
  },
  "tasks": [
    {
      "task_id": "install-addons-c3xxxxxx",
      "task_type": "cluster_addon_install",
      "state": "success",
      "created": "2022-08-03T10:11:33+08:00",
      "updated": "2022-08-03T10:12:03.482+08:00",
      "error": {
        "message": "Addon status not match",
        "code": "BadRequest"
      }
    }
  ],
  "requestId": "0527ac9a-c899-4341-a21a-xxxxxxxxx"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-11-23OpenAPI 入参发生变更查看变更详情
2022-08-03新增 OpenAPI查看变更详情