文档首页/ 对象存储服务 OBS/ API参考/ API/ 桶的高级配置/ 设置桶的加密配置

更新时间：2024-10-21 GMT+08:00

设置桶的加密配置

功能介绍

OBS使用PUT操作为桶创建或更新默认服务端加密配置信息。

设置桶加密配置后，在该桶中上传对象时，会采用桶的默认加密配置对数据进行加密。目前支持配置的服务端加密方式有：KMS托管密钥的服务端加密(SSE-KMS)、OBS托管密钥的服务端加密(SSE-OBS)。有关服务端加密方式的更多信息请参考服务端加密章节。

要使用此操作，您必须具有执行PutEncryptionConfiguration操作的权限。桶拥有者默认具有此权限，并且可以将此权限授予其他人。

有关权限控制的更多信息请参考《对象存储服务权限配置指南》的OBS权限控制概述章节。

请求消息样式（SSE-KMS SM4）

PUT /?encryption  HTTP/1.1
User-Agent: curl/7.29.0
Host: bucketname.obs.cn-north-4.myhuaweicloud.com 
Accept: */*
Date: date 
Authorization: authorization string
Content-Length: length

<ServerSideEncryptionConfiguration>
    <Rule>
        <ApplyServerSideEncryptionByDefault>
            <SSEAlgorithm>kms</SSEAlgorithm>
            <KMSDataEncryption>SM4</KMSDataEncryption>
            <KMSMasterKeyID>kmskeyid-value</KMSMasterKeyID>
        </ApplyServerSideEncryptionByDefault>
    </Rule>
</ServerSideEncryptionConfiguration>

请求消息样式（SSE-KMS AES256）

     
          PUT /?encryption  HTTP/1.1
User-Agent: curl/7.29.0
Host: bucketname.obs.cn-north-4.myhuaweicloud.com 
Accept: */*
Date: date 
Authorization: authorization string
Content-Length: length

<ServerSideEncryptionConfiguration>
    <Rule>
        <ApplyServerSideEncryptionByDefault>
            <SSEAlgorithm>kms</SSEAlgorithm>
            <KMSMasterKeyID>kmskeyid-value</KMSMasterKeyID>

        </ApplyServerSideEncryptionByDefault>
    </Rule>
</ServerSideEncryptionConfiguration>

请求消息样式（SSE-OBS）

     
          PUT /?encryption HTTP/1.1 
User-Agent: curl/7.29.0 
Host: bucketname.obs.cn-north-4.myhuaweicloud.com 
Accept: */* 
Date: date  
Authorization: authorization string 
Content-Length: length
 
<ServerSideEncryptionConfiguration> 
    <Rule> 
        <ApplyServerSideEncryptionByDefault> 
            <SSEAlgorithm>AES256</SSEAlgorithm> 
        </ApplyServerSideEncryptionByDefault> 
    </Rule> 
</ServerSideEncryptionConfiguration>

请求消息参数

该请求消息中不使用消息参数。

请求消息头

该请求使用公共消息头，具体参见表3。

请求消息元素

在此请求中，需要在请求的消息体中配置桶的加密配置。桶加密的配置信息以XML格式上传。具体的配置元素如表1。

表1 桶的加密配置元素
消息头名称	描述	是否必选
ServerSideEncryptionConfiguration	桶的默认加密配置的根元素。类型：Container 父元素：无子元素：Rule	是
Rule	桶的默认加密配置的子元素。类型：Container 父元素：ServerSideEncryptionConfiguration 子元素：ApplyServerSideEncryptionByDefault	是
ApplyServerSideEncryptionByDefault	桶的默认加密配置的子元素。类型：Container 父元素：Rule 子元素：SSEAlgorithm，KMSMasterKeyID	是
SSEAlgorithm	桶的默认加密配置要使用的服务端加密算法。类型：String 有效值： kms：使用SSE-KMS加密方式，默认使用AES256算法；如果您需要使用SM4加密算法，还需要配置KMSDataEncryption。 AES256：使用SSE-OBS加密方式，且使用AES256加密算法。父元素：ApplyServerSideEncryptionByDefault	是
KMSDataEncryption	SSE-KMS加密方式下的数据加密算法。类型：String 有效值：SM4 父元素：ApplyServerSideEncryptionByDefault	否
KMSMasterKeyID	SSE-KMS加密方式下使用的KMS主密钥，如果用户没有提供该头域，那么默认的主密钥将会被使用。类型：String 有效值支持两种格式： regionID:domainID(账号ID):key/key_id key_id 其中： regionID是使用密钥所属region的ID，可在地区和终端节点页面获取； domainID是使用密钥所属账号的账号ID，获取方法参见获取账号、IAM用户、项目、用户组、区域、委托的名称和ID； key_id是从数据加密服务创建的密钥ID，获取方法请参见查看密钥。父元素：ApplyServerSideEncryptionByDefault	否
ProjectID	SSE-KMS加密方式下KMS主密钥所属的项目ID。如果KMS主密钥所属的项目为非默认项目，则需要通过该参数进行项目ID指定。类型：String 有效值：与KMSMasterKeyID相匹配的项目ID。在未设置KMSMasterKeyID的情况下，不可设置项目ID。父元素：ApplyServerSideEncryptionByDefault 说明：使用非默认IAM项目下的自定义密钥对桶内对象进行SSE-KMS加密，只有密钥拥有者可以对加密后的对象进行上传下载类操作，非密钥拥有者不能对加密后的对象进行上传下载类操作。	否

响应消息样式

     
          HTTP/1.1 status_code
Date: date
Content-Length: length

响应消息头

该请求的响应消息使用公共消息头，具体请参考表1。

响应消息元素

该请求的响应消息不带消息元素。

错误响应消息

无特殊错误，所有错误已经包含在表2中。

请求示例（SSE-KMS SM4）

PUT /?encryption  HTTP/1.1
User-Agent: curl/7.29.0
Host: bucketname.obs.cn-north-4.myhuaweicloud.com 
Accept: */*
Date:  Thu, 21 Feb 2019 03:05:34 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:DpSAlmLX/BTdjxU5HOEwflhM0WI=
Content-Length: 778

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> 
<ServerSideEncryptionConfiguration xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/"> 
    <Rule>
        <ApplyServerSideEncryptionByDefault>
            <SSEAlgorithm>kms</SSEAlgorithm>
            <KMSDataEncryption>SM4</KMSDataEncryption>
            <KMSMasterKeyID>4f1cd4de-ab64-4807-920a-47fc42e7f0d0</KMSMasterKeyID>
        </ApplyServerSideEncryptionByDefault>
    </Rule>
