Updated on 2026-01-08 GMT+08:00

Querying the Recycling Policy of a DB Instance

API Description

This API is used to query the recycling policy of a DB instance.

URI

  • URI format
    GET https://{Endpoint}/v3/{project_id}/instances/recycle-policy
    Table 1 Path parameters

    Name

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID of a tenant in a region. Obtain the project ID by following the instructions in Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

Response Parameters

Table 3 Response body parameters

Name

Type

Description

recycle_policy

Table 2-4 object

Instance recycling policy.

Table 4 RecyclePolicy

Name

Type

Description

enabled

Boolean

Whether to enable the recycling policy.

  • true: Enable the recycling policy.

retention_period_in_days

Integer

Policy retention period (1 to 7 days). The value must be a positive integer.

  • Example response
    { 
      "recycle_policy" : { 
        "enabled" : true, 
        "retention_period_in_days" : 3 
      } 
    }

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.