DescribeAckClusters - Cloud Firewall - Alibaba Cloud Documentation Center

Queries for Container Service for Kubernetes (ACK) clusters based on specified conditions, such as cluster type and specifications.

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
RegionNo	string	Yes	The region ID of the ACK cluster.	cn-hangzhou
MemberUid	string	No	The Alibaba Cloud UID of the account to which the ACK cluster resources belong.	135809047715****
PageSize	string	Yes	The number of entries per page.	10
PageNo	string	Yes	The page number.	1
ClusterId	string	No	The ID of the ACK cluster.	cb0f5640b1b2d404cad6ba21509d7847b
ClusterName	string	No	The name of the ACK cluster.	ack-cluster-name
ClusterSpec	string	No	The specification of the ACK cluster. Valid values: ack.pro.small : ACK Pro Edition cluster	ack.pro.small
ConnectorStatus	string	No	The status of the ACK cluster connector.	ready

Response elements

Element	Type	Description	Example
	object
Clusters	array<object>	A list of ACK clusters.
	object	An ACK cluster.
MemberUid	string	The Alibaba Cloud UID of the account to which the ACK cluster resources belong.	135809047715****
RegionId	string	The region ID of the ACK cluster.	cn-hangzhou
ClusterId	string	The ID of the ACK cluster.	cb0f5640b1b2d404cad6ba21509d7847b
ClusterName	string	The name of the ACK cluster.	ack-cluster-name
ClusterType	string	The type of the ACK cluster. For more information about the valid values, see DescribeClustersV1. DescribeClustersV1: Returns a list of ACK clusters in your account that meet specific criteria, such as the cluster type and specifications. Valid values: ExternalKubernetes : A registered cluster. ManagedKubernetes : An ACK managed cluster. This includes ACK managed clusters (Pro and Basic editions), ACK Serverless clusters (Pro and Basic editions), ACK Edge clusters (Pro and Basic editions), and LINGJUN Clusters (Pro Edition). Kubernetes : An ACK dedicated cluster.	ManagedKubernetes
Profile	string	The subtype of the cluster. This parameter is available only when `ClusterType` is set to `ManagedKubernetes`. For more information about the valid values, see DescribeClustersV1. DescribeClustersV1: Lists ACK clusters in your account that meet specified conditions, such as cluster type and specifications. Valid values: Lingjun : A LINGJUN Cluster, which is available in Pro Edition. Serverless : An ACK Serverless cluster. This includes ACK Serverless Pro Edition and ACK Serverless Basic Edition clusters. Default : An ACK managed cluster. This includes ACK Pro Edition and ACK Basic Edition clusters. Edge : An ACK Edge cluster. This includes ACK Edge Pro Edition and ACK Edge Basic Edition clusters.	Default
VpcId	string	The ID of the VPC where the ACK cluster is deployed.	vpc-2vcg932hsxsxuqbgl****
Network	string	The network plugin of the ACK cluster. For more information about the valid values, see DescribeClustersV1. DescribeClustersV1: Lists the ACK clusters in your account that meet specified conditions, such as cluster type and specifications. Valid values: terway-eniip : Terway-eniip Flannel : Flannel	terway-eniip
ClusterSpec	string	The specification of the ACK cluster. Valid values: ack.pro.small : ACK Pro Edition cluster	ack.pro.small
State	string	The running status of the ACK cluster. For more information about the valid values, see DescribeClustersV1. DescribeClustersV1: Retrieves a list of ACK clusters in your account that meet specified conditions, such as cluster type and specifications. Valid values: running : The cluster is running. scaling : The cluster is being scaled. stopped : The cluster is stopped. upgrading : The cluster is being upgraded. updating : The cluster configuration is being updated. deleting : The cluster is being deleted. deleted : The cluster is deleted. initial : The cluster is being created. draining : A node is being drained. delete_failed : The cluster failed to be deleted. failed : The cluster failed to be created. removing : A node is being removed.	running
PageNo	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	C5DDD596-1191-5F36-A504-8733045A****
TotalCount	integer	The total number of entries.	1

Examples

Success response

JSON format

{
  "Clusters": [
    {
      "MemberUid": "135809047715****",
      "RegionId": "cn-hangzhou",
      "ClusterId": "cb0f5640b1b2d404cad6ba21509d7847b",
      "ClusterName": "ack-cluster-name",
      "ClusterType": "ManagedKubernetes",
      "Profile": "Default",
      "VpcId": "vpc-2vcg932hsxsxuqbgl****",
      "Network": "terway-eniip",
      "ClusterSpec": "ack.pro.small",
      "State": "running"
    }
  ],
  "PageNo": 1,
  "PageSize": 10,
  "RequestId": "C5DDD596-1191-5F36-A504-8733045A****",
  "TotalCount": 1
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorParametersUid	The aliUid parameter is invalid.	The aliUid parameter is invalid.
400	ErrorParameters	Parameters error.	Parameter error.
400	ErrorDBSelect	An error occurred while querying database.	An error occurred while querying database.
400	ErrorRegionNo	regionNo error.	Region selection error, please re-enter.
400	ErrorAckNotOpen	ACK service is not open.	ACK service is not open.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.