Updated on 2025-09-16 GMT+08:00

Updating the Recycle Bin Policy

Function

This API is used to update the recycle bin policy.

URI

PUT /v1/{project_id}/recycle-bin/policy

Table 1 describes the parameters in the URI.

Table 1 Path parameters

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

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

Request

Table 2 Request parameters

Parameter

Mandatory

Type

Description

policy

Yes

Object

Updates the recycle bin policy. For details, see Table 3.

Table 3 policy field description

Parameter

Mandatory

Type

Description

retention_hour

Yes

Integer

Specifies how long an instance can be retained in the recycle bin before being permanently deleted.

recycle_threshold_day

Yes

Integer

Specifies how long an instance can be moved to the recycle bin after it is created.

Example Request

Update the recycle bin policy.

PUT https://{endpoint}/v1/{project_id}/recycle-bin/policy

{
    "policy": {
        "recycle_threshold_day": 7,
        "retention_hour": 24
    }
}

Example Response

{}

Error Codes

See Error Codes.