Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ Recycling a DB Instance/ Modifying Recycling Policy
Updated on 2025-12-09 GMT+08:00
View PDF
Share

Modifying Recycling Policy

Function

This API is used to modify the recycling policy for the recycle bin.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:instance:setRecycleBin

write

-

-

-

-

URI

  • URI format

    PUT /v3/{project_id}/instances/recycle-policy

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

recycle_policy

Yes

Object

Definition

Each element is associated with the recycle bin.

For details on the element structure, see Table 3.

Constraints

N/A
Table 3 recycle_policy elements

Parameter

Mandatory

Type

Description

retention_period_in_days

No

String

Definition

Retention days of deleted instances.

Constraints

N/A

Range

The value is an integer ranging from 1 to 7.

Default Value

If this parameter is left blank, the retention period is 7 days by default.

Example Request

Set the retention period of instances in the recycle bin to one day.

PUT https://{endpoint}/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/recycle-policy

{
     "recycle_policy":{
                 "retention_period_in_days":"1"
               }
}

Response

  • Normal response
    Table 4 Parameters

    Parameter

    Type

    Description

    result

    String

    Definition

    Calling result.

    Range

    success: The API is successfully called.
  • Example normal response 
    {
	"result": "success"
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: Recycling a DB Instance