DescribeClustersInServiceMesh - Alibaba Cloud Service Mesh

Queries the information about clusters in 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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ServiceMeshId	string	Yes	The ASM instance ID.	cb8963379255149cb98c8686f274x****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	31d3a0f0-07ed-4f6e-9004-1804498c****
Clusters	object []	The list of the clusters in the ASM instance.
SgId	string	The ID of the security group.	sg-bp197668l6iupljy****
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-2zew0rajjkmxy2369****
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.	,
State	string	The status of the cluster.	running
AccessLogDashboards	object []	The configurations of access log collection.
Url	string	The URL of the dashboard for access logs.	https://sls.console.aliyun.com/next/project/****/dashboard/mesh-access-log_details_cn
Title	string	The name of the dashboard for access logs.	mesh-access-log_details_cn
RegionId	string	The ID of the region in which the cluster resides.	cn-hangzhou
ClusterDomain	string	The domain name of the cluster.	example.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 ID of the cluster.	c80f45444b3da447da60a911390c2****
LogtailInstalledState	string	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 failed to be installed.	logtail_installed

Examples

Sample success responses

JSONformat

{
  "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.aliyun.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 Service error codes.