CreateDrdsDB - PolarDB - Alibaba Cloud Documentation Center

Creates a DRDS database.

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

drds:CreateDrdsDB

create

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None

Request parameters

Parameter	Type	Required	Description	Example
DrdsInstanceId	string	Yes	The instance ID.	drdshbgal154****
DbName	string	No	The database name.	testdb
Encode	string	No	The encoding used by the database.	utf8
Password	string	No	The password used to access the database.	drds_sample_password
Type	string	No	The sharding method of the database. Valid values: HORIZONTAL: horizontal sharding, which is commonly known as table and database sharding. VERTICAL: vertical partitioning.	HORIZONTAL
DbInstType	string	No	The type of the attached storage. Currently, only RDS is supported.	RDS
DbInstanceIsCreating	boolean	No	Specifies whether the RDS instances involved in database creation are being created.	false
AccountName	string	No	This parameter is used only for vertical partitioning. It specifies the name of an account that has access permissions on the corresponding databases across all RDS instances in a vertical partitioning scenario.	drds_sample_account
RdsInstance	array	No	The list of RDS instances.	["drds_sample_rds_id1", "drds_sample_rds_id2"]
	string	No	This parameter is required only for horizontal sharding. The value is a string in JSON array format.	["drds_sample_rds_id1", "drds_sample_rds_id2"]
RdsSuperAccount	array<object>	No	The list of RDS superuser account information.
	object	No
Password	string	No	The password of the RDS superuser account.	drds_sample_rds_super_password
DbInstanceId	string	No	The RDS instance ID.	drds_sample_rds_id
AccountName	string	No	The name of the RDS superuser account.	drds_sample_rds_super_account
InstDbName	array<object>	No	The list of databases.
	object	No
DbInstanceId	string	No	The ID of the RDS instance to be vertically partitioned. This parameter is used only for vertical partitioning.	drds_sample_rds_id
ShardDbName	array	No	The list of sharded databases.	["drds_sample_db1", "drds_sample_db2"]
	string	No	The list of databases on the corresponding RDS instance that need to be vertically partitioned. The value is a string in JSON array format. This parameter is used only for vertical partitioning.	["db1", "db2"]

Response elements

Element	Type	Description	Example
	object
Success	boolean	The request result.	true
RequestId	string	The request ID.	FF13E47D-4E38-4A5A-BA68-32A554AD45T6

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "FF13E47D-4E38-4A5A-BA68-32A554AD45T6"
}

Error codes

HTTP status code	Error code	Error message
500	InternalError	The request processing has failed due to some unknown error.
404	InvalidInstance.CreateDbForSlave	Db Creation in slave drds instance not support.
404	InvalidParameter.InstDbName	The parameter InstDbName is empty

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.