新增加速域名

最近更新时间:2019-12-31 17:20:07

我的收藏

接口描述

AddCdnHost 新增加速域名至腾讯云 CDN。
请求域名:cdn.api.qcloud.com
Note:
添加的域名必须尚未被其他用户或自己接入腾讯云 CDN。
添加的域名必须通过工信部备案,可前往工信部官方网站查询。
一次仅可添加一个域名至腾讯云 CDN。
泛域名接入需要进行所有权验证,不支持通过本接口接入。
调用频次限制为100次/分钟。
接口已支持子账号调用,权限配置请参见 权限配置示例

添加的域名必须尚未被其他用户或自己接入腾讯云 CDN。
添加的域名必须通过工信部备案,可前往工信部官方网站查询。
一次仅可添加一个域名至腾讯云 CDN。
泛域名接入需要进行所有权验证,不支持通过本接口接入。
调用频次限制为100次/分钟。
接口已支持子账号调用,权限配置请参见 权限配置示例

入参说明

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 。其中,此接口的 Action 字段为 AddCdnHost。
参数名称
类型
是否必选
描述
host
String
需要接入的 CDN 域名,域名长度限制在50个字符内。
projectId
String
项目 ID,指域名要添加入的项目的对应 ID,查看已有项目及 ID
hostType
String
域名的接入方式<br/>"cname" :使用自有源站。<br/>"cos":设置为 cos 源站。
origin
String
源站设置,支持配置一个域名,或多个源站IP。<br/>端口可配置区间0 - 65535<br/>域名模式:``www.test.com:8080``<br/>IP模式:1.1.1.1:8080;2.2.2.2:8080
backupOrigin
String
备份源站设置,支持配置一个域名,或多个源站 IP。<br/>端口可配置区间0 - 65535<br/>域名模式:``www.test.com:8080``<br/>IP模式:1.1.1.1:8080;2.2.2.2:8080<br/>默认无备站配置。
serviceType
String
加速类型设置<br/>"web":静态内容加速。<br/>"download":下载文件加速。<br/>"media":流媒体点播加速。<br/>默认为静态内容加速。
fullUrl
String
过滤参数设置<br/>"on":关闭过滤参数。<br/>"off":开启过滤参数。<br/>下载/点播/直播类型,默认开启过滤参数。<br/>静态类型默认关闭过滤参数。
fwdHost
String
回源域名配置,默认为加速域名。<br/>注意:COS源站接入时,fwdHost 需要与 origin 保持一致。
cache
String
缓存过期时间设置,默认为全部文件30天,详细说明见下文。
cacheMode
String
缓存模式设置<br/>"simple":表示缓存完全依赖控制台设置。<br/>"custom":表示缓存依赖控制台设置的缓存时间和源站吐出的 max-age 的最小值。<br/>默认为 simple 模式。
refer
String
防盗链设置,详细说明见下文。
accessIp
String
IP 黑白名单配置,详细说明见下文。

详细说明

cache

参数示例
[[0,"all",1000],[1,".jpg;.js",2000],[2,"/a;/www/b",3000],[3,"/a/1.html;/b/2.html",1000]]
每一组缓存过期配置有三个参数:
第一个参数是缓存类型,有以下四种:
0:全部类型,表示匹配所有文件,默认缓存配置。
1:文件类型,表示按文件后缀匹配。
2:文件夹类型,表示按目录匹配。
3:全路径匹配。
第二个参数指定匹配规则,对应第一个参数的缓存类型:
0:固定填充 “all”,表示所有文件。
1:后缀,.jps;.js 等,; 分隔。
2:目录,如 /www/anc;/a/b 等,;分隔。
3:全路径,如 /a/1.html;/b/2.html 等,;分隔。
第三个参数代表缓存过期时间,单位为秒。
填入规则的优先级,从前往后,从低到高。

refer

参数示例
[1,["qq.baidu.com", "*.baidu.com"],1]
第一个字段标识 refer 类型:
0: 不设置防盗链。
1:设置黑名单。
2:设置白名单。
第二个字段为具体的名单列表,第三个字段为是否包含空refer:
1:包含空refer。
0:不包含空refer。

accessIp

参数示例
{"type":1,"list":["1.2.3.4","2.3.4.5"]}
第一个参数 type 为黑白名单类型:
1:黑名单。
2:白名单。
第二个参数 list 表示对应的黑名单IP列表,支持/8、/16、/24格式的网段设置。
最多可设置100条 IP 黑名单,或者50条 IP 白名单。

出参说明

参数名称
类型
描述
code
Int
公共错误码,0表示成功,其他值表示失败。<br/>详情请参见错误码页面 公共错误码
message
String
模块错误信息描述,与接口相关。
codeDesc
String
英文错误信息,或业务侧错误码。<br/>详情请参见错误码页面 业务错误码

调用案例

示例参数

host:www.test.com
projectId:0
hostType:cname
origin:8.8.8.8:8080

GET 请求

GET 请求需要将所有参数都加在 URL 后:
https://cdn.api.qcloud.com/v2/index.php?
Action=AddCdnHost
&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXX
&Timestamp=1462440051
&Nonce=123456789
&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXX
&host=www.test.com
&projectId=0
&hostType=cname
&origin=8.8.8.8:8080

POST 请求

POST 请求时,参数填充在 HTTP Request-body 中,请求地址:
https://cdn.api.qcloud.com/v2/index.php
参数支持 form-data、x-www-form-urlencoded 等格式,参数数组如下:
array (
'Action' => 'AddCdnHost',
'SecretId' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX',
'Timestamp' => 1462868615,
'Nonce' => 520585444,
'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
'host' => 'www.test.com',
'projectId' => '0',
'hostType' => 'cname',
'origin' => '8.8.8.8:8080'
)

结果示例

{
"code": 0,
"message": "",
"codeDesc": "Success"
}
{
"code": 4000,
"message": "(20004)未备案 cdn audit no icp[cdn audit no icp[当前域名未在工信部备案]]",
"codeDesc": 20004
}