CheckDBNameAvailable - ApsaraDB RDS - Alibaba Cloud Documentation Center

You can call the CheckDBNameAvailable operation to check whether a database name is duplicate and conforms to the naming conventions on an ApsaraDB RDS instance.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
Condition keyword: refers to the condition keyword defined by the cloud product itself.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operate	access level	Resource type	conditional keyword	Association operation
rds:CheckDBNameAvailable	READ	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	without

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOCzxxxxxxxxxx
DBInstanceId	string	Yes	The ID of the instance.	rm-t4n3axxxxx
DBName	string	Yes	The database name to query.	test1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request. NoteIf this operation returns only the ID of the request, the database name can be used. Otherwise, an error message is returned to indicate that the database name is duplicate or does not conform to the naming conventions.	6EF82B07-28D2-48D1-B5D6-7E78FED277C7

Example

Normal return example

JSONFormat

{
  "RequestId": "6EF82B07-28D2-48D1-B5D6-7E78FED277C7"
}

Error codes

For a list of error codes, visit the API error center.

Change history

Change time

Summary of changes

Operate

2022-09-05

The error codes of the API operation has changed

Change item	Change content
Error Codes	The error codes of the API operation has changed
	Error Codes400 change