# 获取桶的自定义域名(Java SDK)
#### 功能介绍
本章节主要指导用户获取OBS桶的自定义域名列表。
#### 接口约束
- 您必须是桶拥有者或拥有获取桶的自定义域名配置的权限，才能获取桶的自定义域名配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketCustomDomain权限，如果使用桶策略则需授予GetBucketCustomDomain权限。相关授权方式介绍可参见[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.getBucketCustomDomain(GetBucketCustomDomainRequest request)
#### 请求参数说明
表1GetBucketCustomDomainRequest 
| **参数名称** | **参数类型** | **是否必选** | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|:---|
| bucketName    | String        | 必选          | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。  - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。  - 禁止使用IP地址。  - 禁止以"-"或"."开头及结尾。  - 禁止两个"."相邻（如："my..bucket"）。  - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。    - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。   **取值范围：** 无 **默认取值：** 无 |
   
#### 返回结果说明
| **类型**                                                    | **说明**                                              |
|:---|:---|
| [BucketCustomDomainInfo] | **参数解释：** 桶自定义域名信息。 |
   
 表2BucketCustomDomainInfo 
| **参数名称**                                                                        | **参数类型**                                                                                           | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|
| domains                                                                           | List\<[Domains]\>                                                   | **参数解释：** 自定义域名列表。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| statusCode | int                         | **参数解释：** HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。 完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 **默认取值：** 无 |
| responseHeaders              | Map\<String, Object\> | **参数解释：** HTTP响应消息头列表，由多个元组构成。元组中String代表响应消息头的名称，Object代表响应消息头的值。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
   
 表3Domains 
| **参数名称**         | **参数类型**        | **描述**                                               |
|:---|:---|:---|
| domainName     | String           | **参数解释：** 自定义域名。        |
| createTime     | java.util.Date | **参数解释：** 自定义域名创建时间。  |
| certificateId | String           | **参数解释：** CCM上的证书ID。 |
   
#### 代码示例
本示例用于获取桶自定义域名。
```
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.BucketCustomDomainInfo;
import com.obs.services.model.GetBucketCustomDomainRequest;
import java.util.Map;
public class GetBucketCustomDomain {
    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");
        String endPoint = "https://obs.cn-north-4.myhuaweicloud.com";
        // 创建ObsClient实例
        try (ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint)) {
            // 示例桶名
            String exampleBucket = "example-bucket";
            // 获取桶的自定义域名
            GetBucketCustomDomainRequest getBucketCustomDomainRequest = new GetBucketCustomDomainRequest(exampleBucket);
            BucketCustomDomainInfo bucketCustomDomainInfo =
                obsClient.getBucketCustomDomain(getBucketCustomDomainRequest);
            System.out.println("StatusCode:" + bucketCustomDomainInfo.getStatusCode());
            System.out.println("RequestId:" + bucketCustomDomainInfo.getRequestId());
            for(BucketCustomDomainInfo.Domains domain : bucketCustomDomainInfo.getDomains()) {
                System.out.println("DomainName:" + domain.getDomainName());
                System.out.println("CertificateId:" + domain.getCertificateId());
                System.out.println("CreateTime:" + domain.getCreateTime());
                System.out.println();
            }
            System.out.println("GetBucketCustomDomain successfully");
        } catch (ObsException e) {
            System.out.println("GetBucketCustomDomain 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("GetBucketCustomDomain failed");
            // 其他异常信息打印
            e.printStackTrace();
        }
    }
}
```
#### 相关链接
- 关于获取桶的自定义域名配置的API说明，请参见[获取桶的自定义域名](https://support.huaweicloud.com/api-obs/obs_04_0060.html)。
- 获取桶的自定义域名配置过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。
 
