Setting the Recycle Bin Policy

This API is used to set the recycle bin policy for an instance.

**Table 1** Path parameters
Name	Type	IN	Mandatory	Description
project_id	string	path	Yes	Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.
instance_id	string	path	Yes	Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

**Table 2** Request header parameters
Parameter	Type	IN	Mandatory	Description
X-Auth-Token	string	header	Yes	User token

**Table 3** Request body parameters
Name	Mandatory	Type	Description
recycle_policy	Yes	Object	Instance recycling policy. For details, see Table 4.

**Table 4** RecyclePolicy
Name	Mandatory	Type	Description
enabled	Yes	Boolean	The recycling policy is enabled and cannot be disabled. true: The recycling policy is enabled.
retention_period_in_days	No	Integer	Policy retention duration (1 to 7 days). The value is a positive integer. If this parameter is left blank, the policy is retained for 7 days by default.

Request example

{ 
  "recycle_policy" : { 
    "enabled" : true, 
    "retention_period_in_days" : 3 
  } 
}

For details, see Status Code.

For details, see Error Code.

Parent topic: DB Instance Management

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.