更新时间:2026-08-14 GMT+08:00

设置桶加密配置

功能介绍

设置桶的加密配置,以允许在该桶中上传对象时,采用对应加密配置对数据进行加密,数据在服务端被加密成密文后存储,用户下载加密对象时,存储的密文会先在服务端解密为明文,再提供给用户。调用设置桶加密配置接口,您可以为指定桶创建或更新加密配置信息。

接口约束

  • 您必须是桶拥有者或拥有设置桶加密配置的权限,才能设置桶加密配置。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:PutEncryptionConfiguration权限,如果使用桶策略则需授予PutEncryptionConfiguration权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略自定义创建桶策略
  • OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点

方法定义

obsClient.setBucketEncryption(SetBucketEncryptionRequest request)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

request

表2 SetBucketEncryptionRequest

必选

参数解释:

设置桶的加密配置请求参数,详见表2 SetBucketEncryptionRequest

表2 SetBucketEncryptionRequest

参数名称

参数类型

是否必选

描述

bucketName

String

必选

参数解释

桶名。

约束限制:

  • 桶的名字需全局唯一,不能与已有的任何桶名称重复,包括其他用户创建的桶。
  • 桶命名规则如下:
    • 3~63个字符,数字或字母开头,支持小写字母、数字、“-”、“.”。
    • 禁止使用IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻(如:“my..bucket”)。
    • 禁止“.”和“-”相邻(如:“my-.bucket”和“my.-bucket”)。
  • 同一用户在同一个区域多次创建同名桶不会报错,创建的桶属性以第一次请求为准。

默认取值:

bucketEncryption

BucketEncryption

必选

参数解释:

桶的加密配置。

取值范围:

详见BucketEncryption

默认取值:

表3 BucketEncryption

参数名称

参数类型

是否必选

描述

sseAlgorithm

SSEAlgorithmEnum

必选

参数解释:

服务端加密的加密方式。

取值范围:

详见SSEAlgorithmEnum

默认取值:

kmsKeyId

String

可选

参数解释:

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

取值范围:

有效值支持两种格式:

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

其中:

默认取值:

如果用户没有提供该头域,那么默认的主密钥将会被使用。

表4 SSEAlgorithmEnum

常量名

原始值

说明

KMS

kms

选择SSE-KMS方式加密对象。

AES256

AES256

选择SSE-OBS方式加密对象。

返回结果说明

表5 返回结果HeaderResponse(SDK公共响应结果)各项属性说明

参数名称

参数类型

描述

statusCode

int

参数解释:

HTTP状态码。

取值范围:

状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。

完整的状态码列表请参见状态码

默认取值:

responseHeaders

Map<String, Object>

参数解释:

HTTP响应消息头列表,由多个元组构成。元组中String代表响应消息头的名称,Object代表响应消息头的值。

默认取值:

代码示例

本示例用于设置桶的加密配置,加密方式为KMS。

import android.util.Log;
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.BucketEncryption;
import com.obs.services.model.HeaderResponse;
import com.obs.services.model.SSEAlgorithmEnum;

// 注意:网络操作必须在子线程中执行,否则会抛出NetworkOnMainThreadException
new Thread(() -> {
    // 安全提示:硬编码AK/SK存在安全风险,建议从安全凭证管理系统获取
    String ak = System.getenv("ACCESS_KEY_ID");
    String sk = System.getenv("SECRET_ACCESS_KEY");
    String endPoint = "https://your-endpoint";

    ObsClient obsClient = null;
    try {
        obsClient = new ObsClient(ak, sk, endPoint);

        String bucketName = "examplebucket";

        // 设置桶加密配置为KMS加密
        BucketEncryption encryption = new BucketEncryption();
        encryption.setSseAlgorithm(SSEAlgorithmEnum.KMS);

        HeaderResponse response = obsClient.setBucketEncryption(bucketName, encryption);
        Log.i("ObsDemo", "设置桶加密配置成功,statusCode: " + response.getStatusCode());
    } catch (ObsException e) {
        Log.e("ObsDemo", "设置桶加密配置失败,HTTP状态码: " + e.getResponseCode()
                + ",错误码: " + e.getErrorCode()
                + ",错误信息: " + e.getErrorMessage());
    } finally {
        if (obsClient != null) {
            try {
                obsClient.close();
            } catch (Exception e) {
                Log.e("ObsDemo", "关闭ObsClient失败", e);
            }
        }
    }
}).start();