文档首页/ 数据安全中心 DSC/ API参考/ API/ 资产地图/ 设置OBS加密 - UpdateObsBucketEncryption
更新时间:2026-11-13 GMT+08:00
分享

设置OBS加密 - UpdateObsBucketEncryption

功能介绍

功能介绍:设置 OBS 桶加密

调用方法

请参见如何调用API。

授权信息

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

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

PUT /v2/{project_id}/data-map/obs-bucket-encryption

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,标识当前请求所属的华为云项目,可参考获取项目ID相关文档获取

约束限制:

满足正则匹配"^[a-z0-9]{32}$",32位小写字母和数字

取值范围:

长度为32个字符,只能由小写英文字母和数字组成

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

bucket_name

是

String

参数解释:

OBS存储桶名称,用于指定待操作的OBS桶

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

kms_key_id

否

String

参数解释:

KMS密钥ID,标识用于加解密设置的KMS密钥,可通过KMS服务控制台或API查询密钥列表获取

约束限制:

可选参数,仅当取值非空时生效,通常与 type=kms 配合使用

取值范围:

不涉及

默认取值:

不涉及

type

是

String

参数解释:

OBS桶加密算法,用于指定OBS桶的加密方式

约束限制:

取值必须为 kms、AES256、NoEncrypt 之一;NoEncrypt 表示删除桶加密配置

取值范围:

  • kms-KMS托管密钥加密

  • AES256-AES256加密

  • NoEncrypt-关闭桶加密

默认取值:

不涉及

asset_id

是

String

参数解释:

资产ID,标识一个数据资产,可通过DSC服务控制台查询资产列表获取

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释:

操作结果状态,标识操作的处理结果,如成功、失败等

取值范围:

不涉及

msg

String

参数解释:

操作结果描述信息

取值范围:

不涉及

id

String

参数解释:

资源唯一标识ID,唯一标识一条资源记录,可通过查询资源列表接口获取

取值范围:

0到1024个字符,只能由英文字母、数字组成

请求示例

无

响应示例

状态码:200

{
  "status" : "success"
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档