Modifying Recycling Policy
Function
This API is used to modify the recycling policy for the recycle bin.
- Before calling this API, learn how to authenticate it.
- Before calling this API, learn about request header parameters.
URI
- Parameter description
Table 1 Parameters Parameter
Mandatory
Description
project_id
Yes
Definition
Project ID of a tenant in a region.
To obtain the value, see Obtaining a Project ID.
Constraints
N/A
Range
N/A
Default Value
N/A
Request
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| recycle_policy | Yes | Object | Definition Each element is associated with the recycle bin. For details on the element structure, see Table 3. Constraints N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| retention_period_in_days | No | String | Definition Retention days of deleted instances. Constraints N/A Range The value is an integer ranging from 1 to 7. Default Value If this parameter is left blank, the retention period is 7 days by default. |
Example Request
Set the retention period of instances in the recycle bin to one day.
{
"recycle_policy":{
"retention_period_in_days":"1"
}
} Response
- Normal response
Table 4 Parameters Parameter
Type
Description
result
String
Definition
Calling result.
Range
success: The API is successfully called.
- Example normal response
{ "result": "success" }
- Abnormal response
For details, see Abnormal Request Results.
Status Code
- Normal
- Abnormal
For details, see Status Codes.
Error Code
For details, see Error Codes.