CheckDBName - PolarDB - Alibaba Cloud Documentation Center

Checks whether a database name is valid or whether the name is already used by another database in the current cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

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 Key: the condition key that is defined by the cloud service.
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.

Operation	Access level	Resource type	Condition key	Associated operation
polardb:CheckDBName	get	dbcluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the cluster. Note You can call the DescribeDBClusters operation to query information about all clusters that are deployed in a region, such as the cluster IDs.	pc-****************
DBName	string	Yes	The name of the database.	test_db

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	CDB3258F-B5DE-43C4-8935-CBA0CA******
DBName	string	The name of the database.	test_db

If the database name that you enter is invalid, the error message “Specified DB name is not valid” is returned.
If the database name that you enter exists in the cluster, the error message “Specified DB name already exists” is returned.

Examples

Sample success responses

JSONformat

{
  "RequestId": "CDB3258F-B5DE-43C4-8935-CBA0CA******",
  "DBName": "test_db"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBName.Duplicate	The specified DB name already exists.	The specified DBName parameter already exists.
400	InvalidAccountName.Malformed	The specified parameter AccountName is not valid.	The specified AccountName parameter is invalid.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-09-12	The Error code has changed	View Change Details