CreateGdnInstance - PolarDB - Alibaba Cloud Documentation Center

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceName	string	Yes	The name of the primary instance.	pxc-********
RegionId	string	Yes	The region where the instance resides.	cn-beijing
Description	string	No	The description information.	FASTJSON 2.0.x has been released, faster and more secure, recommend you upgrade.
GdnMode	string	No	The GDN mode.	gdn_mode_master_slave, gdn_mode_bidirectional
RplSyncDdl	boolean	No	Specifies whether to synchronize DDL statements.
RplDmlStrategy	string	No	The DML replication policy.	MERGE, SERIAL, TRANSACTION, SPLIT
RplConflictStrategy	string	No	The conflict strategy.	DIRECT_OVERWRITE, OVERWRITE, IGNORE, INTERRUPT

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	0DBA1657-7607-56D6-BB6D-641BF17CCFDB
Message	string	The returned message. Note This parameter is empty when the request succeeds. If the request fails, an exception message is returned, such as an error code.	****
Success	boolean	Indicates whether the request was successful.	True
Data	object	The instance details.
TaskId	integer	The task ID.	2209883

Examples

Success response

JSON format

{
  "RequestId": "0DBA1657-7607-56D6-BB6D-641BF17CCFDB",
  "Message": "****",
  "Success": true,
  "Data": {
    "TaskId": 2209883
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.