CDN加速

文档中心 API文档 域名配置 获取域名基础配置

获取域名基础配置

更新时间:2020-12-14 16:27:34

适用产品:网页加速、下载加速、全站加速、点播加速、直播加速、移动加速、云存储

接口描述

查看指定加速域名的配置,包含:回源策略、ssl配置、缓存规则、访问控制、回源鉴权、http头控制、客户端访问限速、错误页面跳转、视频拖拉(点播加速)等参数的配置。

请求参数

XML
参数名称类型必填描述
domain-name/domain-idString加速域名的名称或系统返回的域名ID

返回参数

XML&JSON
LIVESTREAM-XML
参数名称类型描述
domain-idInt系统返回的加速域名ID
domain-nameString加速域名的名称
created-dateString域名创建时间,格式: week, dd month yyyy hh:mm:ss GMT +8:00 如:Mon, 18 Feb 2019 02:54:19 GMT +8:00
last-modifiedString域名最近修改时间,格式: week, dd month yyyy hh:mm:ss GMT +8:00 如:Mon, 18 Feb 2019 02:54:19 GMT +8:00
service-typeString加速域名的服务类型,包括如下: web/web-https:网页加速/网页加速-https wsa/wsa-https:全站加速/全站加速-https vodstream/vod-https:点播加速/点播加速-https download/dl-https:下载加速/下载加速-https wss:防攻击
commentString备注信息,最大限制1000个字符
service-areasString加速域名的服务区域
cnameString加速域名对应的CNAME域名,例如:7nt6mrh7sdkslj.cdn30.com
statusString加速域名的部署状态,Deployed表示该加速域名配置完成部署;InProgress表示该加速域名配置的部署任务还在进行中,可能处于排队、部署中或失败任意一种状态
cdn-service-statusString加速域名的CDN服务状态,true表示启用CDN加速服务;false表示取消CDN加速服务。
enabledString加速域名的启用状态,当禁用加速域名服务后,此项为false;当启用加速域名服务后,此项为true
cname-labelString共用一级别名
origin-configcomplex回源策略设置,用于设置加速域名的源站信息和回源策略
originIpsString回源地址,可以是IP或域名。 1、IP以分号分隔,支持多个。 2、域名只能一个。 3、限制最大不能超过500个字符长度。
default-origin-host-headerString回源HOST,用于更改回源HTTP请求头中的HOST字段。
detect-urlString高级源监控url,通过该url请求<master-ips>,如果返回非2**,3**响应时,认为主要回源ip故障,此时使用<backup-ips>。 完整的url,例如:http://a.example.com/test.html
detect-periodInt高级源监控周期,单位秒,可选值为大于等于0的整数,0表示不监控
master-ipsString高级源主要回源IP,多个IP用分号“;”分隔,回源IP不能重复
backup-ipsString高级源备用回源IP,多个IP用分号“;”分隔,回源IP不能重复
sslcomplexssl证书设置,用于设置加速域名的ssl证书配置
use-sslString使用证书,可选值为true和false,true表示使用证书,false表示不使用证书
use-for-sniString使用sni证书,可选值为true和false,true表示使用sni证书,false表示使用非sni的传统证书
ssl-certificate-idInt证书ID,新增证书成功后,系统返回的证书ID
cache-behaviorscomplex查询缓存时间配置,请使用新接口:【查询缓存时间配置】接口
rewrite-rule-settingscomplex请求和回源方式设置,用于改写请求和回源的协议方式(使用需申请),请使用新接口:【查看域名内部重定向配置】接口 注意:该节点下的相关参数配置,除开通API调用权限外,还需要联系专属客服申请开通对应的API客户模板
rewrite-directionString改写方向,可选值为”cache2visitor”和“cache2origin” cache2visitor:CDN到用户端 cache2origin:CDN回源站
rewrite-typeString改写类型,可选值为protocol,当前仅支持协议的改写
rewrite-methodInt跳转方式,可选值为:301/302 注意:仅当用户到节点的请求需要强制跳转时(即rewrite-direction=cache2visitor),出参rewrite-method才会有值   
before-valueString表示改写前的协议方式(即需要改写的对象),如:http
after-valueString表示改写后的协议方式,如:https
query-string-settingscomplex查询串设置(使用需要申请),用于设置是否对问号后的查询串进行缓存,请使用新接口:【查询串设置】接口 注意:默认是排列靠前的规则优先度更高
ignore-query-stringString忽略查询串进行缓存(使用需要申请)。可选值为true和false,true表示忽略问号后的查询串,只缓存一份,与问号后内容无关;false表示分开缓存。 <server-type>为download时,默认是缓存一份的。
cache-key-rulescomplex缓存key设置,用于设置请求头部或头部参数值的缓存规则 注意:默认是排列靠前的规则优先度更高 缓存key设置(使用需申请),用于设置请求头部或头部参数值的缓存规则 注意: 1、该节点下的相关参数配置,除开通API调用权限外,还需要联系专属客服申请开通对应的API客户模板 2、默认是排列靠前的规则优先度更高
ignore-caseString是否忽略大小写,可选值为true和false,true表示忽略大小写;false表示不忽略大小写,不传该入参,默认为忽略大小写 同缓存key设置中的“ignore-case” 同缓存key设置中的“ignore-case” 是否忽略大小写,可选值为true和false
header-nameString请求头部名称和参数值,可选值为"header-name:parameter" http头名称,新增或修改http头,只支持一个;删除http头支持多个,以分号“;”隔开。 请求头部名称和参数值,可选值为"header-name:parameter"
visit-control-rulescomplex访问控制设置,用于设置加速域名的referer和IP黑白名单防盗链规则,请使用新接口:【查询防盗链配置】接口 注意:默认是排列靠前的规则优先度更高 请需要新的接口:查询防盗链配置
timestamp-visit-control-rulecomplex时间戳防盗链设置(适用网页、点播和下载业务,使用需申请),请使用新接口:【查询时间戳防盗链】接口 注意: 1、该节点下的相关参数配置,除开通API调用权限外,还需要联系专属客服申请开通对应的API客户模板 2、时间戳防盗链分为两部分,一部分是防盗链校验,一部分是时间有效性校验。二者都有效,则防盗链通过,否则不通过。 3、防盗链校验:加密算法为md5sum,按照参与MD5计算的参数及组合顺序进行防盗链加密串的计算,对匹配目录下所有文件的url进行防盗链校验,未匹配到的url,则拒绝访问。 4、时间有效性检验:按照年月日时分秒换算的当前时间,与请求url中所带的名文时间相减,判断是否超过设置的上下限(即前后60s内),时间差小于设置上下限的,系统才会给予正常的响应,否则拒绝请求,返回403 5、日志记录没有带加密串的url 请使用新的接口:查询时间戳防盗链
error-page-rulescomplex错误页面跳转设置,用于控制依据源服务器返回的HTTP错误状态码进行页面跳转,可避免一些用户恶意访问导致频繁回源 注意:默认是排列靠前的规则优先度更高
access-speed-rulescomplex客户端访问限速设置,用于限制客户端的访问速度,达到控制带宽的目的,请使用新接口:【查询访问限速配置】 注意:默认是排列靠前的规则优先度更高。
speedInt稳定速率,开始限制之后的速率,单位KB/秒,大于等于0的整数
videodragscomplex视频拖拉设置(适用点播加速),用于控制对MP4和FLV格式编码的视频音频文件,按字节或者时间拖拉播放。
drag-modeString视频拖拉模式,可选值为time和byte,time表示时间拖拉;byte表示字节拖拉。
start-flagString视频拖拉的起始标志,如:默认为start。
end-flagString视频拖拉的结束标志,如:默认为end。
fd-root-directoryString根目录,与FD源相关(使用需申请) 必须要和域名相关联,并且以“/”开头和结尾,例如:/home/ftpsite/firevale/www.example.com/ 注意:该节点下的相关参数配置,除开通API调用权限外,还需要联系专属客服申请开通对应的API客户模板
cache-hostString缓存文件HOST(使用需申请) 缓存HOST域名和加速域名的”缓存规则”必须一致 注意:该节点下的相关参数配置,除开通API调用权限外,还需要联系专属客服申请开通对应的API客户模板
enable-httpdnsString启用httpdns设置(使用需申请) 可选值为true和false,true表示启用;false表示关闭 注意:该节点下的相关参数配置,除开通API调用权限外,还需要联系专属客服申请开通对应的API客户模板
http-code-cache-rulescomplexhttp状态码缓存设置(使用需申请),依据源服务器返回的http错误状态码指定缓存时间,避免一些用户恶意访问导致频繁回源,请使用新接口:【查询状态码缓存配置】接口 注意: 1、该节点下的相关参数配置,除开通API调用权限外,还需要联系专属客服申请开通对应的API客户模板 2、设置http状态码缓存规则时,是否实现缓存,受客户源站或特定场景下提供的头部影响,例如设置302缓存,并不是所有的302都可以缓存,取决于客户给的头部是否可以缓存,否则即使配置了缓存时间,也是不生效的。 3、未设置http状态码缓存规则时,404状态码系统默认缓存1分钟。 4、默认是排列靠前的规则优先度更高
http-codeStringHTTP状态码,可选值:302 403 404 500 502 503 504
authorize-request-to-origin-rulescomplex回源验证是否允许访问(使用需申请) 注意: 1、该节点下的相关参数配置,除开通API调用权限外,还需要联系专属客服申请开通对应的API客户模板 2、默认是排列靠前的规则优先度更高。
ignore-letter-caseString忽略大小写,可选值为true或false,true表示忽略大小写;false表示不忽略大小写。
authorize-to-origin-rulescomplex回源鉴权设置(适用点播和下载业务,使用需申请) 注意:该节点下的相关参数配置,除开通API调用权限外,还需要联系专属客服申请开通对应的API客户模板
authorize-enabledString启用回源鉴权,可选值为true或false,true表示启用回源鉴权;false表示关闭回源鉴权
authorize-methodString回源鉴权方法,可选值为GET、POST、HEAD三种方法
authorize-addresString回源鉴权地址,可选值为域名或IP、域名:端口或IP:端口,域名或IP与端口之间用冒号分隔 回源鉴权地址为完整的url,例如: http://www.mytest.com/auth(无固定参数) http://www.mytest.com/auth?param1=abc¶m2=123(有固定参数)
authorize-custom-paramscomplex回源鉴权参数,支持以下鉴权参数和key值,参数和key值之间以冒号“:”分隔 PATHWITHOUTQUERY:xx(文件路径,不包含问号内容) CLIENTIP:xx(客户端IP) ID:xx(不带.后缀的文件名) URI_PARA:xx(问号后字符串中如果存在"xx=value"的参数,则为value值) 注意: 1、其中PATHWITHOUTQUERY、CLIENTIP、ID是系统默认提供的参数;URI_PARA是客户可以自定义的参数。 2、除了URI_PARA,其它参数均只会有1个,不能重复。 3、默认是按照传入的顺序进行参数拼接。
authorize-failure-codeString回源鉴权失败状态码,支持多个状态码,多个状态码之间以分号“;”分隔,可选值为2xx|3xx|4xx|5xx的数字
authorize-failure-contentString回源鉴权失败响应结果,支持1个响应结果的值,可选值为数字或字符,不支持特殊字符。
authorize-server-timeoutInt鉴权服务器超时时间,用于控制当鉴权服务器多长时间未响应时,直接关闭鉴权请求。可选值为1-60秒。
authorize-repeat-timeInt鉴权失败重试次数,用于控制失败重试的次数上限,可选值为0-5次
ignore-origin-ipsString回源鉴权是否忽略回源IP或域名,可选值为on或off,on表示忽略,off表示不忽略 如果回源鉴权不想和内容回源使用相同的源服务器,则此项建议配置为on,实际效果为回源鉴权不使用回源IP或域名对应的源服务器,但实际回源时,回源IP或域名仍然有效
ignore-redirect-forwardString回源鉴权是否忽略源异常处理和跳转功能,可选值为on或off,on表示忽略,off表示不忽略 如果想屏蔽如下配置项对回源鉴权功能的影响,则此项建议配置为on 1、当源返回某个状态码(一般是404或503),开启源轮询功能 2、当源返回某个错误状态时,支持重新到特定IP(ip1,ip2,ip3)或者域名取文件 3、开启301和302跳转功能。
ignore-origin-hostString回源鉴权是否忽略回源请求头替换host功能,可选值为on或off,on表示忽略,off表示不忽略 如果回源鉴权不想使用回源请求头替换host功能,则此项建议配置为on,实际效果为回源鉴权不使用回源请求头替换host的功能,但实际回源时,回源请求头替换host功能仍然有效
authorize-header-rulescomplex回源验证头部设置(适用点播和下载业务,使用需申请),与回源鉴权设置搭配使用。 注意: 1、该节点下的相关参数配置,除开通API调用权限外,还需要联系专属客服申请开通对应的API客户模板 2、默认是排列靠前的规则优先度更高。
authorize-header-controlString回源验证http头控制类型,支持回源鉴权头部的增改删,可选值为add|set|delete,单选。 add:新增头部 set:修改头部 delete:删除头部
authorize-header-directionString回源验证http头控制方向,可选值为origin2cache或cache2origin,单选。 origin2cache:接收源应答方向 cache2origin:回源请求方向
authorize-header-nameString回源验证http头名称 新增或修改回源验证http头,只支持一个;删除http头支持多个,以分号“;”隔开。
authorize-header-valueString回源验证http头的值,例如:mytest.example.com 注意: 1、当authorize-header-control为add或set时,该入参有值 2、当authorize-header-control为delete时,该入参无值
ignore-locationString针对location头不缓存(配置风险大,使用需申请) 可选值为true或false,true表示缓存;false表示不缓存。系统对于响应头中带有location(一般是源站做跳转)的请求,默认是不缓存的。 注意: 1、该节点下的相关参数配置,除开通API调用权限外,还需要联系专属客服申请开通对应的API客户模板 2、<ignore-location>和<ignore-cookies>必须同时配置
ignore-cookiesString针对set-cookie头不缓存(配置风险大,使用需申请) 可选值为true或false,true表示缓存;false表示不缓存。系统对于响应头中带有set-cookie(cookies信息容易造成串号现象)的请求,默认是不缓存的。 注意: 1、该节点下的相关参数配置,除开通API调用权限外,还需要联系专属客服申请开通对应的API客户模板 2、<ignore-location>和<ignore-cookies>必须同时配置
header-modify-rulescomplexhttp头设置(使用需申请) 注意: 1、该节点下的相关参数配置,除开通API调用权限外,还需要联系专属客服申请开通对应的API客户模板 2、默认是排列靠前的规则优先度更高。 请需要新接口:查询http头配置接口
compression-settingscomplex设置压缩响应功能(使用需申请),请使用新接口:【查询压缩响应配置】接口
compression-enabledString开启压缩响应功能,可选值为true和false true:开启压缩响应功能false:关闭压缩响应功能
file-typesString指定文件类型开启压缩功能
useRangeBoolean设置range回源功能的开启或关闭(使用需申请),可选值为true、false true:开启range回源 false:关闭range回源
follow301Boolean设置回源跟随301(使用需申请)。当节点回源请求返回301状态码时,CDN节点会直接向跳转地址请求资源而不返回301给用户。可选值为true、false true:开启301跟随 false:关闭301跟随
follow302Boolean设置回源跟随302(使用需申请)。当节点回源请求返回302状态码时,CDN节点会直接向跳转地址请求资源而不返回302给用户。可选值为true、false true:开启302跟随 false:关闭302跟随
header-of-clientipString传递客户端ip的响应头部,可选值为Cdn-Src-Ip和X-Forwarded-For,默认值为Cdn-Src-Ip

