All Products
Search
Document Center

PolarDB:CheckDBName

Last Updated:Nov 07, 2023

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

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

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.
OperationAccess levelResource typeCondition keyAssociated operation
polardb:CheckDBNameREAD
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

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-****************
DBNamestringYes

The name of the database.

test_db

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CDB3258F-B5DE-43C4-8935-CBA0CA******
DBNamestring

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 codeError codeError messageDescription
400InvalidDBName.DuplicateThe specified DB name already exists.The specified DBName parameter already exists.

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

Change history

Change timeSummary of changesOperation
2023-09-12The error codes of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    Error Codes 400 change
    Added Error Codes: 404