Queries the clusters that can be added to an Alibaba Cloud 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeServiceMeshClusters

The operation that you want to perform. Set the value to DescribeServiceMeshClusters.

ServiceMeshId String No cb8963379255149cb98c8686f274x****

The ID of the ASM instance.

Response parameters

Parameter Type Example Description
RequestId String 31d3a0f0-07ed-4f6e-9004-1804498c****

The ID of the request.

Clusters Array of Cluster

The clusters that can be added to the ASM instance.

SgId String sg-bp197668l6iupljy****

The ID of the security group.

VpcId String vpc-8vbrwmt95b4zf6wf7****

The ID of the virtual private cloud (VPC).

CreationTime String 2020-05-12T15:38:16+08:00

The point in time when the cluster was created.

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

The point in time when the cluster was last modified.

ErrorMessage String fail

The error message about the cluster.

State String running

The status 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.
ServiceMeshId String cb8963379255149cb98c8686f274x****

The ID of the ASM instance.

RegionId String cn-hangzhou

The ID of the region in which the cluster resides.

ClusterDomain String c.com

The domain name of the cluster.

Version String v1.16.6-aliyun.1

The version number of the cluster.

ClusterType String Ask

The type of the cluster.

Name String ask1

The name of the cluster.

ClusterId String c80f45444b3da447da60a911390c2****

The ID of the cluster.

ForbiddenFlag Long 0

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.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeServiceMeshClusters
&ServiceMeshId=cb8963379255149cb98c8686f274x****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeServiceMeshClustersResponse>
    <RequestId>31d3a0f0-07ed-4f6e-9004-1804498c****</RequestId>
    <Clusters>
        <SgId>sg-bp197668l6iupljy****</SgId>
        <VpcId>vpc-8vbrwmt95b4zf6wf7****</VpcId>
        <CreationTime>2020-05-12T15:38:16+08:00</CreationTime>
        <UpdateTime>2020-05-12T15:38:16+08:00</UpdateTime>
        <ErrorMessage>fail</ErrorMessage>
        <State>running</State>
        <ServiceMeshId>cb8963379255149cb98c8686f274x****</ServiceMeshId>
        <RegionId>cn-hangzhou</RegionId>
        <ClusterDomain>c.com</ClusterDomain>
        <Version>v1.16.6-aliyun.1</Version>
        <ClusterType>Ask</ClusterType>
        <Name>ask1</Name>
        <ClusterId>c80f45444b3da447da60a911390c2****</ClusterId>
        <ForbiddenFlag>0</ForbiddenFlag>
    </Clusters>
</DescribeServiceMeshClustersResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.