All Products
Search

This Product

    Alibaba Cloud Service Mesh:DescribeServiceMeshClusters

    Document Center

    Alibaba Cloud Service Mesh:DescribeServiceMeshClusters

    Last Updated:Aug 25, 2025

    Queries the available clusters in a service mesh.

    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

    servicemesh:DescribeServiceMeshClusters

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ServiceMeshId

    string

    No

    The service mesh ID.

    cb8963379255149cb98c8686f274x****
    Offset

    integer

    No

    The start position of the query.

    20
    Limit

    integer

    No

    The maximum number of clusters to return.

    30

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    31d3a0f0-07ed-4f6e-9004-1804498c****
    Clusters

    array<object>

    A list of clusters.

    object

    SgId

    string

    The security group ID.

    sg-bp197668l6iupljy****
    VpcId

    string

    The virtual private cloud (VPC) ID.

    vpc-8vbrwmt95b4zf6wf7****
    CreationTime

    string

    The time when the cluster was created.

    2020-05-12T15:38:16+08:00
    UpdateTime

    string

    The time when the cluster was last modified.

    2020-05-12T15:38:16+08:00
    ErrorMessage

    string

    The error message returned if the cluster is in an abnormal state.

    fail
    State

    string

    The status of the cluster. Valid values:

    • running: The cluster is running.

    • starting : The cluster is being started.

    • stopping : The cluster is being stopped.

    • stopped: The cluster is stopped.

    • failed: The cluster is in the failed state.

    running
    ServiceMeshId

    string

    The service mesh ID.

    cb8963379255149cb98c8686f274x****
    RegionId

    string

    The ID of the region where the cluster resides.

    cn-hangzhou
    ClusterDomain

    string

    The domain name of the cluster.

    c.com
    Version

    string

    The version number of the cluster.

    v1.16.6-aliyun.1
    ClusterType

    string

    The type of the cluster.

    Ask
    Name

    string

    The name of the cluster.

    ask1
    ClusterId

    string

    The cluster ID.

    c80f45444b3da447da60a911390c2****
    ForbiddenFlag

    integer

    The reason why the data plane cluster cannot be added to the ASM instance. Valid values:

    • 0: The cluster is normal and can be added.

    • 1: You do not have the administrative permissions on the cluster.

    • 2: The cluster and the service mesh are in different VPCs, and no Cloud Enterprise Network (CEN) instance is used to connect them.

    • 3: The CIDR block of the cluster conflicts with that of the service mesh.

    • 4: The cluster has a namespace named istio-system.

    0
    ForbiddenInfo

    string

    The detailed reason why the data plane cluster cannot be added to the ASM instance. The value is a JSON string in the following format:

    [
  {
    "cluster": "cdd55bd6e054b4c6ca18ec02614******",
    "object": "Pod",
    "cidr": "172.16.0.0/24"
  },
  {
    "cluster": "cfa37fdf7cb1641e1976f8293ac******",
    "object": "Pod",
    "cidr": "172.16.0.0/24"
  }
]

    The preceding example indicates that the pod CIDR block 172.16.0.0/24 of the cluster cdd55bd6e054b4c6ca18ec02614****** conflicts with the pod CIDR block 172.16.0.0/24 of the cluster cfa37fdf7cb1641e1976f8293ac******.

    Valid values of object:

    • Pod

    • Service

    • VSwitch

    • VPC

    • VPC CIDR

    [{"cluster":"cdd55bd6e054b4c6ca18ec02614******", "object":"Pod", "cidr":"172.16.0.0/24"},{"cluster":"cfa37fdf7cb1641e1976f8293ac******", "object":"Pod", "cidr":"172.16.0.0/24"}]
    NumberOfClusters

    integer

    The total number of container service clusters in the current region.

    5

    Examples

    Success response

    JSON format

    {
  "RequestId": "31d3a0f0-07ed-4f6e-9004-1804498c****",
  "Clusters": [
    {
      "SgId": "sg-bp197668l6iupljy****",
      "VpcId": "vpc-8vbrwmt95b4zf6wf7****",
      "CreationTime": "2020-05-12T15:38:16+08:00",
      "UpdateTime": "2020-05-12T15:38:16+08:00",
      "ErrorMessage": "fail",
      "State": "running",
      "ServiceMeshId": "cb8963379255149cb98c8686f274x****",
      "RegionId": "cn-hangzhou",
      "ClusterDomain": "c.com",
      "Version": "v1.16.6-aliyun.1",
      "ClusterType": "Ask",
      "Name": "ask1",
      "ClusterId": "c80f45444b3da447da60a911390c2****",
      "ForbiddenFlag": 0,
      "ForbiddenInfo": "[{\"cluster\":\"cdd55bd6e054b4c6ca18ec02614******\", \"object\":\"Pod\", \"cidr\":\"172.16.0.0/24\"},{\"cluster\":\"cfa37fdf7cb1641e1976f8293ac******\", \"object\":\"Pod\", \"cidr\":\"172.16.0.0/24\"}]"
    }
  ],
  "NumberOfClusters": 5
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.