Queries the information about 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
Action String Yes DescribeClustersInServiceMesh

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

ServiceMeshId String Yes 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 in the ASM instance.

SgId String sg-bp197668l6iupljy****

The ID of the security group.

VpcId String vpc-2zew0rajjkmxy2369****

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 ,

The error message that is returned when the call failed.

State String running

The status of the cluster.

AccessLogDashboards Array of AccessLogDashboardInfo

The configurations of access log collection.

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

The URL of the dashboard for access logs.

Title String mesh-access-log_details_cn

The name of the dashboard for access logs.

RegionId String cn-hangzhou

The ID of the region in which the cluster resides.

ClusterDomain String example.com

The domain 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.

LogtailInstalledState String logtail_installed

Indicates whether the Logtail component is installed in the cluster. Valid values:

  • logtail_installed: The Logtail component is installed.

-logtail_uninstalled: The Logtail component is not installed.

  • logtail_state_get_error: The Logtail component fails to be installed.

Examples

Sample requests

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

Sample success responses

XML format 

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

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

JSON format 

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

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

Error codes

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