All Products
Search

This Product

    PolarDB:CreateDBInstance

    Document Center

    PolarDB:CreateDBInstance

    Last Updated:Oct 26, 2026

    Creates a PolarDB-X instance.

    Operation description

    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

    polardbx:CreateDBInstance

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region of the instance.

    cn-hangzhou
    PayType

    string

    Yes

    The billing method of the instance. Valid values:

    • PREPAY: subscription

    • POSTPAY: pay-as-you-go

    PREPAY
    DBNodeCount

    integer

    No

    The number of nodes in the instance. Valid values:

    • Standard Edition: 1

    • Enterprise Edition: 2 or greater

    3
    DBNodeClass

    string

    No

    Required when you create a Standard Edition instance. Not required for an Enterprise Edition instance.

    Local disk specifications for Standard Edition:

    • mysql.n8.small.25: 1 vCPU, 8 GB (general-purpose)

    • mysql.n2.medium.25: 2 vCPUs, 4 GB (general-purpose)

    • mysql.n4.medium.25: 2 vCPUs, 8 GB (general-purpose)

    • mysql.n8.medium.25: 2 vCPUs, 16 GB (general-purpose)

    • mysql.n2.large.25: 4 vCPUs, 8 GB (general-purpose)

    • mysql.n4.large.25: 4 vCPUs, 16 GB (general-purpose)

    • mysql.n8.large.25: 4 vCPUs, 32 GB (general-purpose)

    • mysql.n2.xlarge.25: 8 vCPUs, 16 GB (general-purpose)

    • mysql.n4.xlarge.25: 8 vCPUs, 32 GB (general-purpose)

    • mysql.n8.xlarge.25: 8 vCPUs, 64 GB (general-purpose)

    • mysql.n2.2xlarge.25: 16 vCPUs, 32 GB (general-purpose)

    • mysql.n4.2xlarge.25: 16 vCPUs, 64 GB (general-purpose)

    • mysql.n8.2xlarge.25: 16 vCPUs, 128 GB (general-purpose)

    • mysql.x2.medium.25: 2 vCPUs, 4 GB (dedicated)

    • mysql.x4.medium.25: 2 vCPUs, 8 GB (dedicated)

    • mysql.x8.medium.25: 2 vCPUs, 16 GB (dedicated)

    • mysql.x2.large.25: 4 vCPUs, 8 GB (dedicated)

    • mysql.x4.large.25: 4 vCPUs, 16 GB (dedicated)

    • mysql.x8.large.25: 4 vCPUs, 32 GB (dedicated)

    • mysql.x2.xlarge.25: 8 vCPUs, 16 GB (dedicated)

    • mysql.x4.xlarge.25: 8 vCPUs, 32 GB (dedicated)

    • mysql.x8.xlarge.25: 8 vCPUs, 64 GB (dedicated)

    • mysql.x2.2xlarge.25: 16 vCPUs, 32 GB (dedicated)

    • mysql.x4.2xlarge.25: 16 vCPUs, 64 GB (dedicated)

    • mysql.x8.2xlarge.25: 16 vCPUs, 128 GB (dedicated)

    • mysql.x4.4xlarge.25: 32 vCPUs, 128 GB (dedicated)

    • mysql.x8.4xlarge.25: 32 vCPUs, 256 GB (dedicated)

    • mysql.x4.8xlarge.25: 64 vCPUs, 256 GB (dedicated)

    • mysql.x8.8xlarge.25: 64 vCPUs, 512 GB (dedicated)

    • mysql.st.12xlarge.25: 90 vCPUs, 720 GB (dedicated)

    Cloud disk specifications for Standard Edition:

    • polarx.mysql.n2.medium.c25: 2 vCPUs, 4 GB (general-purpose)

    • polarx.mysql.n4.medium.c25: 2 vCPUs, 8 GB (general-purpose)

    • polarx.mysql.n8.medium.c25: 2 vCPUs, 16 GB (general-purpose)

    • polarx.mysql.n2.large.c25: 4 vCPUs, 8 GB (general-purpose)

    • polarx.mysql.n4.large.c25: 4 vCPUs, 16 GB (general-purpose)

    • polarx.mysql.n8.large.c25: 4 vCPUs, 32 GB (general-purpose)

    • polarx.mysql.n2.xlarge.c25: 8 vCPUs, 16 GB (general-purpose)

    • polarx.mysql.n4.xlarge.c25: 8 vCPUs, 32 GB (general-purpose)

    • polarx.mysql.n8.xlarge.c25: 8 vCPUs, 64 GB (general-purpose)

    • polarx.mysql.x2.medium.c25: 2 vCPUs, 4 GB (dedicated)

    • polarx.mysql.x4.medium.c25: 2 vCPUs, 8 GB (dedicated)

    • polarx.mysql.x8.medium.c25: 2 vCPUs, 16 GB (dedicated)

    • polarx.mysql.x2.large.c25: 4 vCPUs, 8 GB (dedicated)

    • polarx.mysql.x4.large.c25: 4 vCPUs, 16 GB (dedicated)

    • polarx.mysql.x8.large.c25: 4 vCPUs, 32 GB (dedicated)

    • polarx.mysql.x2.xlarge.c25: 8 vCPUs, 16 GB (dedicated)

    • polarx.mysql.x4.xlarge.c25: 8 vCPUs, 32 GB (dedicated)

    • polarx.mysql.x8.xlarge.c25: 8 vCPUs, 64 GB (dedicated)

    • polarx.mysql.x2.2xlarge.c25: 16 vCPUs, 32 GB (dedicated)

    • polarx.mysql.x4.2xlarge.c25: 16 vCPUs, 64 GB (dedicated)

    • polarx.mysql.x8.2xlarge.c25: 16 vCPUs, 128 GB (dedicated)

    • polarx.mysql.x2.4xlarge.c25: 32 vCPUs, 64 GB (dedicated)

    • polarx.mysql.x4.4xlarge.c25: 32 vCPUs, 128 GB (dedicated)

    • polarx.mysql.x8.4xlarge.c25: 32 vCPUs, 256 GB (dedicated)

    • polarx.mysql.x2.8xlarge.c25: 64 vCPUs, 128 GB (dedicated)

    • polarx.mysql.x4.8xlarge.c25: 64 vCPUs, 256 GB (dedicated)

    • polarx.mysql.x8.8xlarge.c25: 64 vCPUs, 512 GB (dedicated)

    polarx.x4.2xlarge.2d
    ClientToken

    string

    No

    The client token that is used to ensure the idempotence of the request. You must specify a unique token for each request.

    xxxxxx-xxx
    NetworkType

    string

    No

    The network type of the instance. Only VPC is supported.

    vpc
    VPCId

    string

    No

    The VPC ID.

    vpc-*****
    VSwitchId

    string

    No

    The vSwitch ID.

    vsw-*********
    UsedTime

    integer

    No

    The subscription duration. This parameter is required when the billing method is set to subscription.

    Note

    If Period is set to Year, valid values are 1, 2, and 3.

    1
    Period

    string

    No

    The billing cycle. Valid values for subscription instances: Year and Month. Default value for pay-as-you-go instances: Hour.

    Month
    ResourceGroupId

    string

    No

    The resource group ID. This parameter is not supported and can be left empty.

    null
    AutoRenew

    boolean

    No

    Specifies whether to enable auto-renewal. Default value: true. Valid values:

    • true: Enables auto-renewal.

    • false: Disables auto-renewal.

    true
    EngineVersion

    string

    Yes

    The MySQL DPI engine version. Valid values: 5.7 and 8.0.

    5.7
    IsReadDBInstance

    boolean

    No

    Specifies whether the instance is a read-only instance. Valid values:

    • true: Yes.

    • false: No.

    false
    PrimaryDBInstanceName

    string

    No

    The name of the primary instance. This parameter is required if the instance is a read-only instance.

    pxc-*********
    TopologyType

    string

    Yes

    The topology type. Valid values:

    • 3azones: Three-zone deployment (three active zones).

    • 1azone: Single active zone.

    3azones
    PrimaryZone

    string

    No

    The primary zone.

    cn-shenzhen-e
    SecondaryZone

    string

    No

    The secondary zone.

    cn-shenzhen-a
    TertiaryZone

    string

    No

    The third active zone in a Three-zone deployment.

    cn-shenzhen-e
    ZoneId

    string

    No

    The zone of the instance.

    cn-hangzhou-a
    CnClass

    string

    No

    The specifications of compute nodes. Required when you create an Enterprise Edition instance. Not required for a Standard Edition instance.

    Local node specifications for Enterprise Edition:

    • polarx.x4.medium.2e: 2 vCPUs, 8 GB (general-purpose)

    • polarx.x4.large.2e: 4 vCPUs, 16 GB (general-purpose)

    • polarx.x4.xlarge.2e: 8 vCPUs, 32 GB (general-purpose)

    • polarx.x4.2xlarge.2e: 16 vCPUs, 64 GB (general-purpose)

    • polarx.x8.large.2e: 4 vCPUs, 32 GB (dedicated)

    • polarx.x2.large.2x: 8 vCPUs, 16 GB (dedicated)

    • polarx.x4.xlarge.2x: 8 vCPUs, 32 GB (dedicated)

    • polarx.x8.xlarge.2e: 8 vCPUs, 64 GB (dedicated)

    • polarx.x8.2xlarge.2e: 16 vCPUs, 128 GB (dedicated)

    • polarx.x4.4xlarge.2e: 32 vCPUs, 128 GB (dedicated)

    • polarx.x8.4xlarge.2e: 32 vCPUs, 256 GB (dedicated)

    • polarx.st.8xlarge.2e: 60 vCPUs, 470 GB (dedicated)

    • polarx.st.12xlarge.2e: 90 vCPUs, 720 GB (dedicated)

    Cloud node specifications for Enterprise Edition:

    • polarx.x4.medium.c2e: 2 vCPUs, 8 GB (general-purpose)

    • polarx.x4.large.c2e: 4 vCPUs, 16 GB (general-purpose)

    • polarx.x4.xlarge.c2e: 8 vCPUs, 32 GB (general-purpose)

    • polarx.x4.2xlarge.c2e: 16 vCPUs, 64 GB (general-purpose)

    • polarx.x8.large.c2e: 4 vCPUs, 32 GB (dedicated)

    • polarx.x2.large.c2x: 8 vCPUs, 16 GB (dedicated)

    • polarx.x4.xlarge.c2x: 8 vCPUs, 32 GB (dedicated)

    • polarx.x8.xlarge.c2e: 8 vCPUs, 64 GB (dedicated)

    • polarx.x8.2xlarge.c2e: 16 vCPUs, 128 GB (dedicated)

    • polarx.x4.4xlarge.c2e: 32 vCPUs, 128 GB (dedicated)

    • polarx.x8.4xlarge.c2e: 32 vCPUs, 256 GB (dedicated)

    • polarx.st.8xlarge.c2e: 60 vCPUs, 470 GB (dedicated)

    • polarx.st.12xlarge.c2e: 90 vCPUs, 720 GB (dedicated)

    polarx.x4.medium.2e
    DnClass

    string

    No

    The specifications of storage nodes. Required when you create an Enterprise Edition instance. Not required for a Standard Edition instance.

    Local node specifications for Enterprise Edition:

    • mysql.n2.medium.25: 2 vCPUs, 4 GB (general-purpose)

    • mysql.n4.medium.25: 2 vCPUs, 8 GB (general-purpose)

    • mysql.n2.large.25: 4 vCPUs, 8 GB (general-purpose)

    • mysql.n4.large.25: 4 vCPUs, 16 GB (general-purpose)

    • mysql.n4.xlarge.25: 8 vCPUs, 32 GB (general-purpose)

    • mysql.n4.2xlarge.25: 16 vCPUs, 64 GB (general-purpose)

    • mysql.x4.large.25: 4 vCPUs, 16 GB (dedicated)

    • mysql.x8.large.25: 4 vCPUs, 32 GB (dedicated)

    • mysql.x2.xlarge.25: 8 vCPUs, 16 GB (dedicated)

    • mysql.x8.xlarge.25: 8 vCPUs, 64 GB (dedicated)

    • mysql.x8.2xlarge.25: 16 vCPUs, 128 GB (dedicated)

    • mysql.x4.4xlarge.25: 32 vCPUs, 128 GB (dedicated)

    • mysql.x8.4xlarge.25: 32 vCPUs, 256 GB (dedicated)

    • mysql.st.8xlarge.25: 60 vCPUs, 470 GB (dedicated)

    • mysql.st.12xlarge.25: 90 vCPUs, 720 GB (dedicated)

    • mysql.x8.45xlarge.25: 180 vCPUs, 1440 GB (dedicated)

    • mysql.x8.60xlarge.25: 240 vCPUs, 1920 GB (dedicated)

    Cloud node specifications for Enterprise Edition:

    • polarx.mysql.n2.medium.c25: 2 vCPUs, 4 GB (general-purpose)

    • polarx.mysql.n4.medium.c25: 2 vCPUs, 8 GB (general-purpose)

    • polarx.mysql.n2.large.c25: 4 vCPUs, 8 GB (general-purpose)

    • polarx.mysql.n4.large.c25: 4 vCPUs, 16 GB (general-purpose)

    • polarx.mysql.n4.xlarge.c25: 8 vCPUs, 32 GB (general-purpose)

    • polarx.mysql.n4.2xlarge.c25: 16 vCPUs, 64 GB (general-purpose)

    • polarx.mysql.x4.large.c25: 4 vCPUs, 16 GB (dedicated)

    • polarx.mysql.x8.large.c25: 4 vCPUs, 32 GB (dedicated)

    • polarx.mysql.x2.xlarge.c25: 8 vCPUs, 16 GB (dedicated)

    • polarx.mysql.x8.xlarge.c25: 8 vCPUs, 64 GB (dedicated)

    • polarx.mysql.x8.2xlarge.c25: 16 vCPUs, 128 GB (dedicated)

    • polarx.mysql.x4.4xlarge.c25: 32 vCPUs, 128 GB (dedicated)

    • polarx.mysql.x8.4xlarge.c25: 32 vCPUs, 256 GB (dedicated)

    • polarx.mysql.st.8xlarge.c25: 60 vCPUs, 470 GB (dedicated)

    • polarx.mysql.st.12xlarge.c25: 90 vCPUs, 720 GB (dedicated)

    • polarx.mysql.x8.45xlarge.c25: 180 vCPUs, 1440 GB (dedicated)

    • polarx.mysql.x8.60xlarge.c25: 240 vCPUs, 1920 GB (dedicated)

    mysql.n4.medium.25
    CNNodeCount

    integer

    No

    The number of compute nodes.

    2
    DNNodeCount

    integer

    No

    The number of storage nodes.

    2
    IsColumnarReadDBInstance

    boolean

    No

    Specifies whether the instance to be created is a column store read-only instance.

    true
    Series

    string

    No

    The edition of the instance. Valid values:

    • enterprise: Enterprise Edition

    • standard: Standard Edition

    enterprise
    DnStorageSpace

    string

    No

    The disk space of the storage nodes.

    1500
    ExtraParams

    object

    No

    The extra parameters.

    string

    No

    The extra parameters.

    xxxx
    Description

    string

    No

    The description of the database.

    ods_api_apidata_mobilegame_pay_api_di
    OriginMinorVersion

    string

    No

    The minor engine version. This parameter is generally not required.

    polardb-2.4.0_standard_xcluster8.4.20-20260331
    StorageType

    string

    No

    The storage type. Valid values:

    • custom_local_ssd: local disk

    • cloud_auto: cloud disk

    cloud_auto

    Response elements

    Element

    Type

    Description

    Example

    object

    DBInstanceName

    string

    The name of the created instance.

    pxc-*********
    RequestId

    string

    The request ID.

    9B2F3840-5C98-475C-B269-2D5C3A31797C
    OrderId

    string

    The order ID.

    12345

    Examples

    Success response

    JSON format

    {
  "DBInstanceName": "pxc-*********",
  "RequestId": "9B2F3840-5C98-475C-B269-2D5C3A31797C",
  "OrderId": "12345"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.