All Products
Search

This Product

    Alibaba Cloud Service Mesh:DescribeServiceMeshClusters

    Document Center

    Alibaba Cloud Service Mesh:DescribeServiceMeshClusters

    Last Updated:Mar 05, 2024

    Queries the clusters that can be added to a Service Mesh (ASM) instance.

    Debugging

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

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ServiceMeshIdstringNo

    The ASM instance ID.

    		cb8963379255149cb98c8686f274x****
    OffsetlongNo

    The position where the query starts.

    		20
    LimitlongNo

    The maximum number of entries per page.

    		30

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		31d3a0f0-07ed-4f6e-9004-1804498c****
    Clustersobject []

    The queried clusters.

    SgIdstring

    The ID of the security group.

    		sg-bp197668l6iupljy****
    VpcIdstring

    The ID of the virtual private cloud (VPC).

    		vpc-8vbrwmt95b4zf6wf7****
    CreationTimestring

    The time when the cluster was created.

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

    The time when the cluster was last modified.

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

    The error message about the cluster.

    		fail
    Statestring

    The state of the cluster. Valid values:

    • running: The cluster is running.
    • starting: The cluster is starting.
    • stopping: The cluster is being stopped.
    • stopped: The cluster is stopped.
    • failed: The cluster fails to be run.
    		running
    ServiceMeshIdstring

    The ASM instance ID.

    		cb8963379255149cb98c8686f274x****
    RegionIdstring

    The ID of the region in which the cluster resides.

    		cn-hangzhou
    ClusterDomainstring

    The domain name of the cluster.

    		c.com
    Versionstring

    The version number of the cluster.

    		v1.16.6-aliyun.1
    ClusterTypestring

    The cluster type.

    		Ask
    Namestring

    The name of the cluster.

    		ask1
    ClusterIdstring

    The cluster ID.

    		c80f45444b3da447da60a911390c2****
    ForbiddenFlaglong

    Indicates that the cluster is available or the reason why the cluster cannot be added to the ASM instance. Valid values:

    • 0: The cluster can be added to the ASM instance.
    • 1: The cluster cannot be added to the ASM instance because you do not have administrator permissions on the cluster.
    • 2: The cluster cannot be added to the ASM instance because the cluster and the ASM instance reside in different VPCs between which no private connections are built.
    • 3: The CIDR block of the cluster conflicts with that of the ASM instance.
    • 4: The cluster has a namespace that is named istio-system.
    		0
    ForbiddenInfostring

    The reason why the cluster on the data plane 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"
  }
]

    In the preceding example, the CIDR block 172.16.0.0/24 of the pod in the cdd55bd6e054b4c6ca18ec02614****** cluster conflicts with the CIDR block 172.16.0.0/24 of the pod in the cfa37fdf7cb1641e1976f8293ac****** cluster.

    Valid values of the object parameter:

    • 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"}]
    NumberOfClusterslong

    The total number of ACK clusters in the current Region.

    		5

    Examples

    Sample success responses

    JSONformat

    {
  "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

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