域名配置接口

查询加速域名详情接口

Method Path Action
GET /v2/domain/{domain}/config 获取指定加速域名配置的基本信息

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

响应体 (Response Body)

参数 类型 说明
domain String 接入CDN进行加速的域名
cname String 为加速域名生成的一个CNAME域名,需要在域名解析服务商处将加速域名CNAME解析到该域名
status String 加速域名运行状态:RUNNING、STOPED
createTime Timestamp 域名创建时间
lastModifyTime Timestamp 最近修改时间
isBan String 是否封禁:NO表示未封禁,YES表示已封禁
origin list 源站配置
defaultHost String 默认回源host,当源站级别host不存在时,使用域名级别的默认host
cacheTTL list 文件类型与路径的缓存策略
limitRate Int 下载限速,单位Byte/s
requestAuth requestAuth 访问鉴权配置
https HTTPSConfig HTTPS加速配置
followProtocol Bool 是否开启了协议跟随回源
seoSwitch seoSwitch seo 开关配置

其中 HTTPSConfig的类型如下:

参数 可选 类型 说明
enabled 必选 Bool 开启HTTPS加速,默认为False
certId 可选 String 当enabled=true时为必选,为SSL证书服务返回的证书ID
httpRedirect 可选 Bool 为True时将HTTP请求302重定向到HTTPS,默认为False
httpRedirectCode 可选 Int 重定向状态码,可选值301/302,默认302
http2Enabled 可选 Bool 开启HTTP2特性,默认True
httpOrigin 可选 Bool 当为True时以HTTP协议回源,默认为False
sslVersion 可选 String 设置TLS版本,内容为以下四个之一SSLV3,TLSV1,TLSV11,TLSV12。

请求示例

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

响应示例

