Queries the information of clusters in 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
ServiceMeshId String Yes cb8963379255149cb98c8686f274x****

The ID of the ASM instance.

Response parameters

Parameter Type Example Description
Clusters Array of Cluster

The clusters in the ASM instance.

AccessLogDashboards Array of AccessLogDashboardInfo

The configurations of the collection of access logs.

Title String mesh-access-log_details_cn

The name of the dashboard for access logs.

Url String https://sls.console.aliyun.com/next/project/****/dashboard/mesh-access-log_details_cn

The URL of the dashboard for access logs.

ClusterDomain String c.com

The domain name of the cluster.

ClusterId String c80f45444b3da447da60a911390c2****

The ID of the cluster.

ClusterType String Ask

The type of the cluster.

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

The time when the cluster was created.

ErrorMessage String ,

The error message that is returned when the call failed.

Name String ask1

The name of the cluster.

RegionId String cn-hangzhou

The ID of the region where the cluster resides.

SgId String sg-bp197668l6iupljy****

The ID of the security group.

State String running

The status of the cluster.

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

The time when the cluster was last modified.

Version String v1.16.6-aliyun.1

The version number of the cluster.

VpcId String vpc-2zew0rajjkmxy2369****

The ID of the virtual private cloud (VPC).

RequestId String 31d3a0f0-07ed-4f6e-9004-1804498c****

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeClustersInServiceMesh
&<Common request parameters>

Sample success responses

XML format

<RequestId>31d3a0f0-07ed-4f6e-9004-1804498c****</RequestId>
<Clusters>
    <ClusterId>c80f45444b3da447da60a911390c2****</ClusterId>
    <ClusterDomain>c.com</ClusterDomain>
    <SgId>sg-bp197668l6iupljy****</SgId>
    <ClusterType>Ask</ClusterType>
    <Name>ask1</Name>
    <VpcId>vpc-2zew0rajjkmxy2369****</VpcId>
    <Version>v1.16.6-aliyun.1</Version>
    <State>running</State>
    <UpdateTime>2020-05-12T15:38:16+08:00</UpdateTime>
    <CreationTime>2020-05-12T15:38:16+08:00</CreationTime>
    <RegionId>cn-hangzhou</RegionId>
    <ErrorMessage>,</ErrorMessage>
</Clusters>
<Clusters>
    <AccessLogDashboards>
        <Title>mesh-access-log_details_cn</Title>
        <Url>https://sls.console.aliyun.com/next/project/****/dashboard/mesh-access-log_details_cn</Url>
    </AccessLogDashboards>
</Clusters>

JSON format

{"RequestId":"31d3a0f0-07ed-4f6e-9004-1804498c****","Clusters":[{"ClusterId":"c80f45444b3da447da60a911390c2****","ClusterDomain":"c.com","SgId":"sg-bp197668l6iupljy****","ClusterType":"Ask","Name":"ask1","VpcId":"vpc-2zew0rajjkmxy2369****","Version":"v1.16.6-aliyun.1","State":"running","UpdateTime":"2020-05-12T15:38:16+08:00","CreationTime":"2020-05-12T15:38:16+08:00","RegionId":"cn-hangzhou","ErrorMessage":","},{"AccessLogDashboards":[{"Title":"mesh-access-log_details_cn","Url":"https://sls.console.aliyun.com/next/project/****/dashboard/mesh-access-log_details_cn"}]}]}

Error codes

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