查询符合条件的一个或多个容器集群。
接口说明
仅用于阿里云容器服务 Kubernetes 版集成使用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PageNumber |
integer |
否 |
分页页码，从 1 开始，默认值为 1。 |
1 |
| PageSize |
integer |
否 |
分页大小，最小值为 1，最大值为 99，默认值为 10。 |
10 |
| ClusterId |
string |
否 |
集群 ID。 |
cc-000**************hg9 |
| Identifier |
string |
否 |
容器集群标识符，对于阿里云容器服务 Kubernetes 集群，该参数指 Kubernetes 集群 ID。 |
cca***************************87a |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
CC94B755-C3C2-5B9D-BD77-E0FE819A4DB2 |
| Success |
boolean |
请求是否成功。
|
true |
| Code |
string |
返回码。200 表示成功。 |
200 |
| Message |
string |
返回信息描述，成功一般返回 successful，错误时会返回相应错误信息。 |
successful |
| PageSize |
integer |
分页大小。最小值为 1，最大值为 99，默认值为 10。 |
100 |
| PageNumber |
integer |
分页页码，从 1 开始，默认值为 1。 |
1 |
| TotalCount |
integer |
总记录数。 |
8 |
| Clusters |
array<object> |
集群列表信息。 |
|
|
object |
集群列表信息。 |
||
| Token |
string |
集群 token，用于集群中 hbr 客户端注册使用。 |
eyJhY2Nvd******A/VnZpgXQC5A== |
| Description |
string |
描述信息。 |
description ack pv backup |
| ClusterType |
string |
集群类型，仅支持 ACK，表示阿里云容器服务 Kubernetes 版中的容器集群。 |
ACK |
| Identifier |
string |
集群标识。 |
c5bbd0931a30947f4ab85efd19380a72d |
| NetworkType |
string |
网络类型，返回值包括：
|
VPC |
| Name |
string |
集群名称。 |
ack_pv_backup_location |
| AgentStatus |
string |
客户端状态：
|
READY |
| ClusterId |
string |
集群 ID。 |
cl-0006gwppd0jtttpmb0ri |
示例
正常返回示例
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"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。