MSE QueryClusterSpecification API Reference - Microservices Engine - Alibaba Cloud - Microservices Engine

Queries the list of supported cluster specifications.

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:QueryClusterSpecification

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ConnectType	string	No	The network type. Valid values: slb eni Valid values: eni : Elastic Network Interface (ENI) access. slb : Server Load Balancer (SLB) access.	slb
MseVersion	string	No	The Microservices Engine (MSE) cluster version to be activated. Valid values: mse_pro: Professional Edition. mse_dev: Developer Edition.	mse_pro
AcceptLanguage	string	No	The language of the returned information. Valid values: zh: Chinese. en: English.	zh

Response elements

Element	Type	Description	Example
	object	The data structure.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	EE5C32A1-BC0E-4B79-817C-103E4EDF****
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
ErrorCode	string	The error code.	mse-100-000
Code	integer	The return value.	200
Message	string	The message.	Request processed successfully
Data	array<object>	The data overview.
	object	The returned results.
ClusterSpecificationName	string	The available engine specifications.	MSE_SC_1_2_200_c
MemoryCapacity	string	The memory size for this specification. Unit: GB.	2
CpuCapacity	string	The number of CPU cores for this specification.	1

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "EE5C32A1-BC0E-4B79-817C-103E4EDF****",
  "Success": true,
  "ErrorCode": "mse-100-000",
  "Code": 200,
  "Message": "The request is processed successfully.",
  "Data": [
    {
      "ClusterSpecificationName": "MSE_SC_1_2_200_c",
      "MemoryCapacity": "2",
      "CpuCapacity": "1"
    }
  ]
}

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.