文档首页/ 对象存储服务 OBS/ API参考/ 桶API/ 自定义域名/ 获取桶的自定义域名-GetBucketCustomdomain
更新时间：2026-04-15 GMT+08:00
查看PDF
分享

获取桶的自定义域名-GetBucketCustomdomain

功能介绍

为桶设置了自定义域名后，可以通过本接口获取桶的自定义域名。了解更多桶自定义域名相关信息，请参见通过自定义域名访问桶。

接口约束

表1 约束与限制

限制类别

具体限制

桶版本限制

桶版本号为3.0及以上的桶支持配置自定义域名。桶版本号可以在OBS管理控制台上，进入桶概览页后，在“基本信息”中查看。

域名数量限制

每个桶默认最多配置100个自定义域名。

功能限制
  • 一个自定义域名只能配置到一个桶域名上。
  • 暂不支持配置中文域名。
  • 配置的自定义域名后缀目前支持的范围为2~63个英文大小写字母。
  • 按照工信部要求，您配置自定义域名的桶所属区域如果为中国区域，那么需要提前完成ICP备案。
  • 自定义域名通常用于公网访问OBS桶，内网访问OBS建议使用桶默认域名（bucketName.obs.endpoint.myhuaweicloud.com）
说明：

如果使用了加速域名，为防止访问OBS桶中对象变成强制下载，配置自定义域名和加速域名后还需要参考CDN加速场景下访问OBS桶内对象变成强制下载进行处理。

授权信息

您必须是桶拥有者或拥有获取桶的自定义域名的权限，才能调用本接口，建议使用IAM或桶策略进行授权。了解更多OBS授权方式请参见OBS不同权限控制方式的区别。

  • 如果使用IAM授权，那么请在“角色与策略授权”、“身份策略授权”两种IAM授权方式中选择一种，并配置相应权限：
    • 如果使用角色与策略授权（旧版IAM，即IAM v3接口），需具备obs:bucket:GetBucketCustomDomainConfiguration权限，授权操作请参见创建IAM自定义策略。
    • 如果使用身份策略授权（新版IAM，即IAM v5接口），如下表所示，需具备obs:bucket:getBucketCustomDomainConfiguration权限，授权操作请参见创建IAM自定义身份策略。

      授权项

      Action

      访问级别

      Access Level

      资源类型（*为必须）

      Resource Type (*: required)

      条件键

      Condition Key

      别名

      Alias

      依赖的授权项

      Dependencies

      obs:bucket:getBucketCustomDomainConfiguration

      Read

      bucket *

      -

      -

      -
      • obs:EpochTime
      • obs:SourceIp
      • obs:TlsVersion
      • obs:CustomDomain
  • 如果使用桶策略进行授权，需具备obs:bucket:GetBucketCustomDomainConfiguration权限，具体操作请参见自定义创建桶策略。

请求消息样式

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

请求参数

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

请求头参数（Request headers）

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

请求体参数（Request body）

该请求消息中不带请求体参数。

响应消息样式

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ListBucketCustomDomainsResult xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/">
  <Domains>
    <DomainName>domainname</DomainName>
    <CreateTime>createtime</CreateTime>
    <CertName>exampleCertificateName</CertName>
    <CertificateId>exampleCertificateId</CertificateId>
    <CertificateType>server</CertificateType>
    <ExpiredTime>2026-03-13T10:22:05.912Z</ExpiredTime>
  </Domains>
</ListBucketCustomDomainsResult>

响应头 (Response Headers)

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

响应体 (Response Body)

该响应以消息元素的形式返回桶的自定义域名，元素的具体意义如表2所示。

表2 响应体

参数

参数类型

描述

ListBucketCustomDomainsResult

Container

参数解释：

自定义域名返回结果容器。ListBucketCustomDomainsResult是Domains的父节点。

取值范围：

不涉及

Domains

Container

参数解释：

自定义域名元素。

取值范围：

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

参数

参数类型

描述

DomainName

String

参数解释：

自定义域名。

取值范围：

长度为0~256的字符串。

CreateTime

String

参数解释：

自定义域名的创建时间。

取值范围：

  • 格式要求为UTC时间，并符合ISO 8601标准。例如：2018-01-01T00:00:00.000Z，表示创建时间为2018-01-01T00:00:00.000Z。
  • 长度为24的字符串。

CertificateId

String

参数解释：

自定义域名绑定的证书ID。

取值范围：

长度为16的字符串。

CertName

String

参数解释：

自定义域名绑定的证书名称。

取值范围：

长度为3~63的字符串。

CertificateType

String

参数解释：

自定义域名绑定的证书类型。

取值范围：

  • server：服务端证书
  • server_sm：服务端国密证书
  • client：客户端CA证书

ExpireTime

String

参数解释：

证书类型为server或者server_sm时，返回自定义域名绑定的证书过期时间。

取值范围：

格式要求为UTC时间，并符合ISO 8601标准。例如：2018-01-01T00:00:00.000Z，表示创建时间为2018-01-01T00:00:00.000Z。

错误响应消息

无特殊错误，所有错误已经包含在表2中。

请求示例

1
2
3
4
5
6
 
GET /?customdomain HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com 
Accept: */*
Date: Mon, 14 Jan 2019 08:31:45 +0000
Authorization: OBS UDSIAMSTUBTEST000094:veTm8B18MPLFqNyGh2wmQqovZ2U=

响应示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
 
HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: 000001697693130C80E9D2D29FA84FC2
x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSM80AI9weqGUsIFJScVxSKlG4DmypX9
Content-Type: application/xml
Date: Wed, 13 Mar 2019 10:22:24 GMT
Content-Length: 272

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ListBucketCustomDomainsResult xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/">
  <Domains>
    <DomainName>obs.ccc.com</DomainName>
    <CreateTime>2019-03-13T10:22:05.912Z</CreateTime>
    <CertName>exampleCertificateName</CertName>
    <CertificateId>exampleCertificateId</CertificateId>
    <CertificateType>server</CertificateType>
    <ExpiredTime>2026-03-13T10:22:05.912Z</ExpiredTime>
  </Domains>
</ListBucketCustomDomainsResult>

使用SDK调用接口

建议您使用OBS SDK调用接口。SDK对API进行了封装以简化您的开发工作，直接调用SDK接口函数即可访问OBS，无需手动计算签名。

Java暂不支持

Python

C

Go

BrowserJS暂不支持

.NET暂不支持

Android暂不支持

iOS暂不支持

PHP暂不支持

Node.js暂不支持

相关文档

父主题： 自定义域名

相关文档