错误码

错误代码(code)描述(message)HTTP状态码语义
PARAM_INVALIDparam: {0} is null or invalid.400参数{0}为空或非法
InternalErrorWe encountered an internal error. Please try again.500服务器异常,数据获取失败等内部错误
WRONG_OPERATOROperator [{$operator}] can not deal with domain name [{$domainName}].400提交人不能处理该域名
NoSuchDomainThe specified domain does not exist.404指定的域名不存在

示例

JSON
XML
示例说明
请求示例
复制
#!/bin/bash
username="example_username"
apiKey="example_apiKey"
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url "https://open.chinanetcenter.com/api/domain/a1.example.com" \
-X "GET" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-H "Content-Type:application/json"
返回示例
复制
HTTP/1.1 200 OK
Server: openresty/1.11.2.2
Date: Mon, 10 Jun 2019 06:28:17 GMT
Content-Type: application/json;charset=utf-8
Content-Length: 1220
Connection: keep-alive
x-cnc-deploy-version: 20190610102403
App-Name: service_confApi
x-cnc-request-id: 50168ae2-8093-40b4
{
    "domain-id":"138491",
    "domain-name":"a1.example.com",
    "service-type":"waf",
    "cname":"a1.example.com.wscdns.com",
    "status":"InProgress",
   "created-date:"Mon, 18 Feb 2019 02:54:19 GMT +08:00",
   "last-modified":"Mon, 18 Feb 2019 02:54:19 GMT +08:00",
    "cdn-service-status":"true",
    "enabled":"true",
    "service-areas":"",
    "comment":"",
    "cache-host":"",
    "origin-config":{
        "origin-ips":"1.1.1.1",
        "default-origin-host-header":"",
        "adv-origin-configs":{
            "detect-url":"http://a1.example.com/test.html",
            "detect-period":"600",
            "adv-origin-config":[
                {
                    "master-ips":"2.2.2.2;1.1.1.1",
                    "backup-ips":"www.abc.com"
                }
            ]
        }
    },
    "waf-config":{
        "waf-enable":"false"
    },
    "videodrags":{
        "path-pattern":"*.mp4",
        "drag-mode":"time",
        "start-flag":"start",
        "end-flag":"end"
    },
    "accelerate-type":{
        "accelerate-way":"3"
    },
    "cache-behaviors":[
        {
            "path-pattern":"/",
            "ignore-cache-control":"false",
            "cache-ttl":"12",
            "cache-unit":"h"
        },
        {
            "path-pattern":"/",
            "ignore-cache-control":"false",
            "cache-ttl":"2",
            "cache-unit":"h"
        }
    ],
    "visit-control-rules":[
        {
            "path-pattern":"/icons/",
            "allownullreferer":"",
            "valid-referers":{
                "referer":[
                    ""
                ]
            },
            "invalid-referers":{
                "referer":[
                    ""
                ]
            },
            "forbidden-ips":"",
            "allowed-ips":"",
            "forbidden-uas":"",
            "allowed-uas":""
        }
    ],
    "rewrite-rule-settings":[
        {
            "path-pattern":"/($)",
            "before-value":"http",
            "after-value":"https",
            "rewrite-direction":"cache2visitor",
            "rewrite-method":"301",
            "rewrite-type":"protocol"
        }
    ]
}