DescribeContainerCluster - 查询容器集群 - 混合云备份 HBR

查询符合条件的一个或多个容器集群。

接口说明

仅用于阿里云容器服务Kubernetes版集成使用。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	否	分页页码，从1开始，默认值为1。	1
PageSize	integer	否	分页大小，最小值为1，最大值为99，默认值为10。	10
ClusterId	string	否	集群ID。	cc-0007xt00u1q2lownbhg9

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求ID。	CC94B755-C3C2-5B9D-BD77-E0FE819A4DB2
Success	boolean	请求是否成功。 true：成功 false：失败	true
Code	string	返回码。200表示成功。	200
Message	string	返回信息描述，成功一般返回successful，错误时会返回相应错误信息。	successful
PageSize	integer	分页大小。最小值为1，最大值为99，默认值为10。	100
PageNumber	integer	分页页码，从1开始，默认值为1。	1
TotalCount	long	总记录数。	8
Clusters	array	集群列表信息。
	object	集群列表信息。
Token	string	集群token，用于集群中hbr客户端注册使用。	eyJhY2Nvd******A/VnZpgXQC5A==
Description	string	描述信息。	description ack pv backup
ClusterType	string	集群类型，仅支持ACK，表示阿里云容器服务Kubernetes版中的容器集群。	ACK
Identifier	string	集群标识。	c5bbd0931a30947f4ab85efd19380a72d
NetworkType	string	网络类型，返回值包括： CLASSIC：经典网络。 VPC：专有网络。	VPC
Name	string	集群名称。	ack_pv_backup_location
AgentStatus	string	客户端状态： MISS：失联。 UNKNOWN：未知。 READY：就绪。	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"
    }
  ]
}

错误码

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