DescribeContainerCluster - Cloud Backup - Alibaba Cloud Documentation Center

Queries one or more container clusters that meet the specified conditions.

Operation description

You can call this operation to query only Container Service for Kubernetes (ACK) clusters.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 99. Default value: 10.	10
ClusterId	string	No	The ID of the cluster.	cc-000*************hg9
Identifier	string	No	The identifier of container cluster.	cca*******************************87a

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	CC94B755-C3C2-5B9D-BD77-E0FE819A4DB2
Success	boolean	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call fails.	true
Code	string	The HTTP status code. The status code 200 indicates that the call is successful.	200
Message	string	The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.	successful
PageSize	integer	The number of entries returned on each page. Valid values: 1 to 99. Default value: 10.	100
PageNumber	integer	The page number of the returned page. Pages start from page 1. Default value: 1.	1
TotalCount	long	The total number of returned entries.	8
Clusters	object []	The information of clusters.
Token	string	The token that is used to register the Hybrid Backup Recovery (HBR) client in the cluster.	eyJhY2Nvd******A/VnZpgXQC5A==
Description	string	The description.	description ack pv backup
ClusterType	string	The type of the cluster. Valid value: ACK, which indicates ACK clusters.	ACK
Identifier	string	The identifier of the cluster.	c5bbd0931a30947f4ab85efd19380a72d
NetworkType	string	The network type of the cluster. Valid values: CLASSIC: the classic network VPC: virtual private cloud (VPC)	VPC
Name	string	The name of the instance.	ack_pv_backup_location
AgentStatus	string	The status of the client. Valid values: MISS: The client is disconnected. UNKNOWN: The client is in an unknown state. READY: The client is ready.	READY
ClusterId	string	The ID of the cluster.	cl-0006gwppd0jtttpmb0ri

Examples

Sample success responses

JSONformat

{
  "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"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-04-21

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: Identifier