Help Center> GaussDB> API Reference> APIs (Recommended)> Recycle Bin> Modifying the Recycling Policy
Updated on 2024-05-21 GMT+08:00
View PDF

Modifying the Recycling Policy

Function

This API is used to modify the recycling policy. Before calling this API:

URI

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

Table 1 Parameter description

Parameter

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 Parameters

Table 2 Parameter description

Parameter

Mandatory

Type

Description

recycle_policy

Yes

Object

Recycling policy. For details, see Table 3.
Table 3 recycle_policy field data structure description

Parameter

Mandatory

Type

Description

retention_period_in_days

Yes

Integer

Deleted instance retention period.

Value range: 1 to 7.

Response Parameters

Table 4 Parameter description

Parameter

Type

Description

result

String

Modification result. SUCCESS indicates that the modification is successful.

Example Request

Setting the retention period of deleted instances to 5 days 
PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/recycle-policy
{
	"recycle_policy": {
		"retention_period_in_days": 5
	}
}

Response

{     
	"result": "SUCCESS" 
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: Recycle Bin