文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 备份与恢复/ 查询回收策略 - QueryingtheRecyclingPolicy
更新时间：2025-11-27 GMT+08:00
查看PDF
分享

查询回收策略 - QueryingtheRecyclingPolicy

功能介绍

查询回收策略。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbfornosql:instance:getRecyclePolicy

    Read

    -

    -

    nosql:instance:list

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

用户在某一region下的project ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

recycle_policy

object

参数解释：

回收策略。详情请参考表4。

回收策略。

取值范围：

不涉及。
表4 RecyclePolicy

参数

参数类型

描述

retention_period_in_days

Integer

参数解释：

策略保持时长，单位为天。

约束限制：

不涉及。

取值范围：

1~7。

默认取值：

7。

请求示例

  • URI样例 
    GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/recycle-policy
  • 请求体样例

    无。

响应示例

状态码： 200

Success.

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

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 备份与恢复