ListClusters - 获取当前用户纳管集群列表 - Alibaba Cloud Linux

获取当前用户所有已纳管的集群

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

sysom:ListClusters

list

*全部资源

*

无

请求语法

GET /api/v1/am/cluster/list_clusters HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
current	integer	否	当前页数（从第 1 页开始）	1
pageSize	integer	否	每页大小	10
name	string	否	通过插件的名字过滤插件	proxy-next-upstream
cluster_id	string	否	通过集群 ID 过滤说明这个集群 ID 不是 ACK 集群 ID，而是通过本接口返回的数据里面的 `id` 字段	cb7d4cc26c8f845fb8a8255ffd394820e
cluster_status	string	否	`Running` : 集群纳管正常； `Installing`: 集群有安装任务正在进行； `Uninstalling`: 集群有卸载任务正在进行； `Upgrading`: 集群有更新任务正在进行； `Offline`: 集群离线，纳管异常。	Running
cluster_type	string	否	`ACK`: ACK 集群 `CUSTOM`: 自定义集群（默认集群属于自定义集群）	ACK
id	string	否	本字段已废弃，请使用 cluster_id 字段过滤	cb7d4cc26c8f845fb8a8255ffd394820e

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID，可用于全链路诊断	B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7
code	string	状态码 `code == Success` 则代表授权成功；其它状态码代表授权失败，授权失败时查看 `message` 字段获取详细的错误信息；	Success
data	array<object>	返回数据
	object	返回数据。
cluster_id	string	实际集群 ID。说明对于 `ACK` 类型的集群，这个集群 ID 为 ACK 集群的 ID；对于 `CUSTOM` 类型的集群，这个集群 ID 作为唯一标识，没有其它额外含义。	c666d4774f0e2440b979bf917bf100e40
cluster_status	string	`Running` : 集群纳管正常； `Installing`: 集群有安装任务正在进行； `Uninstalling`: 集群有卸载任务正在进行； `Upgrading`: 集群有更新任务正在进行； `Offline`: 集群离线，纳管异常。	Running
cluster_type	string	`ACK`: ACK 集群 `CUSTOM`: 自定义集群（默认集群属于自定义集群）	ACK
created_at	string	创建时间	2024-12-25T15:08:19
id	string	集群 ID	5389fba5-92a1-4ff4-9b26-773b97828144
name	string	集群名称	auto-name-sbvCT
region	string	地域 ID。	cn-hangzhou
updated_at	string	更新时间	2024-12-25T15:08:19
message	string	错误信息如果 `code == Success`，则本字段为空；否则本字段包含请求错误信息。	success
total	integer	总记录数	64

示例

正常返回示例

JSON格式

{
  "RequestId": "B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7",
  "code": "Success",
  "data": [
    {
      "cluster_id": "c666d4774f0e2440b979bf917bf100e40",
      "cluster_status": "Running",
      "cluster_type": "ACK",
      "created_at": "2024-12-25T15:08:19",
      "id": "5389fba5-92a1-4ff4-9b26-773b97828144",
      "name": "auto-name-sbvCT",
      "region": "cn-hangzhou",
      "updated_at": "2024-12-25T15:08:19"
    }
  ],
  "message": "success",
  "total": 64
}

错误码

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

变更历史

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