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

Modifying Recycling Policy

Function

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

  • Before calling an API, you need to understand the API in Authentication.

URI

  • URI format

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

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

Request

Parameter description
Table 2 Parameter description

Name

Mandatory

Type

Description

recycle_policy

Yes

Object

Each element is associated with the recycle bin.

For details on the element structure, see Table 3.
Table 3 recycle_policy elements

Name

Mandatory

Type

Description

retention_period_in_days

No

String

Period of retaining deleted DB instances from 1 day to 7 days.

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

Example Request

Setting the retention period of instances in the recycle bin to one day

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

Response

  • Normal response
    Table 4 Parameter description

    Name

    Type

    Description

    result

    String

    Returns success if the invoking is successful.
  • Example normal response 
    {
	"result": "success"
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: Recycling a DB Instance