ListClusters - Microservices Engine - Alibaba Cloud Documentation Center

Queries the list of registered configuration center clusters.

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 support 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

mse:ListClusters

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RequestPars	string	No	Extended request parameters in JSON format.	{}
PageNum	integer	Yes	Page number.	1
PageSize	integer	Yes	Number of clusters displayed per page.	10
ClusterAliasName	string	No	Cluster name, supports fuzzy matching.	cluster
RegionId	string	Yes	Region where the cluster is located, regions supported by MSE.	cn-hangzhou
ResourceGroupId	string	No	Resource group ID. For resource group details, see View resource group basic information.	rg-acfmxbzafebvvfa
Tag	array	No	Tag list, can contain up to 20 items
	object	No	Tag.
Key	string	No	Tag key.	env
Value	string	No	Tag value.	prd
KeyId	string	No	For Nacos clusters, query instances bound to the specified keyId
AcceptLanguage	string	No	Language type of the returned information: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	String object.
HttpCode	string	HTTP status code.	202
TotalCount	integer	Total number of instances.	7
RequestId	string	Request ID.	69AD2AA7-DB47-449B-941B-B14409DF****
Message	string	Message.	The request was successfully processed.
PageSize	integer	Number of instances displayed per page.	10
PageNumber	integer	Page number.	1
Data	array	Data overview.
	object	String object.
EndDate	string	Cluster end time.	2021-08-01 00:00:00
IntranetDomain	string	Private domain name.	mse-7413****-eureka.mse.aliyuncs.com
InternetDomain	string	Internet domain name.	mse-7413****-p.eureka.mse.aliyuncs.com
CreateTime	string	Cluster creation time.	2020-07-31 11:36:08
ChargeType	string	Payment mode, including subscription and pay-as-you-go.	Pay-as-you-go
IntranetAddress	string	Private endpoint.	192.168.XX.XX
InstanceId	string	Instance ID.	mse-cn-st21ri2****
InternetAddress	string	Internet address.	47.98.XX.XX
ClusterAliasName	string	Cluster alias.	mse-7413****
ClusterType	string	Cluster type, including ZooKeeper, Nacos-Ans, and Eureka.	Eureka
InitStatus	string	Initialization status.	RESTART_SUCCESS
AppVersion	string	APP version.	1.9.3
CanUpdate	boolean	Whether it can be upgraded.	true
VersionCode	string	Version information.	EUREKA_1_9_3
InstanceCount	integer	Cluster count.	2
ClusterName	string	Cluster name.	mse-cn-st21ri2****
MseVersion	string	Version category used by the cluster.	mse_pro
Tags	object	Tags bound to the instance.
ResourceGroupId	string	Resource group ID to which the instance belongs.	rg-acfmv7jiavm4uxa
VpcId	string	VPC ID where the cluster is located.	vpc-bp1hcg467ekqsv0zr****
MaintenancePeriod	object	O&M time window
StartTime	string	O&M time window start time
EndTime	string	O&M time window end time
VersionLifecycle	string
ErrorCode	string	Error code.	mse-100-000
Success	boolean	Request result, values are: `true`: Request successful. `false`: Request failed.	true

Examples

Success response

JSON format

{
  "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****",
      "MaintenancePeriod": {
        "StartTime": "",
        "EndTime": ""
      },
      "VersionLifecycle": ""
    }
  ],
  "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
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.