更新时间:2026-11-06 GMT+08:00

关闭备份功能 - DisableKeyBackup

功能介绍

关闭当前项目的密钥备份功能。

关闭后不再执行任何自动备份。可选传入delete_backup_files=true同时删除该租户所有备份文件(OBS对象+快照元数据记录)。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    kms:cmk:disableBackup

    Write

    -

    -

    -

    -

URI

POST /v1.0/{project_id}/kms/backups/disable

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,用于唯一标识用户项目。可参考获取项目ID获取,以IAM服务接口返回值为准

约束限制:

不涉及

取值范围:

字符长度32-32。

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。 通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值),以IAM服务查询用户Token接口为准

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

delete_backup_files

否

Boolean

参数解释:

是否同时删除该租户所有备份文件(OBS对象+快照元数据记录)

约束限制:

不涉及

取值范围:

  • true:同时删除所有备份文件

  • false:仅关闭备份功能,保留已有备份文件

默认取值:

false

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

backup_enabled

Boolean

参数解释:

备份功能是否已开启

取值范围:

  • true:已开启

  • false:已关闭

请求示例

关闭备份功能并删除所有备份文件

{
  "delete_backup_files" : true
}

响应示例

状态码:200

{
  "backup_enabled" : false
}

状态码

状态码

描述

200

请求成功

错误码

请参见错误码。