Help Center/ GeminiDB/ API Reference/ APIs v3/ Backups and Restorations/ Querying the Recycling Policy
Updated on 2025-09-23 GMT+08:00
View PDF

Querying the Recycling Policy

Function

This API is used to query the recycling policy.

URI

GET /v3/{project_id}/instances/recycle-policy

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a user in a region. To obtain this value, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

recycle_policy

object

Recycling policy. For details, see Table 4.
Table 4 RecyclePolicy

Parameter

Type

Description

retention_period_in_days

Integer

Policy retention duration (1 to 7 days). The value is a positive integer. The default value is 7.

Example Request

  • URI example 
    GET https://gaussdb-nosql.eu-west-101.myhuaweicloud.eu/v3/054e292c9880d4992f02c0196d3ea468/instances/recycle-policy
  • Example request body

    None

Example Response

Status code: 200

Success

{
  "recycle_policy": {
    "retention_period_in_days": 7
  }
}

Status Codes

See Status Codes.

Error Codes

See Error Codes.

Parent topic: Backups and Restorations