ListClusters - Microservices Engine - Alibaba Cloud Documentation Center

Queries Microservices Engine (MSE) instances.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mse:ListClusters	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RequestPars	string	No	The extended request parameters in the JSON format.	{}
PageNum	integer	Yes	The number of the page to return.	1
PageSize	integer	Yes	The number of entries to return on each page.	10
ClusterAliasName	string	No	The alias of the instance. Fuzzy match is supported.	cluster
RegionId	string	Yes	The ID of the region in which the instance resides. The region is supported by MSE.	cn-hangzhou
ResourceGroupId	string	No	The ID of the resource group. For more information about resource groups, see the topic "View basic information of a resource group."	rg-acfmxbzafebvvfa
Tag	array<object>	No	The list of tags. A maximum number of 20 tags are supported.
	object	No	The tags.
Key	string	No	The key of the tag.	env
Value	string	No	The value of the tag.	prd
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
HttpCode	string	The HTTP status code returned.	202
TotalCount	integer	The total number of returned instances.	7
RequestId	string	The ID of the request.	69AD2AA7-DB47-449B-941B-B14409DF****
Message	string	The message returned.	The request was successfully processed.
PageSize	integer	The number of entries returned per page.	10
PageNumber	integer	The page number of the returned page.	1
Data	array<object>	The details of the data.
ClusterForListModel	object	The string object.
EndDate	string	The time when the cluster expires.	2021-08-01 00:00:00
IntranetDomain	string	The internal endpoint.	mse-7413****-eureka.mse.aliyuncs.com
InternetDomain	string	The public endpoint.	mse-7413****-p.eureka.mse.aliyuncs.com
CreateTime	string	The time when the cluster was created.	2020-07-31 11:36:08
ChargeType	string	The billing method, such as subscription or pay-as-you-go.	Pay-as-you-go
IntranetAddress	string	The internal IP address.	192.168.XX.XX
InstanceId	string	The instance ID.	mse-cn-st21ri2****
InternetAddress	string	The public IP address.	47.98.XX.XX
ClusterAliasName	string	The alias of the cluster.	mse-7413****
ClusterType	string	The type of the cluster. Valid values: ZooKeeper, Nacos-Ans, and Eureka.	Eureka
InitStatus	string	The initialization status of the instance.	RESTART_SUCCESS
AppVersion	string	The application version.	1.9.3
CanUpdate	boolean	Indicates whether the instance can be upgraded.	true
VersionCode	string	The version information.	EUREKA_1_9_3
InstanceCount	long	The number of clusters.	2
ClusterName	string	The name of the cluster.	mse-cn-st21ri2****
MseVersion	string	The edition of the cluster.	mse_pro
Tags	object	The tags that are attached to the instance.
ResourceGroupId	string	The ID of the resource group to which the instance belongs.	rg-acfmv7jiavm4uxa
ErrorCode	string	The error code returned if the request failed.	mse-100-000
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "HttpCode": "202",
  "TotalCount": 7,
  "RequestId": "69AD2AA7-DB47-449B-941B-B14409DF****",
  "Message": "The request was successfully processed.\n",
  "PageSize": 10,
  "PageNumber": 1,
  "Data": [
    {
      "EndDate": "2021-08-01 00:00:00",
      "IntranetDomain": "mse-7413****-eureka.mse.aliyuncs.com",
      "InternetDomain": "mse-7413****-p.eureka.mse.aliyuncs.com",
      "CreateTime": "2020-07-31 11:36:08",
      "ChargeType": "Pay-as-you-go\n",
      "IntranetAddress": "192.168.XX.XX",
      "InstanceId": "mse-cn-st21ri2****",
      "InternetAddress": "47.98.XX.XX",
      "ClusterAliasName": "mse-7413****",
      "ClusterType": "Eureka",
      "InitStatus": "RESTART_SUCCESS",
      "AppVersion": "1.9.3",
      "CanUpdate": true,
      "VersionCode": "EUREKA_1_9_3",
      "InstanceCount": 2,
      "ClusterName": "mse-cn-st21ri2****",
      "MseVersion": "mse_pro",
      "Tags": {
        "test": "test",
        "test2": 1
      },
      "ResourceGroupId": "rg-acfmv7jiavm4uxa",
      "VpcId": "vpc-bp1hcg467ekqsv0zr****"
    }
  ],
  "ErrorCode": "mse-100-000",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-10-19	The response structure of the API has changed	View Change Details
2023-08-09	The response structure of the API has changed	View Change Details
2023-04-25	The internal configuration of the API is changed, but the call is not affected	View Change Details
2021-10-20	The response structure of the API has changed	View Change Details