接口描述:调用本接口增量修改加速域名配置信息
请求方式:post
请求路径:/domain/update-domain
使用说明:
- 修改域名之前,您需要先开通对应产品类型的服务,且保证资源包/按需服务有效;
- 该域名没有在途工单;
- 单个用户一分钟限制调用10次。
请求参数说明:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
domain | string | 是 | 域名 | |
product_code | string | 是 | 产品类型 | “001”(静态加速),“003”:(下载加速), “004”(视频点播加速),“008”(CDN加速),“006”(全站加速),“007”(安全加速) |
ipv6_enable | int | 否 | ipv6启用 | 未传代表不修改,1(启用); 2(关闭) |
origin | list<origin_single> | 否 | 回源信息 | 传空数组[]代表删除,未传代表不修改,有传代表整个数组全量修改,字段origin_single详细说明见下方 |
req_host | string | 否 | 回源host设置 | 传空字符串""代表删除,未传代表不修改 |
origin_host_type | int | 否 | 主备源携带不同的回源host是否开启 | 未传代表不修改,0(关闭) ;1(开启)。主备源携带不同的回源host开启(origin_host_type等于1):同时配置origin带不同的回源host和回源host,且都有传具体值,则以origin带不同的回源host生效(清空回源host)。 |
origin_host_http | dict | 否 | http类型origin带不同的回源host | 传空对象{}代表删除,未传代表不修改,有传代表整个dict全量修改 |
black_referer | dict | 否 | referer黑名单 | 传空对象{}代表删除,未传代表不修改,有传代表整个dict全量修改,字段black_referer详细说明见下方 |
black_referer_condition | dict | 否 | referer黑名单condition | 传空对象{}代表删除,未传代表不修改,有传代表整个dict全量修改,删除black_referer数据的话condition也要删除,格式:{“black_referer”:[{“mode”:类型, “content”:“配置内容,多个以逗号间隔”}]},mode取值:默认0, 0:文件后缀 1:目录 2: 首页 3: 全部文件 4: 全路径。本参数仅适用于类型为新框架的域名,旧框架域名修改不生效,当前只支持配置单条全量修改,字段black_referer详细说明见下方,黑白名单只允许存在一个,若同时存在只处理黑名单 |
white_referer | dict | 否 | referer白名单 | 传空对象{}代表删除,未传代表不修改,有传代表整个dict全量修改,字段white_referer详细说明见下方 |
white_referer_condition | dict | 否 | referer白名单condition | 传空对象{}代表删除,未传代表不修改,有传代表整个dict全量修改,删除white_referer数据的话condition也要删除,格式:{“white_referer”:[{“mode”:类型, “content”:“配置内容,多个以逗号间隔”}]},mode取值:默认0, 0:文件后缀 1:目录 2: 首页 3: 全部文件 4: 全路径。本参数仅适用于类型为新框架的域名,旧框架域名修改不生效,当前只支持配置单条 |
user_agent | dict | 否 | user_agent黑白名单配置 | 传空对象{}代表删除,未传代表不修改,有传代表整个dict全量修改,字段user_agent详细说明见下方 |
filetype_ttl | list<filetype_ttl_single> | 否 | 缓存类型设置 | 传空数组[]代表删除,未传代表不修改,有传代表整个数组全量修改,字段filetype_ttl_single详细说明见下方 |
ip_black_list | string | 否 | ip黑名单 | 传空字符串""代表删除,未传代表不修改,黑白名单只允许存在一个,若同时存在只处理黑名单,支持ip段与ip,多个ip/ip段以逗号分割,示例:1.1.1.1,2.2.2.2,::1,3.3.3.3-4.4.4.4 |
ip_white_list | string | 否 | ip白名单 | 传空字符串""代表删除,未传代表不修改,黑白名单只允许存在一个,若同时存在只处理白名单,支持ip段与ip,多个ip/ip段以逗号分割,示例:1.1.1.1,2.2.2.2,::1,3.3.3.3-4.4.4.4 |
req_headers | list<req_headers_single> | 否 | 自定义回源请求头 | 传空数组[]代表删除,未传代表不修改,有传代表整个数组全量修改,字段req_headers_single详细说明见下方 |
resp_headers | list<resp_headers_single> | 否 | 自定义响应请求头 | 传空数组[]代表删除,未传代表不修改,有传代表整个数组全量修改,字段resp_headers_single详细说明见下方 |
error_code | list<error_code_single> | 否 | 错误状态码缓存 | 传空数组[]代表删除,未传代表不修改,有传代表整个数组全量修改,字段error_code_single详细说明见下方 |
shared_host | string | 否 | 共享缓存域名 | 传空字符串""代表删除,未传代表不修改 |
https_status | string | 否 | https是否开启 | 未传代表不修改,取值:on、off,取值为on时,cert_name为必传字段 |
cert_name | string | 否 | 证书备注名 | 未传代表不修改 |
https_basic | dict | 否 | https基础信息 | 传空对象{}代表删除,未传代表不修改,有传代表整个dict全量修改,字段https_basic详细说明见下方 |
basic_conf | dict | 否 | http配置基础信息 | 传空对象{}代表删除,未传代表不修改,有传代表整个dict全量修改,字段basic_conf详细说明见下方 |
limit_speed_uri | list<limit_speed_uri_single> | 否 | 基于url参数限速 | 传空数组[]代表删除,未传代表不修改,有传代表整个数组全量修改,字段limit_speed_uri_single详细说明见下方 |
limit_speed_uri_condition | dict | 否 | limit_speed_uri的condition配置 | 传空对象{}代表删除,未传代表不修改,有传代表整个dict全量修改,格式:{“{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_single> | 否 | 基于固定值限速 | 传空数组[]代表删除,未传代表不修改,有传代表整个数组全量修改,字段limit_speed_const_single详细说明见下方 |
limit_speed_const_condition | dict | 否 | limit_speed_const的condition配置 | 传空对象{}代表删除,未传代表不修改,有传代表整个dict全量修改,格式:{“{key}”:[{“mode”:类型,“content”:“配置内容,多个以逗号间隔”}]},mode类型为int,取值默认0,可以为:0(文件后缀),1(目录),2(首页),3(全部文件),4(全路径),key为limit_speed_const中的id。使用限制:一个key对应的数组大小只能是1,因为配置平台实际只支持配置一条;content必填,长度大于0,不能为空字符串或者空白字符串 |
ssl | string | 否 | ssl协议类型 | 传空字符串"“代表删除,未传代表不修改,支持TLSv1 、TLSv1.1 、TLSv1.2 、TLSv1.3,默认值为”",支持多选,多个用英文逗号分隔 |
ssl_stapling | string | 否 | ocsp stapling开关 | 未传代表不修改,on(开启),off(关闭) |
cus_gzip | list<cus_gzip_single> | 否 | 文件压缩 | 传空数组[]代表删除,未传代表不修改,有传代表整个数组全量修改,字段cus_gzip_single详细说明见下方,原来文件压缩的字段为gzip字段,现改成cus_gzip,两参数不能同时传,若之前用的是gzip字段建议迁移至cus_gzip |
cus_gzip_condition | dict | 否 | 文件压缩condition配置 | 传空对象{}代表删除,未传代表不修改,有传代表整个dict全量修改,格式:{“key”:[{“mode”:类型, “content”:“配置内容,多个以逗号间隔”}]}, mode取值:默认0, 0:文件后缀 1:目录 2: 首页 3: 全部文件 4: 全路径。key为cus_gzip中的id,本参数仅适用于类型为新框架的域名,旧框架域名修改不生效,且修改本参数时,cus_gzip必传 |
entry_limits | list<entry_limits_single> | 否 | 限频自助参数 | 传空数组[]代表删除,未传代表不修改,有传代表整个数组全量修改,字段entry_limits_single详细说明见下方,本参数仅适用于类型为新框架的域名,旧框架域名修改不生效。特别注意,若传空数组[]删除entry_limits参数时,若entry_limits_condition有值,也需要entry_limits_condition传空对象{}删除。 |
entry_limits_condition | dict | 否 | 限频自助参数condition配置 | 传空对象{}代表删除,未传代表不修改,有传代表整个dict全量修改,格式:{“key”:[{“mode”:类型, “content”:“配置内容,多个以逗号间隔”}]}, mode取值:默认0, 0:文件后缀 1:目录 2: 首页 3: 全部文件 4: 全路径。key为entry_limits中的id,本参数仅适用于类型为新框架的域名,旧框架域名修改不生效 |
cachekey_args | list<cachekey_args_single> | 否 | 缓存参数 | 传空数组[]代表删除,未传代表不修改,有传代表整个数组全量修改,字段cachekey_args_single详细说明见下方 |
cachekey_args_condition | dict | 否 | 缓存参数condition配置 | 传空对象{}代表删除,未传代表不修改,有传代表整个dict全量修改,格式:{“key”:[{“mode”:类型, “content”:“配置内容,多个以逗号间隔”}]}, mode取值:默认0, 0:文件后缀 1:目录 2: 首页 3: 全部文件 4: 全路径。key为cachekey_args中的id,本参数仅适用于类型为新框架的域名,旧框架域名修改不生效 |
详细参数说明 :
1)参数origin_single:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
origin | string | 是 | 源站ip或域名 | |
port | int | 否 | 回源地址端口 | 默认80;支持http自定义端口,http不支持下发443端口。多个源站时,源站端口需保持一致;该字段功能由【basic_conf.http_origin_port】字段替代,若两个字段均传值需保持一致,且修改以http_origin_port字段为准。 |
weight | int | 是 | 权重 | 权重,范围1-100, role和weight都不存在或取值一致时,按轮询策略,默认10 |
role | string | 是 | 源站角色 | 取值:master/slave 默认master |
protocol | string | 否 | 源站类型 | 默认http,目前不支持自定义配置https源站。 |
2)参数black_referer:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
allow_empty | string | 否 | referer是否允许为空 | 取值"on", “off”,默认“off” |
allow_list | list< string > | 否 | referer黑名单列表 | 默认[] |
is_append | int | 否 | 是否追加referer黑名单列表 | 是否在原来的黑名单列表基础上追加黑名单,取值 1:追加, 0:覆盖,不传默认0覆盖。当传入的值为1的时候,将当前传入的allow_list追加到已有配置的黑名单列表。当传入值0或者不传值的时候,当前传入的allow_list覆盖已有配置的黑名单列表 |
referer_empty_protocol | string | 否 | referer允许空协议 | 枚举值:on、off,默认off |
3)参数white_referer:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
allow_empty | string | 否 | referer是否允许为空 | 取值"on", “off” |
allow_list | list< string > | 否 | referer白名单列表 | |
is_append | int | 否 | 是否追加referer白名单列表 | 是否在原来的白名单列表基础上追加白名单,取值 1:追加, 0:覆盖,不传默认0覆盖。当传入的值为1的时候,将当前传入的allow_list追加到已有配置的白名单列表。当传入值0或者不传值的时候,当前传入的allow_list覆盖已有配置的白名单列表 |
referer_empty_protocol | string | 否 | referer允许空协议 | 枚举值:on、off,默认off |
4)参数user_agent:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
type | int | 是 | 类型 | 枚举值:0(黑名单),1(白名单) |
ua | list | 是 | user_agent列表,多个用英文逗号隔开 |
5)参数filetype_ttl_single:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
cache_type | int | 是 | 缓存类型 | 1(不缓存);2(遵循源站); 3(强制缓存);4(custom缓存)。 |
cache_with_args | int | 是 | 是否带参数缓存 | 0(不带参数缓存);1(带参数缓存); 默认0。 |
mode | int | 否 | 模式 | 0(文件后缀);1(目录); 2(首页);3(全部文件);4:(全路径);5( 正则),默认0 |
file_type | string | 是 | 缓存文件类型,多个以逗号隔开 | 当模式mode为文件后缀时,缓存文件类型例如:jpg,png,css(以",“分割);当模式mode为目录时,缓存文件类型例如/test,/a/b/c(不能以”/"结尾);当模式mode为首页时,缓存文件类型固定为/ ;当模式mode为全部文件时,缓存文件类型固定为/ ;当模式mode为全路径时,缓存文件类型例如/index.html,/test/*.jpg |
priority | int | 否 | 优先级 | 范围:1-100,默认10。 |
ttl | int | 是 | 缓存时间,单位秒 |
6)参数req_headers_single:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
key | string | 是 | 自定义回源请求头名称 | |
value | string | 否 | 自定义回源请求头值 | 默认"" |
7)参数resp_headers_single:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
key | string | 是 | 自定义响应请求头名称 | |
value | string | 否 | 自定义响应请求头值 | 默认"" |
8)参数error_code_single:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
code | list< int > | 是 | 错误状态码 | |
ttl | int | 是 | 缓存时间 | 单位秒 |
9)参数https_basic:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
force_status | string | 否 | 强制跳转状态码 | 默认:302 |
http_force | string | 否 | http强制跳转 | 取值:“on”:跳转 “off”:不跳转 |
https_force | string | 否 | https强制跳转 | 取值:“on”:跳转 “off”:不跳转 |
origin_protocol | string | 是 | https回源协议 | 取值: http:回http协议回源 https:用https协议回源, follow_request:跟随访问协议进行回源 |
10)参数basic_conf:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
follow_302 | int | 否 | 是否拉取跳转后文件 | 0(否);1(是) |
use_http2 | int | 否 | 是否开启http2 | 取值:0(不开启);1(开启);默认0 |
http_origin_port | int | 否 | http请求回源端口 | 未传不修改;不支持443端口 |
https_origin_port | int | 否 | https请求回源端口 | 未传不修改;取值范围:1-65535 |
11)参数limit_speed_uri_single:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
id | string | 是 | limit_speed_uri列表内唯一 | 可以考虑使用时间戳拼上列表索引,比如时间戳为11657615509083,拼上序列化0,则id为:116576155090830 |
unit | string | 是 | 单位 | 可选值b/s,Kb/s,Mb/s |
args | string | 是 | uri参数名 | |
time_seg | string | 否 | 时段 | 正则表达式,比如:(08:[2-5][0-9] |
weight | int | 否 | 优先级 | 默认值10,取值范围[1,) |
12)参数limit_speed_const_single:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
id | string | 是 | 基于固定值限速唯一标识,limit_speed_const列表内唯一 | 可以考虑使用时间戳拼上列表索引,比如时间戳为11657615509083,拼上序列化0,则id为:116576155090830 |
rate | int | 是 | 限速值 | 取值范围[0,) |
time_seg | string | 否 | 时段 | 正则表达式,比如:(08:[2-5][0-9] |
unit | string | 是 | 单位 | 可选值b/s(即Byte/s),Kb/s(即KByte/s),Mb/s(即MByte/s) |
weight | int | 否 | 优先级 | 默认值10,取值范围[1,) |
13)参数cus_gzip_single:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
id | string | 是 | id | 跟cus_gzip_condition客户自助的condition的id是一一对应 |
min_length | string | 是 | 压缩文件大小 | 格式:(1-1023)B,(1-1023) K,(1-102399) M,(1-1023)b,(1-1023) k,(1-102399)m |
file_type | string | 是 | 压缩文件类型 | 多个用英文逗号分隔 |
type | int | 否 | 压缩类型 | 取值:0(gzip),1(brotli),不传值为0 |
http_version | string | 否 | http_version | 取值:1.1 ,1.0,不传值为null |
vary | string | 否 | gzip_vary | 取值:on(开启),off(关闭)不传值为null |
max_length | string | 否 | 最大文件大小 | 格式:(1-1023)B,(1-1023)K,(1-102399)M,(1-1023)b,(1-1023)k,(1-102399)m,不传为null |
14)参数entry_limits_single:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
id | string | 是 | 唯一id | |
limit_element | string | 是 | 限制参数 | |
frequency_threshold | int | 是 | 访问次数限制阈值 | 单位:次数,取值范围:大于等于0 |
frequency_time_range | int | 是 | 统计周期 | 单位:s,取值范围:[0,3600] |
forbidden_duration | int | 是 | 拒绝访问时间 | 取值范围:大于等于0 |
forbidden_duration_unit | string | 否 | 拒绝访问时间单位 | 取值范围:[s,millis],默认s |
forbidden_code | int | 否 | 封禁http访问码 | 取值范围:大于等于0 |
white_ip_control | list< string > | 否 | 不执行校验的客户端ip | 支持ip和ip段,ipv4,ipv6 |
priority | int | 是 | 优先级 | 取值范围:[1,100] |
15)参数cachekey_args_single:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
id | string | 是 | 基于缓存参数唯一标识 | id不可重复 |
priority | int | 否 | 优先级 | 默认值10,取值范围[1,100] |
ignore | int | 否 | 去参数缓存开关 | 取值:0-否,1-是(即忽略所有参数), 默认值1,取值范围[0,1] |
ignore_args | string | 否 | 忽略特定参数缓存 | 去参数缓存开关为1时配置有效;默认值"",若需要忽略多个参数,中间用逗号分割;若ignore=1,ignore_args传指定参数配置值(如:a,b),表示忽略指定参数 |
is_with_args | int | 否 | 带特定参数缓存 | 去参数缓存开关为0时配置有效;取值:0 否,1 是,默认值1,取值范围[0,1];若ignore=0,is_with_args=0,表示缓存所有参数 |
mode | string | 否 | 匹配方式 | 带特定参数缓存为1时配置有效;取值:0 字符串, 1 正则,默认值0,取值范围[0,1] |
args | string | 否 | 参数串 | 匹配方式为0时配置有效,默认值"";若ignore=0,is_with_args=1,mode固定传0,args传指定参数配置值,表示保留指定参数。其中如果参数含有中划线-需转为下划线_,并联系客服配置dash_in_args。 |
subject | string | 否 | subject | 匹配方式为1时配置,默认值"" |
pattern | string | 否 | pattern | 匹配方式为1时配置,默认值"" |
replace | string | 否 | replace | 匹配方式为1时配置,默认值"" |
返回参数说明:
参数 | 类型 | 是否必传 | 名称及描述 |
---|---|---|---|
code | int | 是 | 状态码,成功100000 |
message | string | 是 | 描述信息,成功返回success,其他返回异常信息描述 |
示例:
请求路径:https://cdnapi-global.ctapi.ctyun.cn/domain/update-domain
请求参数:
{
"domain":"sd55sd12.baidu.ctyun.cn",
"product_code":"006",
"ipv6_enable":2,
"origin":[
{
"role":"master",
"port":80,
"origin":"1.1.1.1",
"weight":10
}
],
"req_host":"www.test.ctyun.cn",
"black_referer":{
"allow_list":[
"www.test1.ctyun.cn"
],
"allow_empty":"on",
"referer_empty_protocol":"on"
},
"user_agent":{
"type":0,
"ua":[
"linux",
"windows"
]
},
"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",
"cert_name":"cert_009",
"https_basic":{
"https_force":"on",
"origin_protocol":"https"
},
"basic_conf":{
"follow_302":1,
"use_http2":1,
"http_origin_port":80,
"https_origin_port":8080
},
"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"
}
]
},
"ssl":"TLSv1",
"ssl_stapling":"on",
"entry_limits":[
{
"id":"123abc",
"limit_element":"entry_limits",
"frequency_threshold":0,
"frequency_time_range":3600,
"forbidden_duration":1000,
"forbidden_duration_unit":"s",
"forbidden_code":0,
"white_ip_control":[
"1.1.1.11",
"58.14.0.0/15",
"240e:94a:4001::3007"
],
"priority":100
},
{
"id":"456abc",
"limit_element":"entry_limits",
"frequency_threshold":1000,
"frequency_time_range":3000,
"forbidden_duration":1000,
"forbidden_duration_unit":"millis",
"forbidden_code":123,
"white_ip_control":[
"192.168.1.1",
"58.14.0.0/15",
"240e:94a:4001::3007"
],
"priority":1
}
],
"entry_limits_condition":{
"123abc":[
{
"mode":1,
"content":"/test1,/test2"
}
],
"456abc":[
{
"mode":4,
"content":"/test3$,/test4"
}
]
},
"cus_gzip":[
{
"id":"123abc",
"min_length":"1k",
"file_type":"tar",
"type":1,
"http_version":"1.1",
"vary":"on",
"max_length":"1m"
},
{
"id":"123abcd",
"min_length":"1M",
"file_type":"zip",
"type":0,
"http_version":"1.0",
"vary":"off",
"max_length":"1000M"
}
],
"cus_gzip_condition":{
"123abc":[
{
"mode":1,
"content":"/test1,/test2"
}
],
"123abcd":[
{
"mode":4,
"content":"/test3,/test4"
}
]
},
"cachekey_args":[
{
"id":"cachekey_args1234561231",
"ignore":0,
"is_with_args":1,
"mode":1,
"args":" ",
"priority":10,
"ignore_args":"xxx",
"subject":"xxx",
"pattern":"xxx",
"replace":"xxx"
},
{
"id":"cachekey_args123456abd@12"
}
],
"cachekey_args_condition":{
"cachekey_args123456abd@12":[
{
"mode":2,
"content":"/"
}
]
}
}
返回结果:
{
"code": 100000,
"message": "success"
}
错误码请参考:参数code和message含义