All Products
Search
Document Center

PolarDB:CreateGdnStandbyMember

Last Updated:Sep 10, 2026

Adds a secondary instance to a global database network (GDN).

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region in which the instance resides.

cn-hangzhou

PayType

string

Yes

The billing method of the instance.

  • PREPAY: subscription

  • POSTPAY: pay-as-you-go

PREPAY

ClientToken

string

No

The client token that is used to ensure the idempotence of the request. Make sure that the value is different for each request.

FEA5DC20-6D8A-5979-97AA-FC57546ADC20

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. Unit: 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 unit of the subscription duration. Valid values:

  • Year

  • 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 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

CnClass

string

No

The compute node specifications. This parameter is required for Enterprise Edition instances and is not required for Standard Edition instances.

Enterprise Edition with local disks:

  • 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 with cloud disks:

  • 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)

4 cores, 32 GB

DnClass

string

No

The storage node specifications. This parameter is required for Enterprise Edition instances and is not required for Standard Edition instances.

Enterprise Edition with local disks:

  • 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 with cloud disks:

  • 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)

4 cores, 32 GB

CNNodeCount

string

No

The number of compute nodes.

2

DNNodeCount

string

No

The number of storage nodes.

2

Description

string

No

The description of the instance.

go-to-the-docks-for-french-fries

CloneInstanceName

string

Yes

The name of the source instance.

pxc-***

SourceInstanceRegion

string

Yes

The region in which the source instance resides.

cn-chengdu

Series

string

No

The edition of the instance. Valid values:

  • enterprise: Enterprise Edition.

  • standard: Standard Edition.

enterprise

StorageType

string

No

The storage type.

cloud_auto

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

Id of the request

173CA69A-3513-591D-8A09-C1EA37CBE2D9

DBInstanceName

string

The name of the created instance.

pxc-hzravgpt8q****

OrderId

string

The order ID.

12345

Examples

Success response

JSON format

{
  "RequestId": "173CA69A-3513-591D-8A09-C1EA37CBE2D9",
  "DBInstanceName": "pxc-hzravgpt8q****",
  "OrderId": "12345"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.