List MSE Configuration Clusters via ListClusters API - MSE - Alibaba Cloud - Microservices Engine

Queries a list of Microservices Registry 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 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

mse:ListClusters

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RequestPars	string	No	The extended request parameters in JSON format.	{}
PageNum	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of clusters to return on each page.	10
ClusterAliasName	string	No	The name of the cluster. Fuzzy match is supported.	cluster
RegionId	string	Yes	The region ID of the cluster. The region must be supported by Microservices Engine (MSE).	cn-hangzhou
ResourceGroupId	string	No	The ID of the resource group. For more information, see View basic information of a resource group.	rg-acfmxbzafebvvfa
Tag	array<object>	No	The list of tags. A maximum of 20 tags can be specified.
	object	No	The tag.
Key	string	No	The tag key.	env
Value	string	No	The tag value.	prd
KeyId	string	No	The key ID. If the cluster is a Nacos cluster, this parameter is used to query instances bound to the specified key ID.	key-hzz67774641bsp21vhj4h
AcceptLanguage	string	No	The VPC ID.	vpc-bp1t50e045b5g7i3p****

Response elements

Element	Type	Description	Example
	object	The string object.
HttpCode	string	The HTTP status code.	202
TotalCount	integer	The total number of instances.	7
RequestId	string	The request ID.	69AD2AA7-DB47-449B-941B-B14409DF****
Message	string	The message.	OK
PageSize	integer	The number of instances returned on each page.	10
PageNumber	integer	The page number.	1
Data	array<object>	The data overview.
	array<object>	The string object.
EndDate	string	The expiration time of the cluster.	2021-08-01 00:00:00
IntranetDomain	string	The internal domain name.	mse-7413****-eureka.mse.aliyuncs.com
InternetDomain	string	The public domain name.	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, including subscription and pay-as-you-go.	subscription
IntranetAddress	string	The private network address.	192.168.XX.XX
InstanceId	string	The instance ID.	mse-cn-st21ri2****
InternetAddress	string	The public address.	47.98.XX.XX
ClusterAliasName	string	The alias of the cluster.	mse-7413****
ClusterType	string	The cluster type, including ZooKeeper, Nacos-Ans, and Eureka.	Eureka
InitStatus	string	The initialization status.	RESTART_SUCCESS
AppVersion	string	The application version.	1.9.3
CanUpdate	boolean	Indicates whether the cluster can be upgraded.	true
VersionCode	string	The version information.	EUREKA_1_9_3
InstanceCount	integer	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 bound to the instance.
ResourceGroupId	string	The ID of the resource group to which the instance belongs.	rg-acfmv7jiavm4uxa
VpcId	string	The ID of the VPC where the cluster is deployed.	vpc-bp1hcg467ekqsv0zr****
MaintenancePeriod	object	The O&M time window.
StartTime	string	The start time of the O&M time window.	02:00
EndTime	string	The end time of the O&M time window.	06:00
VersionLifecycle	string	The version lifecycle.	STABLE
ErrorCode	string	The error code.	mse-100-000
Success	boolean	Indicates whether the request is successful. Valid values: `true`: The request is successful. `false`: The request fails.	true

Examples

Success response

JSON format

{
  "HttpCode": "202",
  "TotalCount": 7,
  "RequestId": "69AD2AA7-DB47-449B-941B-B14409DF****",
  "Message": "OK",
  "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": "subscription",
      "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": "02:00",
        "EndTime": "06:00"
      },
      "VersionLifecycle": "STABLE"
    }
  ],
  "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.