文档首页/ 对象存储服务 OBS/ SDK参考/ Android/ 桶相关接口/ 自定义域名/ 设置桶的自定义域名
更新时间：2026-08-14 GMT+08:00
查看PDF
分享

设置桶的自定义域名

功能介绍

本章节主要指导用户如何设置OBS桶的自定义域名。

接口约束

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

方法定义

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 android.util.Log;
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.BucketCustomDomainInfo;
import com.obs.services.model.HeaderResponse;

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";

        BucketCustomDomainInfo customDomainInfo = new BucketCustomDomainInfo();
        customDomainInfo.setCustomDomain("custom.example.com");

        HeaderResponse response = obsClient.setBucketCustomDomain(bucketName, customDomainInfo);
        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();
父主题： 自定义域名