DescribeClusterBasicInfo - Security Center - Alibaba Cloud Documentation Center

Queries the information about an cluster based on the cluster ID.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
yundun-sas:DescribeClusterBasicInfo	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the cluster that you want to query. Note You can call the DescribeGroupedContainerInstances operation to query the IDs of clusters.	c870ec78ecbcb41d2a35c679823ef****
Type	string	Yes	The type of the feature. Valid values: containerNetwork: container network topology interceptionSwitch: cluster microsegmentation	containerNetwork
TargetType	string	Yes	The dimension from which you want to configure the feature. Valid values: Cluster: the ID of the cluster	Cluster

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	24A20733-10A0-4AF6-BE6B-E3322413BB68
ClusterInfo	object	The detailed information about the cluster.
InstanceCount	integer	The number of instances in the cluster.	10
ClusterType	string	The type of the cluster. Valid values: ManagedKubernetes: managed Kubernetes cluster NotManagedKubernetes: non-managed Kubernetes cluster PrivateKubernetes: private cluster kubernetes: dedicated Kubernetes cluster ask: dedicated ASK cluster	kubernetes
State	string	The status of the cluster. Valid values: unavailable Available Creating CreateFailed	Available
CreateTime	long	The timestamp when the cluster was created. Unit: milliseconds.	1662038134000
ClusterName	string	The name of the cluster.	testackpro
CurrentVersion	string	The version of the cluster.	1.22.10-aliyun.1
TargetResult	boolean	Indicates whether the cluster is enabled. Valid values: true: The cluster is enabled. false: The cluster is disabled.	true
RegionId	string	The ID of the region in which the cluster is deployed.	cn-hangzhou
ClusterId	string	The ID of cluster.	c870ec78ecbcb41d2a35c679823ef****

Examples

Sample success responses

JSONformat

{
  "RequestId": "24A20733-10A0-4AF6-BE6B-E3322413BB68",
  "ClusterInfo": {
    "InstanceCount": 10,
    "ClusterType": "kubernetes",
    "State": "Available",
    "CreateTime": 1662038134000,
    "ClusterName": "testackpro",
    "CurrentVersion": "1.22.10-aliyun.1",
    "TargetResult": true,
    "RegionId": "cn-hangzhou",
    "ClusterId": "c870ec78ecbcb41d2a35c679823ef****\n"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

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