域名操作接口

域名列表查询

请求

Method Path 说明
GET /v2/domain 查询用户的域名列表

响应

参数 类型 说明
domains list类型,表示DomainInfo。list项如下:
- name:String类型,表示域名。
用户域名列表
isTruncated Bool true表示后面还有数据,false表示已经是最后一页。
nextMarker String 当isTruncated为false时,该域不出现。用户通过在下次调用本接口时指定该marker标记来获取后续的列表。

请求示例

GET /v2/domain HTTP/1.1
Host: cdn.baidubce.com

响应示例

HTTP/1.1 200 OK
Server: nginx
Date: Tue, 26 Jul 2016 05:02:53 GMT
Content-Type: application/json; charset=utf-8
Connection: keep-alive
Content-Length: 142

{
  "isTruncated":false,
  "domains":
  [
    {"name":"123.abc.com"},
    {"name":"456.def.net"},
    {"name":"789.ghi.com"}
  ]
}

查询用户名下所有域名

Method Path 说明
GET /v2/user/domains 查询用户名下单所有域名以及域名的状态,支持域名的模糊匹配过滤和域名状态过滤

请求(Request)

参数 可选 类型 说明
status 必选 String 过滤域名状态:如果为ALL,表示查询所有状态的域名,如果为"RUNNING"查询加速的域名,"STOPPED"查询停止加速的域名,"OPERATING"查询操作中的域名
rule 可选 String 表示支持域名的模糊匹配:比如"ao.com"则会查询用户名下所有包含"ao.com"字段的域名,比如"abc.hao.com"。注意:字段只能由字母、数字和'.'组成,不能包含特殊字符。

响应(Response)

参数 类型 说明
domains list类型,表示域名列表 该用户的所有域名

其中domains单个对象组成:

参数 类型 说明
domain String 域名名称
status String 对应状态,"RUNNING"表示加速域名,"OPERATING"表示正在操作的域名,"STOPPED"表示停止加速的域名

请求示例

GET /v2/user/domains?status=ALL&rule=abc.com HTTP/1.1
Host: cdn.baidubce.com

请求说明:表示查询该用户名下所有包含"abc.com"的域名

响应示例

HTTP/1.1 200 OK
Server: nginx
Date: Thu, 18 Apr 2019 04:23:26 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
X-Powered-By: PHP/7.1.5
x-bce-request-id: ca0aaebb-110e-0ecd-8bf2-3b899cd67f3b

{
    "domains":
  [
    {"domain":"123.abc.com","status":"RUNNING"},
    {"domain":"456.abc.com","status":"STOPPED"},
    {"domain":"789.abc.com","status":"OPERATING"}
  ]
}

查询域名是否可添加

Method Path 说明
GET /v2/domain/{domain}/valid 查询域名是否可以被添加

domain:被查询的域名

响应体 (Response Body)

参数 可选 类型 说明
isValid 必选 Boolean true表示该域名能被添加,false表示该域名不能被添加
message 可选 String 对于情况进行说明,如果不能被添加则说明原因

请求示例

GET /v2/domain/abc.test.com/valid HTTP/1.1
Host: cdn.baidubce.com

响应示例

  • 域名能被添加

    HTTP/1.1 200 OK
    Server: nginx
    Date: Thu, 18 Apr 2019 04:23:26 GMT
    Content-Type: application/json; charset=utf-8
    Transfer-Encoding: chunked
    Connection: keep-alive
    X-Powered-By: PHP/7.1.5
    x-bce-request-id: ca0aaebb-110e-0ecd-8bf2-3b899cd67f3b
    
    {
        "isValid":true,
        "message":"the domain is valid"
    }
    
  • 域名不能被添加

    HTTP/1.1 200 OK
    Server: nginx
    Date: Thu, 18 Apr 2019 04:23:26 GMT
    Content-Type: application/json; charset=utf-8
    Transfer-Encoding: chunked
    Connection: keep-alive
    X-Powered-By: PHP/7.1.5
    x-bce-request-id: ca0aaebb-110e-0ecd-8bf2-3b899cd67f3b
    
    {
        "isValid": false,
        "message": "the domain already exists"
    }
    

