All Products
Search
Document Center

Security Center:DescribeClusterBasicInfo

Last Updated:Feb 20, 2024

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

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeClusterBasicInfoRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The ID of the cluster that you want to query.

Note You can call the DescribeGroupedContainerInstances operation to query the IDs of clusters.
c870ec78ecbcb41d2a35c679823ef****
TypestringYes

The type of the feature. Valid values:

  • containerNetwork: container network topology
  • interceptionSwitch: cluster microsegmentation
containerNetwork
TargetTypestringYes

The dimension from which you want to configure the feature. Valid values:

  • Cluster: the ID of the cluster
Cluster

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

24A20733-10A0-4AF6-BE6B-E3322413BB68
ClusterInfoobject

The detailed information about the cluster.

InstanceCountinteger

The number of instances in the cluster.

10
ClusterTypestring

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
Statestring

The status of the cluster. Valid values:

  • unavailable
  • Available
  • Creating
  • CreateFailed
Available
CreateTimelong

The timestamp when the cluster was created. Unit: milliseconds.

1662038134000
ClusterNamestring

The name of the cluster.

testackpro
CurrentVersionstring

The version of the cluster.

1.22.10-aliyun.1
TargetResultboolean

Indicates whether the cluster is enabled. Valid values:

  • true: The cluster is enabled.
  • false: The cluster is disabled.
true
RegionIdstring

The ID of the region in which the cluster is deployed.

cn-hangzhou
ClusterIdstring

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 codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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