HTTP/1.1 200 OK
Content-Length: 190
Content-Type: application/json;utf-8
x-bce-request-id: 81d0b05f-5ad4-1f22-8068-d5c9de60a1d7
Server: BCE-CDN
{
    "domain":"myself.baidu.com",
    "cname":"myself.baidu.com.jomodns.com",
    "status": "RUNNING",
    "createTime":"2014-06-17T18:10:22Z",
    "lastModifyTime": "2014-06-17T18:10:22Z",
    "origin": [
        {"peer":"http://1.2.3.4"},
        {"peer":"http://1.2.3.5"}
    ],
    "cacheTTL" : [
        {"type": "suffix", "value": ".jpg", "ttl":36000, "weight": 30},
        {"type": "suffix", "value": ".mp4", "ttl":36000, "weight": 30},
        {"type": "path", "value: "/path/to/my/file", "ttl":1800, "weight": 5}
    ],
    "cacheFullUrl": true,
    "limitRate": 1024000
}

更新加速域名回源地址

本接口用于更新指定加速域名回源地址。此域名必须是本用户的,否则会返回403失败。

Method Path 说明
PUT /v2/domain/{domain}/config?origin 修改加速域名的配置

请求体(Request Body)

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

响应码 (Http Status Code)

HTTP Status Code 说明
200 成功

请求示例

PUT /v2/domain/myself.baidu.com/config?origin HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 145
Content-Type: text/json;utf-8

{
  "origin":
  [
    {"peer": "http://origin.server.com"}
  ]
}

响应示例

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

设置SEO开关属性

Method Path 说明
PUT /v2/domain/{domain}/config?seoSwitch 设置 seo 开关属性

请求体(Request Body)

参数 可选 类型 说明
seoSwitch 必选 seoSwitch 设置 seo 开关属性

seoSwitch 类型如下:

参数 可选 类型 说明
diretlyOrigin 可选 String ON 表示设置直接回源,OFF 则相反
pushRecord 可选 String ON 表示给大搜推送访问记录,OFF则相反

diretlyOrigin 和 pushRecord 只能取 "ON|OFF"

请求示例:

PUT /v2/domain/myself.baidu.com/config?seoSwitch HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 72
Content-Type: text/json;utf-8
{
    "seoSwitch": {"diretlyOrigin": "ON","pushRecord" : "OFF"}
}

响应码 (Http Status Code)

HTTP Status Code 说明
200 成功
400 更新失败,参数错误等

响应体 (Response Body)

参数 类型 说明
status String 刚更新成功返回的status是OPERATING

响应示例:

Sample Response
HTTP/1.1 200 OK
Server: nginx/1.14.0
Date: Fri, 21 Sep 2018 03:46:35 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
X-Powered-By: PHP/5.6.36
x-bce-request-id: dd490e5d-64da-e2b-1cdd-fc98c864dfd
{"status":"OPERATING"}

查询SEO开关属性

Method Path 说明
GET /v2/domain/{domain}/config?seoSwitch 查询 seo 开关属性

请求体(Request Body)

参数 可选 类型 说明
seoSwitch 必选 seoSwitch 查询 seo 开关属性

seoSwitch 类型如下:

参数 可选 类型 说明
diretlyOrigin 可选 String ON 表示设置直接回源,OFF 则相反
pushRecord 可选 String ON 表示给大搜推送访问记录,OFF则相反

diretlyOrigin 和 pushRecord 只能取 "ON|OFF"

请求示例:

GET /v2/domain/myself.baidu.com/config?seoSwitch HTTP/1.1
Host: cdn.baidubce.com

响应码 (Http Status Code)

HTTP Status Code 说明
200 成功

响应体 (Response Body)

参数 类型 说明
status seoSwitch 返回 seo 开关的当前状态

响应示例:

HTTP/1.1 200 OK
Server: nginx/1.14.0
Date: Fri, 21 Sep 2018 03:46:35 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
X-Powered-By: PHP/5.6.36
x-bce-request-id: fb39f52e-203d-5558-6543-15bbaaf6b4a7
{"seoSwitch":{"diretlyOrigin":"ON","pushRecord":"OFF"}}

查询缓存过期规则

本接口用于查询指定加速域名的缓存策略。此域名必须是本用户的,否则会返回403失败。

Method Path 说明
GET /v2/domain/{domain}/config?cacheTTL 查询域名的缓存策略

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

响应体 (Response Body)

参数 类型 说明
cacheTtl CacheTTL 缓存规则列表

CacheTTL

参数 可选 类型 说明
type 必选 String "suffix"表示文件名后缀,"path"表示url中的目录,"origin"表示源站规则,此规则只有一条,只表示出权重即可,value为"-", ttl为 0
"code"表示异常码缓存,如可以配置404缓存100s
value 必选 String type所指定类型的配置规则
weigh 可选 Int 权重,0-100的整数,权重越高优先级越高,默认为0,优先级在为code类型下是没有作用的,可以忽略
ttl 必选 Int 缓存时间,单位为秒

设置缓存过期规则

本接口用于更新指定加速域名的缓存策略。此域名必须是本用户的,否则会返回403失败。

Method Path 说明
PUT /v2/domain/{domain}/config?cacheTTL 修改加速域名文件类型的缓存策略

请求体(Request Body)

参数 可选 类型 说明
cacheTtl 必选 CacheTTL 缓存规则列表

CacheTTL

参数 可选 类型 说明
type 必选 String "suffix"表示文件名后缀,"path"表示url中的目录,"origin"表示源站规则,此规则只有一条,只表示出权重即可,value为"-", ttl为 0
"code"表示异常码缓存,如可以配置404缓存100s
value 必选 String type所指定类型的配置规则
weigh 可选 Int 权重,0-100的整数,权重越高优先级越高,默认为0,优先级在为code类型下是没有作用的,可以忽略
ttl 必选 Int 缓存时间,单位为秒

响应码 (Http Status Code)

HTTP Status Code 说明
200 成功

请求示例

PUT /v2/domain/myself.baidu.com/config?cacheTTL HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 145
Content-Type: text/json;utf-8

{
    "cacheTTL":
    [
        {"type": "suffix", "value": ".jpg", "ttl":36000, "weight": 30},
        {"type": "suffix", "value": ".mp4", "ttl":36000, "weight": 30},
        {"type": "path", "value": "/path/to/my/file", "ttl":1800, "weight": 5}
    ]
}

响应示例

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

设置缓存参数过滤规则

Method Path 说明
PUT /v2/domain/{domain}/config?cacheFullUrl 设置全URL缓存

请求体

参数 可选 类型 说明
cacheFullUrl 必选 Bool true和false,true表示设置全URL缓存,false表示忽略参数

请求示例

PUT /v2/domain/myself.baidu.com/config?cacheFullUrl HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 19
Content-Type: text/json;utf-8

{
    "cacheFullUrl": true
}

响应示例

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

设置访问Referer控制

Method Path 说明
PUT /v2/domain/{domain}/config?refererACL 设置访问Referer配置

请求体(Request Body)

参数 可选 类型 说明
refererACL 必选 RefererACL参数项解释如下:
- blackList:可选项,list类型,表示referer黑名单列表,支持通配符
- whiteList:可选项,list类型,表示referer白名单列表,支持通配符

- allowEmpty:必选项,Bool类型,表示是否允许空referer访问,默认为true即允许空referer访问。
访问Referer配置规则

blackList和whiteList不可同时存在。

请求示例

PUT /v2/domain/myself.baidu.com/config?refererACL HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 35
Content-Type: text/json;utf-8

{
    "refererACL": 
    {
        "blackList": ["http://a.b.c", "http://c.d.e"],
        "allowEmpty":true
    }
}

响应示例

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

设置访问IP控制

Method Path 说明
PUT /v2/domain/{domain}/config?ipACL 设置访问IP配置

请求体(Request Body)

参数 可选 类型 说明
ipACL 必选 ipACL 访问IP配置规则

ipACL类型如下:

参数 可选 类型 说明
blackList 可选 list<String> Ip黑名单列表,支持CIDR格式表示的IP段
whiteList 可选 list<String> Ip白名单,支持CIDR格式表示的IP段

blackList和whiteList不可同时存在。

请求示例

PUT /v2/domain/myself.baidu.com/config?ipAcl HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 35
Content-Type: text/json;utf-8

{
    "ipACL": {"blackList": ["1.1.1.2", "1.1.1.3"]}
}

响应示例

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

设置限速

Method Path 说明
PUT /v2/domain/{domain}/config?limitRate 设置限速

请求体(Request Body)

参数 可选 类型 说明
limitRate 必选 Int 限速值,单位Byte/s,0表示为不限速

请求示例

PUT /v2/domain/myself.baidu.com/config?limitRate HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 18
Content-Type: text/json;utf-8

{
    "limitRate": 1024
}

响应示例

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

设置HTTPS加速

Method Path 说明
PUT /v2/domain/{domain}/config?https 配置HTTPS加速

请求体(Request Body)

参数 可选 类型 说明
https 必选 HTTPSConfig HTTPS配置信息

请求示例

PUT /v2/domain/myself.baidu.com/config?https HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 18
Content-Type: text/json;utf-8

{
    "https": {
        "enabled": True,
        "certId": "ssl-82fdaufdsaldsuaow"
    }
}

响应示例

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

设置访问鉴权

Method Path 说明
PUT /v2/domain/{domain}/config?requestAuth 配置访问鉴权

请求体(Request Body)

参数 可选 类型 说明
requestAuth 必选 requestAuth 访问鉴权配置

requestAuth类型

参数 可选 类型 说明
type 必选 String A/B/C 三种鉴权方式
key1 必选 String 主鉴权key,输入大小写字母,数字,长度6到32位
key2 可选 String 副鉴权Key,输入大小写字母,数字,长度6到32位
timeout 可选 Int 鉴权缓存时间,支持B或C方式设置该参数,单位为秒;URL鉴权的过期时间为指定“timestamp+timeout”;默认为1800。
whiteList 可选 List 白名单列表,在该名单中的文件名不需要鉴权
signArg 可选 String 签名参数名,只对typeC生效
timeArg 可选 String 时间戳参数名,只对typeC生效

请求示例

PUT /v2/domain/myself.baidu.com/config?requestAuth HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 18
Content-Type: text/json;utf-8

{
    "requestAuth": {
        "type": "c",
        "key1": "secretekey1",
        "key2": "secretekey2",
        "timeout": 300,
        "whiteList": ["/crossdomain.xml"],
        "signArg":"sign",         
        "timeArg":"t"     

    }
}

设置协议跟随回源

Method Path 说明
PUT /v2/domain/{domain}/config?followProtocol 配置协议跟随回源

请求体(Request Body)

参数 可选 类型 说明
followProtocol 必选 Bool 默认为false,http回源;为true时,回源协议和请求协议一致。

请求示例

PUT /v2/domain/myself.baidu.com/config?followProtocol HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 18
Content-Type: text/json;utf-8

{
    "followProtocol" : true
}

响应示例

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

查询Http Header

本接口用于查询指定加速域名设置的Http Header。此域名必须是本用户的,否则会返回403失败。

Method Path 说明
GET /v2/domain/{domain}/config?httpHeader 查询域名的Header

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

响应体 (Response Body)

参数 类型 说明
httpHeader HttpHeader 设置的回源或响应Header

HttpHeader

参数 可选 类型 说明
type 必选 String "origin"表示此header 回源生效,"response"表示给用户响应时生效
header 必选 String header为http头字段,一般为HTTP的标准Header,也可以是用户自定义的;如x-bce-authoriztion
value 必选 String 指定Header的值
action 可选 String 表示是删除还是添加,可选remove/add,默认是add;目前console只支持add action; API做后端remove配置的兼容
describe 可选 String 描述,可选,可以是中文,统一使用Unicode统码;长度不能超过100个字符

设置Http Header

本接口用于添加指定加速域名设置的Http Header。此域名必须是本用户的,否则会返回403失败。

注意:此接口为全量接口,设置时需要将已有的Header设置也要一并写入,否则原有配置会被覆盖。

Method Path 说明
PUT /v2/domain/{domain}/config?httpHeader 修改或删除加速域名对应的回源Header或响应Header

请求体(Request Body)

参数 可选 类型 说明
httpHeader 必选 HttpHeader 设置的回源或响应Header

响应码 (Http Status Code)

Http Status Code 说明
200 成功

响应体 (Response Body)

参数 类型 说明
status String 因更新动作是异步调用,故成功后返回的status是OPERATING,目标状态为RUNNING

请求示例

PUT /v2/domain/myself.baidu.com/config?httpHeader HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 145
Content-Type: text/json;utf-8

{
    "httpHeader":
    [
        {"type": "origin", "header": "x-auth-cn", "value":"xxxxxxxxx", "action": "add"},
        {"type": "response", "header": "content-type", "value":"application/octet-stream", "action": "add"}
    ]
}

响应示例

HTTP/1.1 200 OK
Content-Length: 190
Content-Type: application/json;utf-8
x-bce-request-id: 81d0b05f-5ad4-1f22-8068-d5c9de60a1d7
Server: BCE-CDN
{
    "status": "OPERATING|RUNNING"
}