Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Recycle Bin/ Modifying the Recycling Policy
Updated on 2026-07-16 GMT+08:00

Modifying the Recycling Policy

Function

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

Debugging

You can debug this API in API Explorer.

URI

PUT /v3/{project_id}/recycle-policy

Table 1 Parameter description

Name

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token.

You can obtain the token by calling the IAM API used to obtain a user token.

After a response is returned, the value of X-Subject-Token in the response header is the token.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language.

Constraints

N/A

Range

  • zh-cn: Chinese
  • en-us: English

Default Value

en-us

Table 3 Parameter description

Parameter

Mandatory

Type

Description

recycle_policy

Yes

Object

Definition

Recycling policy. For details, see Table 4.

Constraints

N/A

Table 4 recycle_policy field data structure description

Parameter

Mandatory

Type

Description

retention_period_in_days

Yes

Integer

Definition

Retention days of deleted instances.

Constraints

N/A

Range

1–7

Default Value

N/A

Response Parameters

Table 5 Parameter description

Parameter

Type

Description

result

String

Definition

Modification result.

Range

SUCCESS: 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 Codes

Error Codes

For details, see Error Codes.