GetK8sCluster - Enterprise Distributed Application Service

Queries Container Service for Kubernetes (ACK) clusters or Serverless Kubernetes clusters in a specified region.

Debugging

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

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
edas:ReadCluster	Read	Cluster acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/cluster/{#ClusterId}	none	none

Request syntax

POST /pop/v5/k8s_clusters

Request parameters

Parameter	Type	Required	Description	Example
RegionTag	string	Yes	The ID of the region.	cn-hangzhou
CurrentPage	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 1000.	10
ClusterType	integer	No	The type of the Kubernetes cluster. Valid values: 5: ACK cluster 7: self-managed Kubernetes cluster	5
SubClusterType	string	No	The subtype of the cluster. Valid values: Ask: Serverless Kubernetes cluster ManagedKubernetes: ACK cluster	Ask

Response parameters

Parameter	Type	Description	Example
	object	The content that is returned.
Code	integer	The HTTP status code that is returned.	200
Message	string	The additional information that is returned.	success
RequestId	string	The ID of the request.	C3CE915C-0C83-4AA5-8D66-E8BEED62939E
ClusterPage	object	The cluster data that is returned by page.
CurrentPage	integer	The number of the returned page. Default value: 1.	1
PageSize	integer	The number of entries returned per page. Default value: 1000.	10
TotalSize	integer	The total number of pages that are returned.	5
ClusterList	object []	The list of clusters.
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-z1mlwpbjx3e9m
VswitchId	string	The ID of the vSwitch.	vsw-bp1uf97**xjxgip**
SubNetCidr	string	The CIDR block of the subnet.	172.20.0.0/16
Mem	integer	The total size of memory. Unit: MB.	2048
RegionId	string	The ID of the namespace.	test
CsClusterStatus	string	The state of the ACK cluster. Valid values: initial: The cluster is being initialized. failed: The cluster fails to be created. running: The cluster is running. updating: The cluster is being updated. scaling: The cluster is being scaled out. removing: Nodes are being removed from the cluster. upgrading: The cluster is being upgraded. deleting: The cluster is being deleted. delete_failed: The cluster fails to be deleted. deleted: The cluster is deleted. The deleted cluster is invisible to users.	running
Cpu	integer	The total number of CPU cores.	4
NetworkMode	integer	The network type of the cluster. Valid values: 1: classic network 2: VPC	2
CsClusterId	string	The ID of the ACK cluster.	2ce62869f4d4466b920312315f05****
Description	string	The description of the cluster.	test
ClusterType	integer	The type of the cluster. Valid values: 2: Elastic Compute Service (ECS) cluster 5: ACK cluster or Serverless Kubernetes cluster	5
ClusterName	string	The name of the cluster.	test
NodeNum	integer	The number of nodes.	4
ClusterId	string	The ID of the cluster.	81453e4b-4df0-4592-**-b835a2ee**
ClusterImportStatus	integer	The import state of the cluster. Valid values: 0: The cluster is not imported. 1: The cluster is imported. 2: The cluster fails to be imported. 3: The cluster is being imported. 4: The cluster is deleted.	1
SubClusterType	string	The subtype of the cluster. Valid values: Ask: Serverless Kubernetes cluster ManagedKubernetes: ACK cluster	Ask
ClusterStatus	integer	The status of the cluster. Valid values: 1: The cluster runs as expected. 2: The cluster does not run as expected. 3: The cluster is offline.	1

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "success",
  "RequestId": "C3CE915C-0C83-4AA5-8D66-E8BEED62939E",
  "ClusterPage": {
    "CurrentPage": 1,
    "PageSize": 10,
    "TotalSize": 5,
    "ClusterList": {
      "Cluster": [
        {
          "VpcId": "vpc-**z1mlwpbjx3e9m**",
          "VswitchId": "vsw-bp1uf97****xjxgip****",
          "SubNetCidr": "172.20.0.0/16",
          "Mem": 2048,
          "RegionId": "test",
          "CsClusterStatus": "running",
          "Cpu": 4,
          "NetworkMode": 2,
          "CsClusterId": "2ce62869f4d4466b920312315f05****",
          "Description": "test",
          "ClusterType": 5,
          "ClusterName": "test",
          "NodeNum": 4,
          "ClusterId": "81453e4b-4df0-4592-****-b835a2ee****",
          "ClusterImportStatus": 1,
          "SubClusterType": "Ask",
          "ClusterStatus": 1
        }
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	Edas.errorcode.PermissionDenied.message	You are not authorized to perform the operation.	No permissions

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