All Products
Search
Document Center

PolarDB:DeleteDBCluster

Last Updated:Oct 10, 2024

Releases a pay-as-you-go PolarDB cluster.

Debugging

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

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:DeleteDBClusterdelete
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The cluster ID.

pc-**************
BackupRetentionPolicyOnClusterDeletionstringNo

The retention policy applied to the backup sets when the cluster is released. Valid values:

  • ALL: permanently retains all backup sets.
  • LATEST: permanently retains the most recent backup set that is automatically created before the cluster is released.
  • NONE: does not retain backup sets.
NONE

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

D0CEC6AC-7760-409A-A0D5-E6CD86******

Examples

Sample success responses

JSONformat

{
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
}

Error codes

HTTP status codeError codeError messageDescription
400EngineMigration.ActionDisabledSpecified action is disabled while custins is in engine migration.The specified operation is disabled when custins is being migrated across engines.
400InvalidParamBackupRetentionPolicyOnClusterDeletion.MalformedInvalid BackupRetentionPolicyOnClusterDeletion value. Please retain the backup set.Invalid BackupRetentionPolicyOnClusterDeletio value. Retain the backup set.
400InvalidBackupRetentionPolicyOnClusterDeletion.MalformedThe specified BackupRetentionPolicyOnClusterDeletion is invalid.The specified BackupRetentionPolicyOnClusterDeletion parameter is invalid.
403OperationDenied.DBClusterDeletionLockThe operation is not permitted due to the deletion lock of cluster.This operation is not supported while a deletion lock exists in the cluster.
403OperationDenied.OperateStatusSpecified action is denied by operate status.The operation is denied because the
403OperationDenied.ClusterStatusThe PolarDB cluster is not allowed to release when it is not running.Stopped PolarDB clusters cannot be released.
403OperationDenied.DBClusterPayTypeThe operation is not permitted due to the pay type of cluster.This operation is not supported by the billing method of the cluster.
404InvalidDBCluster.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 code has changedView Change Details
2023-04-24The Error code has changedView Change Details