All Products
Search

This Product

    ApsaraDB RDS:DeleteDBInstance

    Document Center

    ApsaraDB RDS:DeleteDBInstance

    Last Updated:May 16, 2023

    Releases an instance.

    Operation Description

    Before you call this operation, make sure that the following requirements are met:

    • The instance is in the Running state.
    • The read/write splitting feature is disabled for the instance.
    • The instance is a primary, read-only, disaster recovery, or temporary instance. If the instance is a primary instance, it uses the pay-as-you-go billing method.
    NoteYou can manually release an instance in the ApsaraDB RDS console. For more information, see Release an instance.

    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
    rds:DeleteDBInstanceWRITE
    • RDS
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance.

    		rm-uf6wjk5****
    ReleasedKeepPolicystringNo

    The policy that is used to retain archived backup files if the instance is released. Valid values:

    • None: No archived backup files are retained.
    • Lastest: Only the last archived backup file is retained.
    • All: All archived backup files are retained.
    NoteThis parameter is supported only when the instance runs MySQL and uses local SSDs.
    		Lastest

    Response parameters

    ParameterTypeDescriptionExample
    object
    RegionIdstring

    The ID of the region.

    		ap-southeast-1
    RequestIdstring

    The ID of the request.

    		65BDA532-28AF-4122-AA39-B382721EEE64

    Examples

    Sample success responses

    JSONformat

    {
  "RegionId": "ap-southeast-1",
  "RequestId": "65BDA532-28AF-4122-AA39-B382721EEE64"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400EngineMigration.ActionDisabledSpecified action is disabled while custins is in engine migration.The specified operation is disabled when the instance is being migrated across engines.
    400OperationDenied.DeletionProtectionThe operation is not permitted when the instance enabled deletion protection.Instances cannot be deleted if deletion protection is enabled.
    400GuardInstance.ReleaseFailThe guard instance release fail.-
    403OperationDenied.PrePayTypeNotSupportedThe operation is not permitted due to pay type of instance.Subscription instances cannot be directly deleted.
    403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.-
    404InvalidDBInstanceName.NotFoundInvalid DBInstanceId NotFound.The instance ID cannot be found.

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

    Change history

    Change timeSummary of changesOperation
    2022-09-01The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
      delete Error Codes: 403
    2021-12-17The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
      delete Error Codes: 403
    2021-12-17The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 403 change
      delete Error Codes: 400