All Products
Search

This Product

    PolarDB:CreateDBInstance

    Document Center

    PolarDB:CreateDBInstance

    Last Updated:Sep 10, 2026

    Calls the CreateDBInstance operation to create 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 where the instance resides.

    cn-hangzhou
    PayType

    string

    Yes

    The billing method of the instance.

    • PREPAY: Subscription

    • POSTPAY: Pay-as-you-go

    PREPAY
    DBNodeCount

    integer

    No

    The number of instance nodes:

    • Standard Edition: 1

    • Enterprise Edition: >=2

    3
    DBNodeClass

    string

    No

    Required for creating Standard Edition instances. Not required for Enterprise Edition.

    Standard Edition local disk specifications:

    • mysql.n8.small.25: 1 Core 8 GB (General Purpose)

    • mysql.n2.medium.25: 2 Cores 4 GB (General Purpose)

    • mysql.n4.medium.25: 2 Cores 8 GB (General Purpose)

    • mysql.n8.medium.25: 2 Cores 16 GB (General Purpose)

    • mysql.n2.large.25: 4 Cores 8 GB (General Purpose)

    • mysql.n4.large.25: 4 Cores 16 GB (General Purpose)

    • mysql.n8.large.25: 4 Cores 32 GB (General Purpose)

    • mysql.n2.xlarge.25: 8 Cores 16 GB (General Purpose)

    • mysql.n4.xlarge.25: 8 Cores 32 GB (General Purpose)

    • mysql.n8.xlarge.25: 8 Cores 64 GB (General Purpose)

    • mysql.n2.2xlarge.25: 16 Cores 32 GB (General Purpose)

    • mysql.n4.2xlarge.25: 16 Cores 64 GB (General Purpose)

    • mysql.n8.2xlarge.25: 16 Cores 128 GB (General Purpose)

    • mysql.x2.medium.25: 2 Cores 4 GB (Dedicated)

    • mysql.x4.medium.25: 2 Cores 8 GB (Dedicated)

    • mysql.x8.medium.25: 2 Cores 16 GB (Dedicated)

    • mysql.x2.large.25: 4 Cores 8 GB (Dedicated)

    • mysql.x4.large.25: 4 Cores 16 GB (Dedicated)

    • mysql.x8.large.25: 4 Cores 32 GB (Dedicated)

    • mysql.x2.xlarge.25: 8 Cores 16 GB (Dedicated)

    • mysql.x4.xlarge.25: 8 Cores 32 GB (Dedicated)

    • mysql.x8.xlarge.25: 8 Cores 64 GB (Dedicated)

    • mysql.x2.2xlarge.25: 16 Cores 32 GB (Dedicated)

    • mysql.x4.2xlarge.25: 16 Cores 64 GB (Dedicated)

    • mysql.x8.2xlarge.25: 16 Cores 128 GB (Dedicated)

    • mysql.x4.4xlarge.25: 32 Cores 128 GB (Dedicated)

    • mysql.x8.4xlarge.25: 32 Cores 256 GB (Dedicated)

    • mysql.x4.8xlarge.25: 64 Cores 256 GB (Dedicated)

    • mysql.x8.8xlarge.25: 64 Cores 512 GB (Dedicated)

    • mysql.st.12xlarge.25: 90 Cores 720 GB (Dedicated)

    Standard Edition cloud disk specifications:

    • polarx.mysql.n2.medium.c25: 2 Cores 4 GB (General Purpose)

    • polarx.mysql.n4.medium.c25: 2 Cores 8 GB (General Purpose)

    • polarx.mysql.n8.medium.c25: 2 Cores 16 GB (General Purpose)

    • polarx.mysql.n2.large.c25: 4 Cores 8 GB (General Purpose)

    • polarx.mysql.n4.large.c25: 4 Cores 16 GB (General Purpose)

    • polarx.mysql.n8.large.c25: 4 Cores 32 GB (General Purpose)

    • polarx.mysql.n2.xlarge.c25: 8 Cores 16 GB (General Purpose)

    • polarx.mysql.n4.xlarge.c25: 8 Cores 32 GB (General Purpose)

    • polarx.mysql.n8.xlarge.c25: 8 Cores 64 GB (General Purpose)

    • polarx.mysql.x2.medium.c25: 2 Cores 4 GB (Dedicated)

    • polarx.mysql.x4.medium.c25: 2 Cores 8 GB (Dedicated)

    • polarx.mysql.x8.medium.c25: 2 Cores 16 GB (Dedicated)

    • polarx.mysql.x2.large.c25: 4 Cores 8 GB (Dedicated)

    • polarx.mysql.x4.large.c25: 4 Cores 16 GB (Dedicated)

    • polarx.mysql.x8.large.c25: 4 Cores 32 GB (Dedicated)

    • polarx.mysql.x2.xlarge.c25: 8 Cores 16 GB (Dedicated)

    • polarx.mysql.x4.xlarge.c25: 8 Cores 32 GB (Dedicated)

    • polarx.mysql.x8.xlarge.c25: 8 Cores 64 GB (Dedicated)

    • polarx.mysql.x2.2xlarge.c25: 16 Cores 32 GB (Dedicated)

    • polarx.mysql.x4.2xlarge.c25: 16 Cores 64 GB (Dedicated)

    • polarx.mysql.x8.2xlarge.c25: 16 Cores 128 GB (Dedicated)

    • polarx.mysql.x2.4xlarge.c25: 32 Cores 64 GB (Dedicated)

    • polarx.mysql.x4.4xlarge.c25: 32 Cores 128 GB (Dedicated)

    • polarx.mysql.x8.4xlarge.c25: 32 Cores 256 GB (Dedicated)

    • polarx.mysql.x2.8xlarge.c25: 64 Cores 128 GB (Dedicated)

    • polarx.mysql.x4.8xlarge.c25: 64 Cores 256 GB (Dedicated)

    • polarx.mysql.x8.8xlarge.c25: 64 Cores 512 GB (Dedicated)

    polarx.x4.2xlarge.2d
    ClientToken

    string

    No

    The idempotency token. Ensure that a unique value is used for each creation request.

    xxxxxx-xxx
    NetworkType

    string

    No

    The network type. 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. You can specify the number of months or years for prepaid instances.

    Note

    When Period is set to Year, valid values for this parameter are 1, 2, and 3.

    1
    Period

    string

    No

    The billing cycle. For subscription instances, valid values are Year and Month. For pay-as-you-go instances, the default value is Hour.

    Month
    ResourceGroupId

    string

    No

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

    null
    AutoRenew

    boolean

    No

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

    • true: Enable

    • false: Disable

    true
    EngineVersion

    string

    Yes

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

    5.7
    IsReadDBInstance

    boolean

    No

    Specifies whether the instance is a read-only instance.

    • true: Yes

    • false: No

    false
    PrimaryDBInstanceName

    string

    No

    The primary instance must be specified if the instance is a read-only instance.

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

    string

    Yes

    The topology type:

    • 3azones: Three availability zones

    • 1azone: Single availability zone

    3azones
    PrimaryZone

    string

    No

    The primary availability zone.

    cn-shenzhen-e
    SecondaryZone

    string

    No

    The secondary availability zone.

    cn-shenzhen-a
    TertiaryZone

    string

    No

    The tertiary availability zone.

    cn-shenzhen-e
    ZoneId

    string

    No

    The availability zone of the instance.

    cn-hangzhou-a
    CnClass

    string

    No

    The compute node specification. Required for creating Enterprise Edition instances. Not required for Standard Edition.

    Enterprise Edition local disk:

    • polarx.x4.medium.2e: 2 Cores 8 GB (General Purpose)

    • polarx.x4.large.2e: 4 Cores 16 GB (General Purpose)

    • polarx.x4.xlarge.2e: 8 Cores 32 GB (General Purpose)

    • polarx.x4.2xlarge.2e: 16 Cores 64 GB (General Purpose)

    • polarx.x8.large.2e: 4 Cores 32 GB (Dedicated)

    • polarx.x2.large.2x: 8 Cores 16 GB (Dedicated)

    • polarx.x4.xlarge.2x: 8 Cores 32 GB (Dedicated)

    • polarx.x8.xlarge.2e: 8 Cores 64 GB (Dedicated)

    • polarx.x8.2xlarge.2e: 16 Cores 128 GB (Dedicated)

    • polarx.x4.4xlarge.2e: 32 Cores 128 GB (Dedicated)

    • polarx.x8.4xlarge.2e: 32 Cores 256 GB (Dedicated)

    • polarx.st.8xlarge.2e: 60 Cores 470 GB (Dedicated)

    • polarx.st.12xlarge.2e: 90 Cores 720 GB (Dedicated)

    Enterprise Edition cloud disk:

    • polarx.x4.medium.c2e: 2 Cores 8 GB (General Purpose)

    • polarx.x4.large.c2e: 4 Cores 16 GB (General Purpose)

    • polarx.x4.xlarge.c2e: 8 Cores 32 GB (General Purpose)

    • polarx.x4.2xlarge.c2e: 16 Cores 64 GB (General Purpose)

    • polarx.x8.large.c2e: 4 Cores 32 GB (Dedicated)

    • polarx.x2.large.c2x: 8 Cores 16 GB (Dedicated)

    • polarx.x4.xlarge.c2x: 8 Cores 32 GB (Dedicated)

    • polarx.x8.xlarge.c2e: 8 Cores 64 GB (Dedicated)

    • polarx.x8.2xlarge.c2e: 16 Cores 128 GB (Dedicated)

    • polarx.x4.4xlarge.c2e: 32 Cores 128 GB (Dedicated)

    • polarx.x8.4xlarge.c2e: 32 Cores 256 GB (Dedicated)

    • polarx.st.8xlarge.c2e: 60 Cores 470 GB (Dedicated)

    • polarx.st.12xlarge.c2e: 90 Cores 720 GB (Dedicated)

    polarx.x4.medium.2e
    DnClass

    string

    No

    The storage node specification. Required for creating Enterprise Edition instances. Not required for Standard Edition.

    Enterprise Edition local disk:

    • mysql.n2.medium.25: 2 Cores 4 GB (General Purpose)

    • mysql.n4.medium.25: 2 Cores 8 GB (General Purpose)

    • mysql.n2.large.25: 4 Cores 8 GB (General Purpose)

    • mysql.n4.large.25: 4 Cores 16 GB (General Purpose)

    • mysql.n4.xlarge.25: 8 Cores 32 GB (General Purpose)

    • mysql.n4.2xlarge.25: 16 Cores 64 GB (General Purpose)

    • mysql.x4.large.25: 4 Cores 16 GB (Dedicated)

    • mysql.x8.large.25: 4 Cores 32 GB (Dedicated)

    • mysql.x2.xlarge.25: 8 Cores 16 GB (Dedicated)

    • mysql.x8.xlarge.25: 8 Cores 64 GB (Dedicated)

    • mysql.x8.2xlarge.25: 16 Cores 128 GB (Dedicated)

    • mysql.x4.4xlarge.25: 32 Cores 128 GB (Dedicated)

    • mysql.x8.4xlarge.25: 32 Cores 256 GB (Dedicated)

    • mysql.st.8xlarge.25: 60 Cores 470 GB (Dedicated)

    • mysql.st.12xlarge.25: 90 Cores 720 GB (Dedicated)

    • mysql.x8.45xlarge.25: 180 Cores 1440 GB (Dedicated)

    • mysql.x8.60xlarge.25: 240 Cores 1920 GB (Dedicated)

    Enterprise Edition cloud disk:

    • polarx.mysql.n2.medium.c25: 2 Cores 4 GB (General Purpose)

    • polarx.mysql.n4.medium.c25: 2 Cores 8 GB (General Purpose)

    • polarx.mysql.n2.large.c25: 4 Cores 8 GB (General Purpose)

    • polarx.mysql.n4.large.c25: 4 Cores 16 GB (General Purpose)

    • polarx.mysql.n4.xlarge.c25: 8 Cores 32 GB (General Purpose)

    • polarx.mysql.n4.2xlarge.c25: 16 Cores 64 GB (General Purpose)

    • polarx.mysql.x4.large.c25: 4 Cores 16 GB (Dedicated)

    • polarx.mysql.x8.large.c25: 4 Cores 32 GB (Dedicated)

    • polarx.mysql.x2.xlarge.c25: 8 Cores 16 GB (Dedicated)

    • polarx.mysql.x8.xlarge.c25: 8 Cores 64 GB (Dedicated)

    • polarx.mysql.x8.2xlarge.c25: 16 Cores 128 GB (Dedicated)

    • polarx.mysql.x4.4xlarge.c25: 32 Cores 128 GB (Dedicated)

    • polarx.mysql.x8.4xlarge.c25: 32 Cores 256 GB (Dedicated)

    • polarx.mysql.st.8xlarge.c25: 60 Cores 470 GB (Dedicated)

    • polarx.mysql.st.12xlarge.c25: 90 Cores 720 GB (Dedicated)

    • polarx.mysql.x8.45xlarge.c25: 180 Cores 1440 GB (Dedicated)

    • polarx.mysql.x8.60xlarge.c25: 240 Cores 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 columnar read-only instance.

    true
    Series

    string

    No

    Enterprise Edition: enterprise Standard Edition: standard

    enterprise
    DnStorageSpace

    string

    No

    The disk space size of the storage node.

    1500
    ExtraParams

    object

    No

    Additional parameters.

    string

    No

    Additional parameters.

    xxxx
    Description

    string

    No

    The description of the database.

    ods_api_apidata_mobilegame_pay_api_di
    OriginMinorVersion

    string

    No

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

    polardb-2.4.0_standard_xcluster8.4.20-20260331
    StorageType

    string

    No

    The storage type.

    • Local disk: custom_local_ssd

    • Cloud disk: cloud_auto

    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.