接口描述:调用本接口增量修改加速域名配置信息
请求方式:post
请求路径:/domain/update-domain
使用说明:
- 修改域名之前,您需要先开通对应产品类型的服务,且保证资源包/按需服务有效;
- 该域名没有在途工单;
- 单个用户一分钟限制调用10000次,并发不超过100
请求参数说明(json):
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
domain | string | 是 | 域名 | |
product_code | string | 是 | 产品类型 | “007”(安全加速) |
ipv6_enable | int | 否 | ipv6启用 | 1(启用); 2(关闭),未传代表不修改 |
origin | list | 否 | 源站信息 | 未传代表不修改,有传代表整个数组全量修改 |
origin[*].origin | string | 是 | 源站ip或域名 | |
origin[*].port | int | 是 | 源站端口 | 支持http自定义端口,http不支持下发443端口 |
origin[*].weight | int | 是 | 权重 | 范围:1-100 |
origin[*].role | string | 是 | 源站角色 | 取值: master, slave |
origin[*].protocol | string | 否 | 源站类型 | 默认http,目前不支持自定义配置https源站。 |
req_host | string | 否 | 回源host | 未传代表不修改 |
origin_host_type | int | 否 | 主备源携带不同的回源host是否开启 | 0:关闭 1:开启,未传代表不修改 |
origin_host_http | dict | 否 | http类型origin带不同的回源host | origin:origin每条的http类型origin当key,不同的回源host当value存储,例如{ “www.ctyun.1cn”:“www.ctyun.2cn”, },其中key必须是存在的源站origin:origin,未传代表不修改 |
black_referer | dict | 否 | referer黑名单 | 未传代表不修改,有传代表整个dict全量修改 |
black_referer.allow_list | list | 是 | referer黑名单列表 | |
black_referer.allow_empty | string | 是 | 是否允许为空 | “on”(允许为空);“off”(不允许为空) |
white_referer | dict | 否 | referer白名单 | 未传代表不修改,有传代表整个dict全量修改 |
white_referer.allow_list | list | 是 | referer白名单列表 | |
white_referer.allow_empty | string | 是 | 是否允许为空 | “on”(允许为空);“off”(不允许为空) |
filetype_ttl | list | 否 | 文件过期时间设置 | 未传代表不修改,有传代表整个数组全量修改 |
filetype_ttl[*].file_type | string | 是 | 缓存文件类型,多个以逗号隔开 | 0:文件后缀,例如jpg,png,css(以",“分割) 1:目录,例如/test,/a/b/c(不能以”/"结尾) 2: 首页,固定为/ 3: 全部文件,固定为/ 4: 全路径,例如/index.html,/test/*.jpg |
filetype_ttl[*].ttl | int | 是 | 缓存时间 | 单位秒 |
filetype_ttl[*].cache_type | int | 是 | 缓存类型 | 1(不缓存);2(优先遵循源站);3(强制缓存) |
filetype_ttl[*].cache_with_args | int | 是 | 是否带参数缓存 | 0(不带参数缓存);1(带参数缓存) |
filetype_ttl[*].mode | int | 否 | 模式 | 0(文件后缀);1(目录);2(首页); 3(全部文件);4(全路径);5(正则),不传默认0 |
filetype_ttl[*].priority | int | 否 | 优先级 | 不传默认10 |
ip_black_list | string | 否 | ip黑名单 | 黑白名单只允许存在一个,若同时存在只处理黑名单,多个ip以逗号分隔,示例:1.1.1.1,2.2.2.2,::1,未传代表不修改 |
ip_white_list | string | 否 | ip白名单 | 黑白名单只允许存在一个,若同时存在只处理黑名单,多个ip以逗号分隔,示例:1.1.1.1,2.2.2.2,::1,未传代表不修改 |
req_headers | list | 否 | 自定义回源请求头 | 未传代表不修改,有传代表整个数组全量修改 |
req_headers[*].key | string | 是 | 自定义回源请求头名称 | |
req_headers[*].value | string | 否 | 自定义回源请求头值 | value为""代表删除对应的请求头 |
resp_headers | list | 否 | 自定义响应头 | 未传代表不修改,有传代表整个数组全量修改 |
resp_headers[*].key | string | 是 | 自定义响应头名称 | |
resp_headers[*].value | string | 否 | 自定义请求头值 | value为""代表删除对应的响应头 |
error_code | list | 否 | 错误码缓存配置 | 未传代表不修改,有传代表整个数组全量修改 |
error_code[*].code | list | 是 | 错误状态码 | 多个用逗号间隔 |
error_code[*].ttl | int | 是 | 缓存时间 | 单位秒 |
shared_host | string | 否 | 共享缓存域名 | 未传代表不修改 |
https_status | string | 否 | 是否开启https | 取值:on、off,取值为on时,cert_name为必传字段,未传代表不修改 |
cert_name | string | 否 | 证书备注名 | 证书备注名,如果证书存在,此备注名必须存在,未传代表不修改 |
https_basic | dict | 否 | https基础配置 | 未传代表不修改,有传代表整个dict全量修改 |
https_basic.https_force | string | 否 | https强制跳转 | “on”(跳转);“off”(不跳转) |
https_basic.http_force | string | 否 | http强制跳转 | “on”(跳转);“off”(不跳转) |
https_basic.force_status | string | 否 | 强制跳转状态码 | 不传默认302 |
https_basic.origin_protocol | string | 是 | https回源协议 | 取值: http:用http协议回源 https:用https协议回源,follow_request:跟随访问协议进行回源 |
basic_conf | dict | 否 | http配置基础信息 | 未传代表不修改,有传代表整个dict全量修改 |
basic_conf.use_http2 | int | 否 | 是否开启http2 | 取值0:不开启,1:开启 默认0 |
basic_conf.follow302 | int | 否 | 是否拉取跳转后文件 | 0: 否 1:是 |
limit_speed_uri | list | 否 | 基于url参数限速 | 未传代表不修改,有传代表整个数组全量修改 |
limit_speed_uri[*].id | string | 是 | limit_speed_uri列表内唯一 | 可以考虑使用时间戳拼上列表索引,比如时间戳为11657615509083,拼上序列化0,则id为:116576155090830 |
limit_speed_uri[*].args | string | 是 | uri参数名 | |
limit_speed_uri[*].unit | string | 是 | 单位 | 可选值b/s,Kb/s,Mb/s |
limit_speed_uri[*].time_seg | string | 否 | 时段 | 正则表达式,比如:(08:[2-5][0-9] |
limit_speed_uri[*].weight | int | 否 | 优先级 | 默认值10,取值范围[1,) |
limit_speed_uri_condition | dict | 否 | limit_speed_uri的condition配置 | { “{key}”:[ { “mode”:类型, “content”:“配置内容,多个以逗号间隔” } ] } mode类型为int,取值: 默认0, 0:文件后缀 1:目录 2: 首页 3: 全部文件 4: 全路径, key为limit_speed_uri中的id 限制: 一个key对应的数组大小只能是1,因为配置平台实际只支持配置一条 content必填,长度大于0,不能为空字符串或者空白字符串 使用数组除了保持和已有其他功能使用一致性,也方便将来扩展 |
limit_speed_const | list | 否 | 基于固定值限速 | 未传代表不修改,有传代表整个数组全量修改 |
limit_speed_const[*].id | string | 是 | limit_speed_const列表内唯一 | 可以考虑使用时间戳拼上列表索引,比如时间戳为11657615509083,拼上序列化0,则id为:116576155090830 |
limit_speed_const[*].unit | string | 是 | 单位 | 可选值b/s,Kb/s,Mb/s |
limit_speed_const[*].rate | int | 是 | 限速值 | 取值范围[0,) |
limit_speed_const[*].time_seg | string | 否 | 时段 | 正则表达式,比如:(08:[2-5][0-9] |
limit_speed_const[*].weight | int | 否 | 优先级 | 默认值10,取值范围[1,) |
limit_speed_const_condition | dict | 否 | limit_speed_const的condition配置 | { “{key}”:[ { “mode”:类型, “content”:“配置内容,多个以逗号间隔” } ] } mode类型为int,取值: 默认0, 0:文件后缀 1:目录 2: 首页 3: 全部文件 4: 全路径, key为limit_speed_const中的id 限制: 一个key对应的数组大小只能是1,因为配置平台实际只支持配置一条 content必填,长度大于0,不能为空字符串或者空白字符串 使用数组除了保持和已有其他功能使用一致性,也方便将来扩展 |
返回参数说明:
参数 | 类型 | 是否必传 | 名称及描述 |
---|---|---|---|
code | int | 是 | 状态码,成功100000 |
message | string | 是 | 描述信息,成功返回success,其他返回异常信息描述 |
示例:
请求路径:https://cdnapi-global.ctapi.ctyun.cn/domain/update-domain
示例1:
请求参数:
{
"domain": "www.ctyun.cn",
"product_code": "007",
"ipv6_enable": 2,
"origin": [
{
"role": "master",
"port": 80,
"origin": "1.1.1.1",
"weight": 10
}
],
"req_host": "www.ctyun.cn",
"black_referer": {
"allow_list": [
"www.ctyun.cn1"
],
"allow_empty": "on"
},
"white_referer": {
"allow_list": [
"www.ctyun.cn"
],
"allow_empty": "on"
},
"filetype_ttl": [
{
"ttl": 300,
"file_type": "ts,mp4",
"cache_type": 2,
"mode": 0,
"cache_with_args": 0
}
],
"ip_black_list": "1.1.1.1,2.2.2.2,3.3.3.3",
"resp_headers": [
{
"value": "reqheadertest",
"key": "Test"
}
],
"https_status": "off",
"https_basic": {
"https_force": "on",
"origin_protocol": "https"
},
"basic_conf": {
"https_return": "off"
},
"limit_speed_uri": [
{
"id": "116576155090830",
"unit": "Kb/s",
"args": "good",
"weight": 2
}
],
"limit_speed_uri_condition": {
"116576155090830": [
{
"mode": 1,
"content": "/sss"
}
]
},
"limit_speed_const": [
{
"id": "116576155090830",
"unit": "Mb/s",
"rate": 1,
"weight": 2
}
],
"limit_speed_const_condition": {
"116576155090830": [
{
"mode": 1,
"content": "/sss"
}
]
}
}
返回结果:
{
"code": 100000,
"message": "success"
}
错误码请参考:API返回参数code和message含义