# 设置桶加密配置(Java SDK) #### 功能介绍 设置桶的加密配置，以允许在该桶中上传对象时，采用对应加密配置对数据进行加密，数据在服务端被加密成密文后存储，用户下载加密对象时，存储的密文会先在服务端解密为明文，再提供给用户。调用设置桶加密配置接口，您可以为指定桶创建或更新加密配置信息。 #### 接口约束 - 您必须是桶拥有者或拥有设置桶加密配置的权限，才能设置桶加密配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutEncryptionConfiguration权限，如果使用桶策略则需授予PutEncryptionConfiguration权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[自定义创建桶策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0123.html)。 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 #### 方法定义 obsClient.setBucketEncryption(SetBucketEncryptionRequest request) #### 请求参数说明 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | request | [表2 SetBucketEncryptionRequest] | 必选 | **参数解释：** 设置桶的加密配置请求参数，详见[表2 SetBucketEncryptionRequest]。 | 表2SetBucketEncryptionRequest | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | bucketName | String | 必选 | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **默认取值：** 无 | | bucketEncryption | [BucketEncryption] | 必选 | **参数解释：** 桶的加密配置。 **取值范围：** 详见[BucketEncryption]。 **默认取值：** 无 | 表3BucketEncryption | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | sseAlgorithm | [SSEAlgorithmEnum] | 必选 | **参数解释：** 服务端加密的加密方式。 **取值范围：** 详见[SSEAlgorithmEnum]。 **默认取值：** 无 | | kmsKeyId | String | 可选 | **参数解释：** SSE-KMS加密方式下使用的KMS主密钥。 **取值范围：** 有效值支持两种格式： - regionID:domainID(账号ID):key/key_id - key_id 其中： - regionID是使用密钥所属region的ID，可在[地区和终端节点](https://developer.huaweicloud.com/endpoint?OBS)页面获取； - domainID是使用密钥所属账号的账号ID，获取方法参见[如何获取账号ID和用户ID](https://support.huaweicloud.com/sdk-java-devg-obs/obs_23_1712.html)。 - key_id是从数据加密服务创建的密钥ID，获取方法请参见[查看密钥](https://support.huaweicloud.com/usermanual-dew/dew_01_0179.html)。 **默认取值：** 如果用户没有提供该头域，那么默认的主密钥将会被使用。 | 表4SSEAlgorithmEnum | **常量名** | **原始值** | **说明** | |:---|:---|:---| | KMS | kms | 选择SSE-KMS方式加密对象。 | | AES256 | AES256 | 选择SSE-OBS方式加密对象。 | #### 返回结果说明 表5返回结果HeaderResponse(SDK公共响应结果)各项属性说明 | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | statusCode | int | **参数解释：** HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。 完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 **默认取值：** 无 | | responseHeaders | Map\ | **参数解释：** HTTP响应消息头列表，由多个元组构成。元组中String代表响应消息头的名称，Object代表响应消息头的值。 **默认取值：** 无 | #### 代码示例 本示例用于设置桶的加密配置，加密方式为KMS。 ``` import com.obs.services.ObsClient; import com.obs.services.exception.ObsException; import com.obs.services.model.BucketEncryption; import com.obs.services.model.SSEAlgorithmEnum; public class SetBucketEncryption { public static void main(String[] args) { // 您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥AK/SK String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。 // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken，也可以使用其他外部引入方式传入。 // String securityToken = System.getenv("SECURITY_TOKEN"); // endpoint填写桶所在的endpoint, 此处以华北-北京四为例，其他地区请按实际情况填写。 String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; // 您可以通过环境变量获取endPoint，也可以使用其他外部引入方式传入。 // String endPoint = System.getenv("ENDPOINT"); // 创建ObsClient实例 // 使用永久AK/SK初始化客户端 ObsClient obsClient = new ObsClient(ak, sk, endPoint); // 使用临时AK/SK和SecurityToken初始化客户端 // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint); try { String exampleBucket = "examplebucket"; // 指定加密方式,此处以SSE-KMS为例 BucketEncryption encryption = new BucketEncryption(SSEAlgorithmEnum.KMS); obsClient.setBucketEncryption(exampleBucket, encryption); System.out.println("SetBucketEncryption successfully"); } catch (ObsException e) { System.out.println("SetBucketEncryption failed"); // 请求失败,打印http状态码 System.out.println("HTTP Code:" + e.getResponseCode()); // 请求失败,打印服务端错误码 System.out.println("Error Code:" + e.getErrorCode()); // 请求失败,打印详细错误信息 System.out.println("Error Message:" + e.getErrorMessage()); // 请求失败,打印请求id System.out.println("Request ID:" + e.getErrorRequestId()); System.out.println("Host ID:" + e.getErrorHostId()); e.printStackTrace(); } catch (Exception e) { System.out.println("SetBucketEncryption failed"); // 其他异常信息打印 e.printStackTrace(); } } } ```