</ServerSideEncryptionConfiguration>

响应示例（SSE-KMS SM4）

     
          HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: BF26000001643670AC06E7B9A7767921
x-obs-id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCSvK6z8HV6nrJh49gsB5vqzpgtohkiFm
Date: Thu, 21 Feb 2019 03:05:34 GMT
Content-Length: 0

请求示例（SSE-KMS AES256）

     
          PUT /?encryption HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Accept: */*
Date:  Thu, 21 Feb 2019 03:05:34 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:DpSAlmLX/BTdjxU5HOEwflhM0WI=
Content-Length: 778

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> 
<ServerSideEncryptionConfiguration xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/"> 
    <Rule>
        <ApplyServerSideEncryptionByDefault>
            <SSEAlgorithm>kms</SSEAlgorithm>
            <KMSMasterKeyID>4f1cd4de-ab64-4807-920a-47fc42e7f0d0</KMSMasterKeyID>
        </ApplyServerSideEncryptionByDefault>
    </Rule>
</ServerSideEncryptionConfiguration>

响应示例（SSE-KMS AES256）

     
          HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: BF26000001643670AC06E7B9A7767921
x-obs-id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCSvK6z8HV6nrJh49gsB5vqzpgtohkiFm
Date: Thu, 21 Feb 2019 03:05:34 GMT
Content-Length: 0

请求示例（SSE-OBS）

     
          PUT /?encryption HTTP/1.1 
User-Agent: curl/7.29.0 
Host: bucketname.obs.cn-north-4.myhuaweicloud.com 
Accept: */*
Date:  Thu, 21 Feb 2019 03:05:34 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:DpSAlmLX/BTdjxU5HOEwflhM0WI=
Content-Length: 778
 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> 
<ServerSideEncryptionConfiguration xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/"> 
    <Rule> 
        <ApplyServerSideEncryptionByDefault> 
            <SSEAlgorithm>AES256</SSEAlgorithm> 
        </ApplyServerSideEncryptionByDefault> 
    </Rule> 
</ServerSideEncryptionConfiguration>

响应示例（SSE-OBS）

     
          HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: BF26000001643670AC06E7B9A7767921
x-obs-id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCSvK6z8HV6nrJh49gsB5vqzpgtohkiFm
Date: Thu, 21 Feb 2019 03:05:34 GMT
Content-Length: 0

父主题：桶的高级配置

上一篇：删除桶的自定义域名

下一篇：获取桶的加密配置

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问