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

  • Parameter description

    Table 1 Request parameters

    Name

    Mandatory

    Type

    Description

    x-auth-token

    Yes

    String

    User token.

    project_id

    Yes

    String

    Specifies the project ID of a tenant in a region.

Requests

Responses

  • Parameter description

    Table 2 Response body parameters

    Name

    Type

    Description

    recycle_policy

    RecyclePolicy object

    Instance recycling policy.

    Table 3 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.

  • Response Example

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

Status Code

Status Code:200.

For more information, see Status Code.

Error Code

For more information, see Error Code.

last updated: 2024-05-17 00:21