查询符合条件的一个或多个容器集群。
接口说明
仅用于阿里云容器服务 Kubernetes 版集成使用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| hbr:DescribeContainerCluster | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PageNumber | integer | 否 | 分页页码，从 1 开始，默认值为 1。 | 1 |
| PageSize | integer | 否 | 分页大小，最小值为 1，最大值为 99，默认值为 10。 | 10 |
| ClusterId | string | 否 | 集群 ID。 | cc-000**************hg9 |
| Identifier | string | 否 | 容器集群标识符，对于阿里云容器服务 Kubernetes 集群，该参数指 Kubernetes 集群 ID。 | cca***************************87a |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "CC94B755-C3C2-5B9D-BD77-E0FE819A4DB2",
"Success": true,
"Code": "200",
"Message": "successful",
"PageSize": 100,
"PageNumber": 1,
"TotalCount": 8,
"Clusters": [
{
"Token": "eyJhY2Nvd******A/VnZpgXQC5A==",
"Description": "description ack pv backup",
"ClusterType": "ACK",
"Identifier": "c5bbd0931a30947f4ab85efd19380a72d",
"NetworkType": "VPC",
"Name": "ack_pv_backup_location",
"AgentStatus": "READY",
"ClusterId": "cl-0006gwppd0jtttpmb0ri"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-04-21 | OpenAPI 入参发生变更 | 查看变更详情 |