DescribeClustersInServiceMesh - Alibaba Cloud Service Mesh

Retrieves information about clusters in a Service Mesh instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

servicemesh:DescribeClustersInServiceMesh

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ServiceMeshId	string	Yes	The ID of the Service Mesh instance.	cb8963379255149cb98c8686f274x****

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	31d3a0f0-07ed-4f6e-9004-1804498c****
Clusters	array<object>	The list of clusters.
	object	The information about the cluster.
SgId	string	The security group ID.	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	array<object>	The list of access log configurations.
	object	The information about the access log configuration.
Url	string	The URL of the access log.	https://sls.console.alibabacloud.com/next/project/****/dashboard/mesh-access-log_details_cn
Title	string	The title of the access log.	mesh-access-log_details_cn
RegionId	string	The ID of the region where 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 cluster ID.	c80f45444b3da447da60a911390c2****
LogtailInstalledState	string	The installation status of the Logtail component in the cluster. Valid values: `logtail_installed`: The Logtail component is installed. -`logtail_uninstalled`: The Logtail component is not installed. `logtail_state_get_error`: Failed to install the Logtail component.	logtail_installed
GuestClusterConfig	object
SMC	object
Enabled	boolean

Examples

Success response

JSON format

{
  "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",
      "GuestClusterConfig": {
        "SMC": {
          "Enabled": true
        }
      }
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.