All Products
Search
Document Center

Security Center:DescribeClusterInfoList

Last Updated:Nov 13, 2024

Queries the information about a cluster.

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.

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:DescribeClusterInfoListget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TypestringYes

The type of the feature. Valid values:

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

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

  • Cluster: the ID of the cluster
Cluster
TargetstringNo

The operation value. The value specifies the ID of the cluster.

c23551de6149343e8a54e69fbefe6****

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

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

7E0618A9-D5EF-4220-9471-C42B5E92719F
ClusterListarray<object>

An array that consists of the information about clusters.

ClusterInfoobject

The information about the cluster.

Statestring

The status of the cluster. Valid values:

  • unavailable: The cluster is unavailable.
  • Available: The cluster is available.
  • Creating: The cluster is being created.
  • CreateFailed: The cluster failed to be created.
Available
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 serverless Kubernetes (ASK) cluster.
ManagedKubernetes
ClusterNamestring

The name of the container cluster.

test111
ClusterIdstring

The ID of the container cluster.

cfeb7a9f99ce740e98c5595d0fe37****
RegionIdstring

The region in which the cluster resides.

cn-hangzhou
TargetResultboolean

Indicates whether container network topology was enabled. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "7E0618A9-D5EF-4220-9471-C42B5E92719F",
  "ClusterList": [
    {
      "State": "Available",
      "ClusterType": "ManagedKubernetes",
      "ClusterName": "test111",
      "ClusterId": "cfeb7a9f99ce740e98c5595d0fe37****",
      "RegionId": "cn-hangzhou",
      "TargetResult": true
    }
  ]
}

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.