文档首页/ 对象存储服务 OBS/ API参考/ API/ 桶的高级配置/ 获取桶的加密配置
更新时间：2025-08-13 GMT+08:00
分享

获取桶的加密配置

功能介绍

OBS使用GET操作来获取指定桶的加密配置。

要正确执行此操作，需要确保执行者有GetEncryptionConfiguration权限。缺省情况下只有桶的所有者可以执行此操作，也可以通过设置桶策略或用户策略授权给其他用户。

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

请求消息样式

1
2
3
4
5
6
 
GET /?encryption  HTTP/1.1
User-Agent: curl/7.29.0
Host: bucketname.obs.cn-north-4.myhuaweicloud.com 
Accept: */*
Date: date 
Authorization: authorization string

请求消息参数

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

请求消息头

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

请求消息元素

此请求消息中不使用消息元素。

响应消息样式

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
 
HTTP/1.1 status_code
x-obs-request-id: request id 
x-obs-id-2: id  
Content-Type: application/xml 
Content-Length: length 
Date: date 

<?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>kmskeyid-value</KMSMasterKeyID>
            <ProjectID>projectid</ProjectID>
        </ApplyServerSideEncryptionByDefault>
    </Rule>
</ServerSideEncryptionConfiguration>

响应消息头

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

响应消息元素

在此请求返回的响应消息体中包含的配置元素如下。

表1 桶的加密配置元素

参数

参数类型

描述

ServerSideEncryptionConfiguration

Container

参数解释：

桶默认加密配置的根元素。ServerSideEncryptionConfiguration是Rule的父节点。

取值范围：

不涉及

Rule

Container

参数解释：

桶默认加密配置的子元素，Rule是ApplyServerSideEncryptionByDefault的父节点。

取值范围：

请详见Rule参数说明。
表2 Rule参数说明

参数

参数类型

描述

ApplyServerSideEncryptionByDefault

Container

参数解释：

桶默认加密配置的子元素。

取值范围：

请详见ApplyServerSideEncryptionByDefault参数说明。
表3 ApplyServerSideEncryptionByDefault参数说明

参数

参数类型

描述

SSEAlgorithm

String

参数解释：

桶默认加密配置要使用的服务端加密算法。

取值范围：

  • kms：使用SSE-KMS加密方式，默认使用AES256算法；如果您需要使用SM4加密算法，还需要配置KMSDataEncryption。
  • AES256：使用SSE-OBS加密方式，且使用AES256加密算法。

KMSDataEncryption

String

参数解释：

SSE-KMS加密方式下的数据加密算法。

取值范围：

SM4：国密SM4算法。

KMSMasterKeyID

String

参数解释：

SSE-KMS加密方式下使用的KMS主密钥ID。

取值范围：

  • regionID:domainID(账号ID):key/key_id
  • key_id

其中：

ProjectID

String

参数解释：

SSE-KMS加密方式下KMS主密钥所属的项目ID。

取值范围：

与KMSMasterKeyID相匹配的项目ID，即ID为KMSMasterKeyID的主密钥所在项目的项目ID。

错误响应消息

除了公共的错误码外，此接口还会返回一些其他的错误码。下表中列出本接口的一些常见错误，以及可能原因。如表4。

表4 获取桶加密配置的错误码列表

错误码

描述

HTTP状态码

NoSuchEncryptionConfiguration

指定的桶没有设置加密配置。

404 Not Found

请求示例

1
2
3
4
5
6
 
GET /?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=

响应示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
 
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: 788

<?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>
父主题： 桶的高级配置

相关文档