doc-exports/docs/opengauss/api-ref/opengauss_newapi_0037.html

Modifying the Recycling Policy

Function

This API is used to modify the recycling policy. Before calling this API:

• Learn how to authenticate this API.
• Understand the API in Using APIs.
• Obtain the required region and endpoint.

URI

• URI format

  PUT https://{Endpoint}/v3/{project_id}/recycle-policy

• Example

  https://gaussdb.eu-de.otc.t-systems.com/v3/0611f1bd8b00d5d32f17c017f15b599f/recycle-policy

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Request

• Parameter description

  Table 2 Parameter description

  Name	Mandatory	Type	Description
  recycle_policy	Yes	Object	Recycling policy. For details, see Table 3.

  Table 3 recycle_policy field data structure description

  Name	Mandatory	Type	Description
  retention_period_in_days	Yes	Integer	Deleted instance retention period. Value range: 1 to 7.

Example Request

Setting the retention period of deleted instances to 5 days

{
	"recycle_policy": {
		"retention_period_in_days": 5
	}
}

Response

• Normal response

  Table 4 Parameter description

  Name	Type	Description
  result	String	Modification result. success indicates that the modification 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.

Parent topic: Recycle Bin