All Products
Search
Document Center

PolarDB:DeleteDatabase

Last Updated:Nov 07, 2023

Deletes a database from a PolarDB cluster.

Operation Description

Note
  • The cluster must be in the Running state and unlocked. Otherwise, the specified database cannot be deleted.
  • The delete operation is performed in an asynchronous manner. A long period of time may be required to delete a large database. A success response for this operation only indicates that the request to delete the database is sent. You must query the database to check whether the database is deleted.
  • 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:DeleteDatabaseWRITE
    • dbcluster
      acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
      none
    none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBClusterIdstringYes

    The cluster ID.

    pc-*************
    DBNamestringYes

    The name of the database.

    testdb

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    2FED790E-FB61-4721-8C1C-07C627******

    Examples

    Sample success responses

    JSONformat

    {
      "RequestId": "2FED790E-FB61-4721-8C1C-07C627******"
    }

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidDBName.MalformedThe specified parameter DBName is not valid.The format of the specified database name is invalid.
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
    404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
    404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The specified DBClusterId parameter is invalid.

    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 404 change
      Added Error Codes: 400