DescribeContainerCluster API for ACK Clusters - Cloud Backup - Alibaba Cloud - Cloud Backup

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

Operation description

Supported only for Container Service for Kubernetes (ACK) integration.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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 cluster ID.	cc-000*************hg9
Identifier	string	No	The identifier of the container cluster. For a Container Service for Kubernetes (ACK) cluster, specify the cluster ID.	cca*******************************87a

Response elements

Element	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	integer	The total number of returned entries.	8
Clusters	array<object>	The information of 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 cluster name.	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

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.