文档首页/ 文档数据库服务 DDS/ API参考/ API v3(推荐)/ 实例管理/ 查询实例回收站策略-QueryingtheRecyclingPolicyofaDBInstance
更新时间:2025-11-25 GMT+08:00
分享

查询实例回收站策略-QueryingtheRecyclingPolicyofaDBInstance

功能介绍

查询实例回收站策略。

调试

您可以在API Explorer中调试该接口。

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    dds:instance:getBackupPolicy

    read

    -

    -

    • dds:instance:list
    • dds:backup:list

    -

URI

  • URI格式

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

  • URI样例
    https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/recycle-policy
    表1 路径参数

    参数

    是否必选

    参数类型

    描述

    project_id

    String

    参数解释:

    租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。

    约束限制:

    不涉及。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

从IAM服务获取的用户Token。请参考认证鉴权

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

表3 响应Body参数

参数

参数类型

说明

recycle_policy

表4 object

参数解释:

实例回收策略。

取值范围:

不涉及。

表4 RecyclePolicy

参数

参数类型

说明

enabled

Boolean

参数解释:

是否打开回收策略。

取值范围:

true:打开回收策略。

retention_period_in_days

Integer

参数解释:

策略保持时长(1-7天),天数为正整数。

取值范围:

1-7。

请求示例

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

响应示例

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

状态码

详情请参见状态码

错误码

详情请参见错误码

相关文档