CreateCluster - Microservices Engine - Alibaba Cloud Documentation Center

Creates a Microservices Engine (MSE) instance, such as an MSE ZooKeeper instance or an MSE Nacos instance.

Operation description

Before you call this API operation, you must make sure that you fully understand the billing methods and pricing of MSE.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:CreateCluster	Write	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
PubNetworkFlow	string	No	This parameter is valid only if the ConnectionType parameter is set to `slb`. The value 0 indicates that the Server Load Balancer (SLB) instance is not connected over the Internet. A value greater than 1 indicates the fixed bandwidth that is used to access the SLB instance over the Internet. Unit: Mbit/s. Valid values: 0 to 5000.	0
PubSlbSpecification`deprecated`	string	No	This parameter is obsolete.	slb.s1.small
DiskType`deprecated`	string	No	This parameter is obsolete.	alicloud-disk-ssd
VpcId	string	No	The ID of the virtual private cloud (VPC).	vpc-bp1t50e045b5g7i3p****
NetType	string	Yes	The network type of the MSE instance. Valid values: `privatenet`: VPC `pubnet`: Internet	privatenet
VSwitchId	string	No	The ID of the vSwitch.	vsw-bp17opt4v18sto39k****
InstanceCount	integer	Yes	The number of nodes in the instance. Valid values: 1 to 9. [Professional Edition] The value must be greater than or equal to 3 and must be an odd number. [Developer Edition] The value must be 1. [Serverless Edition] Ignore this parameter.	3
ClusterSpecification	string	Yes	The engine specifications. Valid values: [Professional Edition] `MSE_SC_2_4_60_c`: 2 vCPUs and 4 GB of memory `MSE_SC_1_2_60_c`: 1 vCPU and 2 GB of memory `MSE_SC_4_8_60_c`: 4 vCPUs and 8 GB of memory `MSE_SC_8_16_60_c`: 8 vCPUs and 16 GB of memory `MSE_SC_16_32_60_c`: 16 vCPUs and 32 GB of memory [Developer Edition] `MSE_SC_1_2_60_c`: 1 vCPU and 2 GB of memory `MSE_SC_2_4_60_c`: 2 vCPUs and 4 GB of memory [Serverless Edition] Ignore this parameter or set this parameter to `MSE_SC_SERVERLESS`.	MSE_SC_2_4_60_c
ClusterVersion	string	Yes	The engine version of the instance. Valid values: [Professional Edition] `NACOS_2_0_0` `ZooKeeper_3_8_0` [Developer Edition] `NACOS_2_0_0` `ZooKeeper_3_8_0` [Serverless Edition] `NACOS_2_0_0` `ZooKeeper_3_8_0`	NACOS_2_0_0
ClusterType	string	Yes	The type of the instance. Valid values: ZooKeeper and Nacos-Ans.	Nacos-Ans
Region	string	Yes	The region where the instance resides. Examples: `cn-hangzhou`: China (Hangzhou) `cn-beijing`: China (Beijing) `cn-shanghai`: China (Shanghai) `cn-zhangjiakou`: China (Zhangjiakou) `cn-shenzhen`: China (Shenzhen)	cn-hangzhou
PrivateSlbSpecification`deprecated`	string	No	This parameter is obsolete.	slb.s1.small
ConnectionType	string	No	The network connection type. Valid values: `slb` or `single_eni`. For instances of the Developer Edition in some regions, only the value `single_eni` is supported.	slb
RequestPars	string	No	The extended request parameters in the JSON format.	{}
MseVersion	string	No	Configure this parameter unless otherwise specified. Valid values: `mse_pro`: Professional Edition `mse_dev`: Developer Edition `mse_dev`: Serverless Edition	mse_pro
InstanceName	string	No	The custom name of the instance.	tanshuyingtest001
ResourceGroupId	string	No	The ID of the resource group. For the details of resource groups, see View basic information of a resource group.	rg-aekzcqmoay3dlyq
Tag	object []	No	The tags to add to the resource. You can specify up to 20 tags.
Key	string	No	The key of tag N to add to the resource.	env
Value	string	No	The value of tag N to add to the resource.	prd
ChargeType	string	No	The billing method. Valid values: PREPAY and POSTPAY. Ignore this parameter for serverless instances.	POSTPAY
SecurityGroupType	string	No	The type of the security group to which the instance belongs. This parameter is valid only if the ConnectionType parameter is set to `single_eni`. Valid values: enterprise normal	enterprise
EipEnabled	boolean	No	Specifies whether to enable Internet access (Elastic IP Address) if ConnectionType is set to `single_eni`. Valid values: true false
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	The string object.
RequestId	string	The ID of the request.	dc63-465d-8ef5-20dc18af****
Message	string	The message returned.	The request is successfully processed.
InstanceId	string	The ID of the instance.	mse-cn-st21ri2****
ErrorCode	string	The error code returned if the request failed.	mse-100-000
OrderId	string	The ID of the order.	20574710974****
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

{
  "RequestId": "dc63-465d-8ef5-20dc18af****",
  "Message": "The request is successfully processed.\n",
  "InstanceId": "mse-cn-st21ri2****",
  "ErrorCode": "mse-100-000",
  "OrderId": "20574710974****",
  "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-08-29

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: SecurityGroupType
	Added Input Parameters: EipEnabled

2023-05-09

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: ChargeType

2022-08-11

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	delete Input Parameters: ResourceGroupId
	delete Input Parameters: Tags