创建加速域名接口

本接口用于创建指定的域名。

Method Path 说明
PUT /v2/domain/{domain} 创建一个加速域名

domain:表示需要创建CDN的加速域名

请求体(Request Body)

参数 可选 类型 说明
origin 必选 list类型,表示OriginPeer。 源站配置
defaultHost 可选 String 默认回源host,当源站级别host不存在时,使用域名级别的默认host

OriginPeer类型如下:

参数 可选 类型 说明
peer 必选 String 格式为{protocol:}{address},其中protocol可选,目前只支持https,address必须为ip或者域名
host 可选 String 回源时使用的host值,该host为源站级别的host,每个源站可以配置一个host
backup 可选 Bool 备份源站
follow 302 可选 Bool 开启回源follow 302

响应码 (Http Status Code)

HTTP Status Code 说明
201 创建成功
400 域名已经存在、域名检查失败、缺乏必要参数、参数值错误、域名被封禁

响应体 (Response Body)

参数 类型 说明
status String 刚创建成功返回的status是PENDING
cname String 生成的CNAME域名,用户通过将加速域名CNAME至该域名实现加速

请求示例

PUT /v2/domain/1.test.com HTTP/1.1
Host: cdn.baidubce.com
Accept: */*
Content-Length: 77
Content-Type: application/x-www-form-urlencoded
{
  "origin":
  [
    {"peer": "http://origin.server.com", "host": "myhost.com"}
  ]
}

响应示例

HTTP/1.1 201 Created
Server: nginx
Date: Tue, 26 Jul 2016 05:02:53 GMT
Content-Type: application/json; charset=utf-8
Connection: keep-alive

启用加速域名接口

本接口用于启用指定的域名,且域名必须是本用户的,否则会返回404失败。

Method Path 说明
POST /v2/domain/{domain}?enable 启用一个加速域名

domain:需要查询CDN的加速域名

响应码 (Http Status Code)

HTTP Status Code 说明
200 成功
404 域名不存在或不属于当前用户
400 域名当前状态不能被操作

请求示例

POST /v2/domain/myself.baidu.com?enable HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 0
Content-Type: text/json;utf-8

响应示例

HTTP/1.1 200 OK
Content-Length: 0
Content-Type: application/json;utf-8
x-bce-request-id: 81d0b05f-5ad4-1f22-8068-d5c9de60a1d7
Server: BCE-CDN

停用加速域名接口

本接口用于停用指定的域名,此域名必须是本用户的,否则会返回403失败。

Method Path 说明
POST /v2/domain/{domain}?disable 停用一个加速域名

domain:需要停用的加速域名

响应码 (Http Status Code)

HTTP Status Code 说明
200 成功
404 域名不存在或不属于当前用户
400 域名当前状态不能被操作

请求示例

POST /v2/domain/myself.baidu.com?disable HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 0
Content-Type: text/json;utf-8

响应示例

HTTP/1.1 200 OK
Content-Length: 0
Content-Type: application/json;utf-8
x-bce-request-id: 81d0b05f-5ad4-1f22-8068-d5c9de60a1d7
Server: BCE-CDN

删除加速域名接口

本接口用于删除指定的域名,此域名必须是本用户的,否则会返回403失败。

Method Path 说明
DELETE /v2/domain/{domain} 删除一个加速域名

domain:需要删除的加速域名

响应码 (Http Status Code)

HTTP Status Code 说明
200 成功
404 域名不存在或不属于当前用户

响应体 (Response Body)

无。

请求示例

DELETE /v2/domain/1.test.com HTTP/1.1
Host: cdn.baidubce.com
Accept: */*
Content-Length: 0
Content-Type: application/x-www-form-urlencoded

响应示例

HTTP/1.1 200 OK
Server: nginx
Date: Tue, 26 Jul 2016 05:05:30 GMT
Content-Type: application/json; charset=utf-8
Connection: keep-alive