You need to enable JavaScript to run this app.
导航
对象存储
  • 文档首页
    • /
  • 对象存储

GetBucketCustomDomain

最近更新时间：2023.11.21 10:22:22

首次发布时间：2023.05.24 16:53:12

我的收藏

功能描述

此接口用于用于获取指定存储空间（Bucket）的自定义域名配置。

注意事项

调用此接口您必须为桶所有者，或被授权当前桶的 GetBucketCustomDomain 权限。

请求消息样式

GET /?customdomain HTTP/1.1
Host: bucketname.tos-cn-beijing.volces.com
Date: Fri, 30 Jul 2021 08:05:36 +0000
Authorization: authorization string

请求参数和消息头

该请求使用的公共请求消息头，请参见公共参数。

名称

位置

参数类型

是否必选

示例值

说明

customdomain

Query

String

是

-

代表 GetBucketCustomDomain请求的特殊标识。

请求元素

该请求不使用消息元素。

响应消息头

该请求返回的公共响应消息头，请参见公共参数。

响应元素

名称

参数类型

示例值

说明

CustomDomainRules

Array

-

自定义域名列表。

Domain

String

example.com

绑定的自定义域名。

Cname

String

bucketname.tos-cn-beijing.volces.com

用于配置 CNAME 记录的值。

Forbidden

Bool

false

域名是否被禁用。取值说明如下：

  • false：未被禁用。
  • true：已被禁用。

ForbiddenReason

String

DomainUnregistered

域名被禁用原因。取值说明如下：

  • Illegal：非法使用。
  • DomainUnregistered： 域名未备案。
  • Other：其它原因。

CertId

String

cert-9228928537e540f9a6a2fc844672****

证书 ID。

CertStatus

String

CertUnbound

证书状态。取值说明如下：

  • CertBound：已绑定证书。
  • CertUnbound：未绑定证书。
  • CertExpired： 证书已过期。
  • CertNotExist： 证书不存在。
  • RoleNotExist： 跨服务授权失败。
  • CertUnknown： 证书状态位置。

请求示例

GET /?customdomain HTTP/1.1
Host: bucketname.tos-cn-beijing.volces.com
Date: Fri, 30 Jul 2021 08:05:36 +0000
Authorization: authorization string

响应示例

HTTP/1.1 200 OK
Date: Fri, 30 Jul 2021 13:53:55 GMT
Server: TosServer
x-tos-id-2: 1e89f203jld00006-a444fd0
x-tos-request-id: 1e89f203b2d00006-a444ed0
Content-Length: 287

{
    "CustomDomainRules": [
        {
            "Domain": "examble.com",
            "Cname": "bucketname.tos-cn-beijing.volces.com",
            "Forbidden": false,
            "ForbiddenReason": "",
            "CertId": "",
            "CertStatus": "CertUnbound"
        }
    ]
}