Updated on 2025-12-10 GMT+08:00

Updating the Recycle Bin Policy

Function

This API is used to update the recycle bin policy.

Debugging

You can debug this API in API Explorer.

Authorization

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.
  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the permissions listed below are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

ecs:recycleBin:updatePolicy

write

-

-

-

-

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.