doc-exports/docs/rds/api-ref/rds_14_0002.html

Querying the Recycling Policy

Function

This API is used to query the recycling policy of 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

  GET https://{endpoint}/v3/{project_id}/instances/recycle-policy

• Parameter description

  Table 1 Parameters

  Parameter	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

  Table 2 Request header parameters

  Parameter	Mandatory	Type	Description
  X-Auth-Token	Yes	String	Specifies the user token. The user token is a response to the API used to obtain a user token.

• URI example

  GET https://rds.eu-de.otc.t-systems.com/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/recycle-policy

Response

• Normal response

  Table 3 Parameters

  Parameter	Type	Description
  retention_period_in_days	Integer	Number of days for retaining instances in the recycle bin.

• Example normal response

  {
     "retention_period_in_days" : 7
  }

• 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: Recycling a DB Instance