文档首页/对象存储服务 OBS/Java SDK开发指南（联盟区域）/管理桶(Java SDK)/设置桶的自定义域名(Java SDK)
更新时间：2026-01-15 GMT+08:00
查看PDF
分享

设置桶的自定义域名(Java SDK)

功能介绍

设置OBS桶的自定义域名。

接口约束

  • 您必须是桶拥有者或拥有设置桶加密配置的权限，才能设置桶加密配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:SetBucketCustomDomain权限，如果使用桶策略则需授予SetBucketCustomDomain权限。

方法定义

ObsClient.setBucketCustomDomain(SetBucketCustomDomainRequest request)

请求参数说明

表1 SetBucketCustomDomainRequest

参数名称

参数类型

是否必选

描述

bucketName

String

必选

参数解释：

桶名。

约束限制：

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

取值范围：

无

默认取值：

无

domainName

String

必选

参数解释：

自定义域名。

约束限制：

无

取值范围：

无

默认取值：

无

customDomainCertificateConfig

CustomDomainCertificateConfig

可选

参数解释：

自定义域名证书配置。

约束限制：

自定义域名证书配置只支持https协议请求。

取值范围：

CustomDomainCertificateConfig

默认取值：

无

表2 CustomDomainCertificateConfig

参数名称

参数类型

是否必选

描述

name

String

必选

参数解释：

证书名称。

约束限制：

无

取值范围：

长度为3~63的字符串。

默认取值：

无

certificateId

String

可选

参数解释：

CCM上的证书证书ID。

约束限制：

无

取值范围：

长度为16的字符串。

默认取值：

无

certificate

String

必选

参数解释：

证书内容，可包含中间证书及根证书。若certificateChain字段传入证书链，则该字段只取证书本身。回车换行需要使用转义字符\n或者\r\n替换。

约束限制：

无

取值范围：

无

默认取值：

无

certificateChain

String

可选

参数解释：

证书链，非必填，可通过certificate字段传入。回车换行需要使用转义字符\n或者\r\n替换。

约束限制：

无

取值范围：

无

默认取值：

无

privateKey

String

必选

参数解释：

证书私钥。 不能上传带有口令保护的私钥，回车换行需要使用转义字符\n或者\r\n替换。

约束限制：

无

取值范围：

无

默认取值：

无

返回结果说明

类型

说明

HeaderResponse

参数解释：

SDK公共结果对象。

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

参数名称

参数类型

描述

statusCode

int

参数解释：

HTTP状态码。

取值范围：

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

默认取值：

无

responseHeaders

Map<String, Object>

参数解释：

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

默认取值：

无

代码示例

本示例用于设置桶自定义域名。 
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.CustomDomainCertificateConfig;
import com.obs.services.model.HeaderResponse;
import com.obs.services.model.SetBucketCustomDomainRequest;

import java.util.Map;

public class SetBucketCustomDomain {
    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, 此处以华北-北京四为例，其他地区请按实际情况填写。
        // 您可以通过环境变量获取endPoint，也可以使用其他外部引入方式传入。
        // String endPoint = System.getenv("ENDPOINT_S");
        String endPoint = "https://obs.cn-north-4.myhuaweicloud.com";

        // 创建ObsClient实例
        ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint);
        try {
            // 示例桶名
            String exampleBucket = "example-bucket";
            // 示例自定义域名
            String exampleDomainName = "example.domain.name.com";
            // 示例自定义域名证书名称
            String exampleDomainCertificateName = "exampleCertName";
            // 示例自定义域名证书ID
            String exampleDomainCertificateId = "1234512345123450";
            // 示例自定义域名证书
            String exampleDomainCertificate = "exampleDomainCertificate";
            // 示例自定义域名证书链
            String exampleDomainCertificateChain = "exampleDomainCertificateChain";
            // 示例自定义域名证书私钥
            String exampleDomainCertificatePrivateKey = "exampleDomainCertificatePrivateKey";
            CustomDomainCertificateConfig customDomainCertificateConfig = new CustomDomainCertificateConfig();
            customDomainCertificateConfig.setName(exampleDomainCertificateName);
            customDomainCertificateConfig.setCertificateId(exampleDomainCertificateId);
            customDomainCertificateConfig.setCertificate(exampleDomainCertificate);
            customDomainCertificateConfig.setCertificateChain(exampleDomainCertificateChain);
            customDomainCertificateConfig.setPrivateKey(exampleDomainCertificatePrivateKey);
            SetBucketCustomDomainRequest setBucketCustomDomainRequest =
                new SetBucketCustomDomainRequest(exampleBucket, exampleDomainName, customDomainCertificateConfig);
            // 设置桶的自定义域名
            HeaderResponse response = obsClient.setBucketCustomDomain(setBucketCustomDomainRequest);
            System.out.println("StatusCode:" + response.getStatusCode());
            System.out.println("RequestId:" + response.getRequestId());
            System.out.println("SetBucketCustomDomain successfully");
        } catch (ObsException e) {
            System.out.println("SetBucketCustomDomain 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());
            // 遍历Map的entry,打印所有报错相关头域
            Map<String, String> headers = e.getResponseHeaders();
            if(headers != null){
                for (Map.Entry<String, String> header : headers.entrySet()) {
                    System.out.println(header.getKey()+":"+header.getValue());
                }
            }
            e.printStackTrace();
        } catch (Exception e) {
            System.out.println("SetBucketCustomDomain failed");
            // 其他异常信息打印
            e.printStackTrace();
        }
    }
}