All Products
Search

This Product

    PolarDB:RestoreDBInstance

    Document Center

    PolarDB:RestoreDBInstance

    Last Updated:Sep 10, 2026

    Clones 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:RestoreDBInstance

    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. The minimum value is 2.

    2
    DBNodeClass

    string

    No

    The node specifications. Valid values:

    • polarx.x4.medium.2e: 2 cores, 8 GB

    • polarx.x4.large.2e: 4 cores, 16 GB

    • polarx.x8.large.2e: 4 cores, 32 GB

    • polarx.x4.xlarge.2e: 8 cores, 32 GB

    • polarx.x8.xlarge.2e: 8 cores, 64 GB

    • polarx.x4.2xlarge.2e: 16 cores, 64 GB

    • polarx.x8.2xlarge.2e: 16 cores, 128 GB

    • polarx.x4.4xlarge.2e: 32 cores, 128 GB

    • polarx.x8.4xlarge.2e: 32 cores, 256 GB

    • polarx.st.8xlarge.2e: 60 cores, 470 GB

    • polarx.st.12xlarge.2e: 90 cores, 720 GB

    polarx.x4.2xlarge.2d
    ClientToken

    string

    No

    The client token used to ensure the idempotence of the request. Use a different value for each request.

    xxxxxx-xxx
    NetworkType

    string

    No

    The network type. Only VPC is supported.

    vpc
    VPCId

    string

    No

    VPC ID。

    vpc-*****
    VSwitchId

    string

    No

    The vSwitch ID.

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

    integer

    No

    The subscription duration. Specify the number of months or years.

    Note

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

    1
    Period

    string

    No

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

    Month
    ResourceGroupId

    string

    No

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

    null
    AutoRenew

    boolean

    No

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

    • true: Enabled.

    • false: Disabled.

    true
    EngineVersion

    string

    Yes

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

    5.7
    TopologyType

    string

    Yes

    The topology type. Valid values:

    • 3azones: three-zone deployment.

    • 1azone: single-zone deployment.

    3azones
    PrimaryZone

    string

    No

    The primary zone.

    cn-shenzhen-e
    SecondaryZone

    string

    No

    The secondary zone.

    cn-shenzhen-a
    TertiaryZone

    string

    No

    The zone for Three-zone deployment.

    cn-shenzhen-e
    ZoneId

    string

    No

    The zone of the instance.

    cn-hangzhou-a
    CnClass

    string

    No

    The compute node specifications. Valid values:

    • polarx.x4.medium.2e: 2 cores, 8 GB

    • polarx.x4.large.2e: 4 cores, 16 GB

    • polarx.x8.large.2e: 4 cores, 32 GB

    • polarx.x4.xlarge.2e: 8 cores, 32 GB

    • polarx.x8.xlarge.2e: 8 cores, 64 GB

    • polarx.x4.2xlarge.2e: 16 cores, 64 GB

    • polarx.x8.2xlarge.2e: 16 cores, 128 GB

    • polarx.x4.4xlarge.2e: 32 cores, 128 GB

    • polarx.x8.4xlarge.2e: 32 cores, 256 GB

    • polarx.st.8xlarge.2e: 60 cores, 470 GB

    • polarx.st.12xlarge.2e: 90 cores, 720 GB

    polarx.x4.medium.2e
    DnClass

    string

    No

    The storage node specifications. Valid values:

    • mysql.n4.medium.25: 2 cores, 8 GB

    • mysql.n4.large.25: 4 cores, 16 GB

    • mysql.x8.large.25: 4 cores, 32 GB

    • mysql.n4.xlarge.25: 8 cores, 32 GB

    • mysql.x8.xlarge.25: 8 cores, 64 GB

    • mysql.n4.2xlarge.25: 16 cores, 64 GB

    • mysql.x8.2xlarge.25: 16 cores, 128 GB

    • mysql.x4.4xlarge.25: 32 cores, 128 GB

    • mysql.x8.4xlarge.25: 32 cores, 256 GB

    • mysql.st.8xlarge.25: 60 cores, 470 GB

    • mysql.st.12xlarge.25: 90 cores, 720 GB

    mysql.n4.medium.25
    CNNodeCount

    string

    No

    The number of compute nodes.

    2
    DNNodeCount

    string

    No

    The number of storage nodes.

    2
    CloneInstanceName

    string

    Yes

    The name of the source instance.

    pxc-***
    RestoreTime

    string

    No

    The point in time to which you want to restore the instance. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

    2024-10-14T00:00:00Z
    RecoveryTypeCode

    string

    Yes

    The recovery type.

    Clone
    BackupSetId

    string

    No

    The backup set ID.

    111
    BackupSetRegion

    string

    Yes

    The region where the backup set resides.

    cn-chengdu
    SourceInstanceRegion

    string

    Yes

    The region where the source instance resides.

    cn-chengdu
    Series

    string

    No

    The instance series. Valid values:

    • enterprise: Enterprise Edition.

    • standard: Standard Edition.

    enterprise
    StorageType

    string

    No

    The storage type.

    cloud_auto
    GdnRole

    string

    No

    The GDN role.

    standby

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

    9B2F3840-XXXX-XXXX-XXXX-2D5C3A31797C
    DBInstanceName

    string

    The instance name.

    pxc-*********
    OrderId

    string

    The order ID.

    12345

    Examples

    Success response

    JSON format

    {
  "RequestId": "9B2F3840-XXXX-XXXX-XXXX-2D5C3A31797C",
  "DBInstanceName": "pxc-*********",
  "OrderId": "12345"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.