文档首页/ 数据安全中心 DSC/ API参考/ API/ 数据水印/ 设置OBS加密 - UpdateSdgObsBucketEncryption
更新时间：2026-10-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

设置OBS加密 - UpdateSdgObsBucketEncryption

功能介绍

功能介绍：设置obs加密

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

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

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

URI

POST /v1/{project_id}/sdg/obs-bucket-encryption

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可参考获取项目ID获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-32，满足正则匹配"^[a-z0-9]{32}$"

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

bucket_name

否

String

参数解释：

OBS桶名称

约束限制：

最大长度65535字符

取值范围：

不涉及

默认取值：

不涉及

kms_key_id

否

String

参数解释：

KMS密钥ID

约束限制：

满足正则匹配"^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$"

取值范围：

不涉及

默认取值：

不涉及

type

否

String

参数解释：

加密类型

约束限制：

最大长度65535字符

取值范围：

不涉及

默认取值：

不涉及

asset_id

否

String

参数解释：

资产ID

约束限制：

满足正则匹配"^[a-fA-F0-9]{32}$"

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释：

请求状态，success为成功。

取值范围：

不涉及

msg

String

参数解释：

提示信息

取值范围：

不涉及

id

String

参数解释：

资源ID

取值范围：

不涉及

请求示例

设置OBS加密请求体

{
  "bucket_name" : "dsc-asset-bucket-01",
  "kms_key_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
  "type" : "KMS",
  "asset_id" : "c3d4e5f6-7a8b-4c9d-0e1f-2a3b4c5d6e7f"
}

响应示例

状态码：200

{
  "status" : "success",
  "msg" : "设置OBS加密成功",
  "id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
}

状态码

状态码

描述

200

设置obs加密成功

错误码

请参见错误码。

父主题： 数据水印

相关文档