Modifying Recycling Policy¶
Function¶
This API is used to modify the recycling policy for the recycle bin.
Before calling an API, you need to understand the API in Authentication.
Before calling this API, obtain the required region and endpoint.
URI¶
URI format
PUT https://{Endpoint}/v3/{project_id}/instances/recycle-policy
Parameter description
¶ Name
Mandatory
Description
project_id
Yes
Specifies the project ID of a tenant in a region.
For details about how to obtain the project ID, see Obtaining a Project ID.
Request¶
Parameter description
¶ Name
Mandatory
Type
Description
recycle_policy
Yes
Object
Each element is associated with the recycle bin.
For details on the element structure, see Table 3.
¶ Name
Mandatory
Type
Description
retention_period_in_days
No
String
Period of retaining deleted DB instances from 1 day to 7 days.
If this parameter is left blank, the retention period is 7 days by default.
Example
PUT https://rds.eu-de.otc.t-systems.com/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/recycle-policy
Request example
{ "recycle_policy": { "retention_period_in_days":"1" } }
Response¶
Normal response
¶ Name
Type
Description
result
String
Returns success if the invoking is successful.
Example normal response
{ "result": "success" }
Abnormal response
For details, see Abnormal Request Results.
Status Code¶
Normal
200
Abnormal
For details, see Status Codes.
Error Code¶
For details, see Error Codes.