Help Center> Relational Database Service> API Reference> API v3 (Recommended)> Recycling a DB Instance> Modify Recycling Policy
View PDF

Modify Recycling Policy

Function

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

URI

  • URI format

    PUT https://{Endpoint}/v3/{project_id}/instances/recycle-policy

  • Example

    https://rds.cn-north-1.myhuaweicloud.com/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/recycle-policy

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the 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

    is_open_recycle_policy

    Yes

    Boolean

    Indicates whether to enable the recycling policy. The value can be true or false.

    retention_period_in_days

    No

    String

    Indicates the period of retaining deleted DB instances from 1 day to 7 days.

    When is_open_recycle_policy is set to true and retention_period_in_days is left blank, deleted DB instances are retained for 7 days by default.
  • Request example 
    {
     "recycle_policy":
              {
                 "retention_period_in_days":"1", 
                 "is_open_recycle_policy":false
               }
}

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

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Recycling a DB Instance