All Products
Search

This Product

    Security Center:DescribeClusterBasicInfo

    Document Center

    Security Center:DescribeClusterBasicInfo

    Last Updated:Jun 15, 2026

    Queries cluster information by cluster ID.

    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

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    yundun-sas:DescribeClusterBasicInfo

    get

    *All Resource

    *

    		 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 obtain this parameter.

    c870ec78ecbcb41d2a35c679823ef****
    Type

    string

    Yes

    The configuration type. Valid values:

    • containerNetwork: container network topology switch

    • interceptionSwitch: cluster microsegmentation switch.

    containerNetwork
    TargetType

    string

    Yes

    The operation dimension of the target switch configuration. Valid values:

    • Cluster: cluster ID.

    Cluster

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot issues.

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

    object

    The cluster details.

    InstanceCount

    integer

    The number of instances in the cluster.

    10
    ClusterType

    string

    The cluster type. Valid values:

    • ManagedKubernetes: managed Kubernetes

    • NotManagedKubernetes: non-managed Kubernetes

    • PrivateKubernetes: private cluster

    • kubernetes: dedicated Kubernetes

    • ask: dedicated ASK.

    kubernetes
    State

    string

    The availability status. Valid values:

    • unavailable: Not available.

    • Available: Available.

    • Creating: Being created.

    • CreateFailed: Creation failed.

    Available
    CreateTime

    integer

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

    1662038134000
    ClusterName

    string

    The cluster name.

    testackpro
    CurrentVersion

    string

    The version information of the cluster.

    1.22.10-aliyun.1
    TargetResult

    boolean

    The cluster switch status.

    • true: enabled

    • false: disabled.

    true
    RegionId

    string

    The region ID of the cluster.

    cn-hangzhou
    ClusterId

    string

    The cluster ID.

    c870ec78ecbcb41d2a35c679823ef****

    Examples

    Success response

    JSON format

    {
  "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
    500 ServerError ServerError
    403 NoPermission caller has no permission

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.