All Products
Search

This Product

    Microservices Engine:CreateCluster

    Document Center

    Microservices Engine:CreateCluster

    Last Updated:Jun 26, 2026

    Creates a registry and configuration center cluster, such as ZooKeeper or Nacos.

    Operation description

    Before using this operation, make sure that you fully understand the billing methods and pricing of Microservices Engine (MSE).

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

    create

    *Cluster

    acs:mse:{#regionId}:{#accountId}:instance/*

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    PubNetworkFlow

    string

    No

    Valid when ConnectionType is set to slb. A value of 0 indicates that no Internet-facing SLB instance is created. A value of 1 or greater specifies the fixed bandwidth of the Internet-facing SLB instance, in Mbit/s.

    Valid values: 0 to 5000.

    0
    PubSlbSpecification deprecated

    string

    No

    No longer used.

    slb.s1.small
    DiskType deprecated

    string

    No

    No longer used.

    alicloud-disk-ssd
    VpcId

    string

    No

    VPC ID。

    vpc-bp1t50e045b5g7i3p****
    NetType

    string

    Yes

    The network type. Valid values:

    • privatenet: virtual private cloud (VPC).

    • pubnet: Internet.

    privatenet
    VSwitchId

    string

    No

    The vSwitch ID.

    vsw-bp17opt4v18sto39k****
    InstanceCount

    integer

    Yes

    The number of instance nodes. Valid values: 1 to 9. [Professional Edition]

    • NACOS_2_0_0: Nacos 2.x.x.

    • ZooKeeper_3_8_0: ZooKeeper 3.8.x. [Developer Edition]

    • NACOS_2_0_0: Nacos 2.x.

    • ZooKeeper_3_8_0: ZooKeeper 3.8.x. [Serverless Edition]

    • NACOS_2_0_0: Nacos 2.x.

    • ZooKeeper_3_8_0: ZooKeeper 3.8.x.

    3
    ClusterSpecification

    string

    Yes

    The engine specifications. Valid values:

    MSE_SC_2_4_60_c
    ClusterVersion

    string

    Yes

    The cluster version. Valid values:

    NACOS_2_0_0
    ClusterType

    string

    Yes

    The cluster type, such as ZooKeeper or Nacos-Ans.

    Nacos-Ans
    Region

    string

    No

    The region where the cluster resides. Valid values include but are not limited to:

    • ap-southeast-1: Singapore

    • cn-beijing: Beijing

    • cn-shanghai: Shanghai

    • cn-zhangjiakou: Zhangjiakou

    • cn-shenzhen: Shenzhen.

    cn-hangzhou
    PrivateSlbSpecification deprecated

    string

    No

    No longer used.

    slb.s1.small
    ConnectionType

    string

    No

    The network access type. Valid values: slb and single_eni. In some regions, the Developer Edition supports only the single_eni type.

    slb
    RequestPars

    string

    No

    The extended request parameters in JSON format.

    {}
    MseVersion

    string

    No

    Required in most cases. Valid values:

    • mse_pro: Professional Edition.

    • mse_dev: Developer Edition.

    • mse_serverless: Serverless Edition.

    Valid values:

    • mse_dev :

      Developer Edition.

    • mse_serverless :

      Serverless Edition.

    • mse_pro :

      Professional Edition.

    mse_pro
    InstanceName

    string

    No

    The custom name of the instance.

    tanshuyingtest001
    ResourceGroupId

    string

    No

    The resource group ID. For more information about resource groups, see View basic information of a resource group.

    rg-aekzcqmoay3dlyq
    Tag

    array<object>

    No

    The list of tags to add. 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
    ChargeType

    string

    No

    The billing method. Valid values: PREPAY (subscription) and POSTPAY (pay-as-you-go).

    This parameter is ignored for the Serverless Edition.

    Valid values:

    • PREPAY :

      Subscription.

    • POSTPAY :

      Pay-as-you-go.

    POSTPAY
    SecurityGroupType

    string

    No

    Valid when ConnectionType is set to single_eni. Specifies the type of the security group to which the instance belongs.

    enterprise
    EipEnabled

    boolean

    No

    Valid when ConnectionType is set to single_eni. Specifies whether to enable public network access by using an elastic IP address (EIP).

    Valid values:

    • true :

      true

    • false :

      false

    AcceptLanguage

    string

    No

    The language of the response. Valid values:

    • zh: Chinese

    • en: English.

    zh

    Response elements

    Element

    Type

    Description

    Example

    object

    The response object.

    RequestId

    string

    The request ID.

    dc63-465d-8ef5-20dc18af****
    Message

    string

    The returned message.

    The request is processed successfully.
    InstanceId

    string

    The instance ID.

    mse-cn-st21ri2****
    ErrorCode

    string

    The error code.

    mse-100-000
    OrderId

    string

    The order ID.

    20574710974****
    Success

    boolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.

    • false: The request failed.

    true

    Examples

    Success response

    JSON format

    {
  "RequestId": "dc63-465d-8ef5-20dc18af****",
  "Message": "The request is processed successfully.",
  "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
    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.