接口描述:调用本接口批量修改加速域名配置信息
请求方式:post
请求路径:/domain/batch-update-domain-configuration-information
使用说明:
- 修改域名之前,您需要先开通对应产品类型的服务,且保证资源包/按需服务有效;
- 该域名没有在途工单;
- 单个用户一分钟限制调用10000次,并发不超过100
请求参数说明:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
domain | list | 是 | 域名 | 单次调用域名个数最多不超过10个,相同域名去重 |
product_code | string | 是 | 产品类型 | “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详细说明见下方 |
white_referer | dict | 否 | referer白名单 | 传空对象{}代表删除,未传代表不修改,有传代表整个dict全量修改,字段white_referer详细说明见下方 |
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,不能为空字符串或者空白字符串 |
remote_sync_auth | list<remote_sync_auth_single> | 否 | 远程同步鉴权客户自助 | 传空数组[]代表删除,未传代表不修改,有传代表整个数组全量修改,字段remote_sync_auth_single详细说明见下方 |
remote_sync_auth_condition | dict | 否 | 远程同步鉴权condition | 传空对象{}代表删除,未传代表不修改,有传代表整个dict全量修改,格式:{“key”:[{“mode”:类型, “content”:“配置内容,多个以逗号间隔”}]}, mode类型为int,取值默认0,可以为:0(文件后缀),1(目录),2(首页),3(全部文件),4(全路径),key为remote_sync_auth中的id |
详细参数说明 :
1)参数origin_single:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
origin | string | 是 | 源站ip或域名 | |
port | int | 否 | 回源地址端口 | 默认80;支持http自定义端口,http不支持下发443端口 |
weight | string | 否 | 权重 | 权重,范围1-100, role和weight都不存在或取值一致时,按轮询策略,默认10, |
role | string | 否 | 源站角色 | 取值:master/slave 默认master |
protocol | string | 否 | 源站类型 | 默认http,目前不支持自定义配置https源站。 |
2)参数black_referer:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
allow_empty | string | 是 | referer是否允许为空 | 取值"on", “off” |
allow_list | list | 是 | referer黑名单列表 |
3)参数white_referer:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
allow_empty | string | 是 | referer是否允许为空 | 取值"on", “off” |
allow_list | list | 是 | referer白名单列表 |
4)参数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 | 是 | 缓存时间,单位秒 |
5)参数req_headers_single:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
key | string | 是 | 自定义回源请求头名称 | |
value | string | 否 | 自定义回源请求头值 | 默认"" |
6)参数resp_headers_single:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
key | string | 是 | 自定义响应请求头名称 | |
value | string | 否 | 自定义响应请求头值 | 默认"" |
7)参数error_code_single:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
code | list | 是 | 错误状态码 | 多个用逗号间隔 |
ttl | int | 是 | 缓存时间 | 单位秒 |
8)参数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:跟随访问协议进行回源 |
9)参数basic_conf:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
follow_302 | int | 否 | 是否拉取跳转后文件 | 0(否);1(是) |
use_http2 | int | 否 | 是否开启http2 | 取值:0(不开启);1(开启);默认0 |
10)参数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,) |
11)参数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,) |
12)参数remote_sync_auth_single:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
auth_body_data | string | 否 | 请求体 | 默认为空"",请求方法为POST才生效 |
auth_connection_idle_time | int | 否 | 连接空闲超时时间 | 连接空闲超时时间 |
auth_connection_pool_size | int | 否 | 鉴权服务端连接池大小 | 鉴权服务端连接池大小 |
auth_error_pass | string | 否 | 鉴权出错是否通过 | 取值:on:是,off:否 |
auth_host | list | 是 | 鉴权源站 | ip或者域名 |
auth_method | string | 否 | 请求方法 | 取值为:GET/POST/HEAD/OPTIONS,如选择POST,显示“请求体”输入框 |
auth_port | int | 否 | 请求端口 | 请求端口,http默认80,https默认443 |
auth_respond_action | string | 否 | 鉴权状态码黑白名单 | 鉴权状态码黑白名单,(白名单 “allow” 或 黑名单 “deny”),默认deny |
auth_respond_status | list | 否 | 状态码 | 可以为空,状态码 |
auth_scheme | string | 否 | 请求协议 | 默认http,值为http/https |
auth_timeout | float | 否 | 鉴权超时时间 | 鉴权设置,鉴权超时时间,单位秒,支持输入毫秒,最大值3600秒,小数位数最大3位 |
auth_timeout_pass | string | 否 | 鉴权超时是否通过 | 鉴权逻辑,鉴权超时是否通过,取值:on:是,off:否 |
forbidden_code | int | 否 | 固定状态码 | 当上面鉴权不通过时状态码设置为固定状态码的时候必填 |
forbidden_code_state | string | 否 | 鉴权不通过时状态码设置 | 鉴权不通过时状态码设置,(跟随鉴权源站follow/固定状态码regular),默认"follow" |
id | string | 是 | 远程同步鉴权客户自助 | 主键id,condition使用 |
pattern | string | 否 | pattern | 鉴权请求uri,默认空 |
priority | int | 否 | 优先级 | 默认10 |
replace | string | 否 | replace | 鉴权请求uri,默认空 |
response_json_to_var | dict | 否 | 基于json鉴权 | 基于json鉴权 |
response_json_to_var.forbidden_code | int | 否 | 鉴权不通过状态码 | 有运维condition,id为RemoteSyncAuth的id+_json_forbidden_code,如xxxxxx_json_forbidden_code,此参数只有有配置condition的时候才生效 |
response_json_to_var.json_var_list | list | 否 | json数据 | 成对出现,可添加多对 |
response_json_to_var.json_var_list[*]arg_name | string | 是 | 变量名 | |
response_json_to_var.json_var_list[*]arg_value | string | 是 | 变量值 | |
response_json_to_var.switch | int | 否 | json数据开关 | 0(关),1(开) |
subject | string | 是 | subject | 鉴权请求uri,默认值$uri |
try_next_remote_server_when | string | 否 | 鉴权源站重试状态码 | 底层默认默认^5.+ |
use_main_request_args | list | 否 | 请求参数 | |
use_main_request_args[*].arg_name | string | 是 | 请求参数key | |
use_main_request_args[*].arg_value | string | 否 | 请求参数value | 默认空,空代表删除 |
use_main_request_args_type | string | 否 | 使用原始请求参数类型 | 当上面是否使用原始请求参数选择否的时候,必填,取值:继承并修改原参数inherit/全面替换原参数replace,默认继承 |
use_main_request_headers | list | 否 | 请求头 | |
use_main_request_headers[*].arg_name | string | 是 | 请求头key | |
use_main_request_headers[*].arg_value | string | 否 | 请求头value | 默认空,空代表删除 |
use_main_request_headers_type | string | 否 | 使用原始请求头类型 | 当上面是否使用原始请求头选择否的时候,必填,取值:继承并修改原参数inherit/全面替换原参数replace,默认继承 |
use_original_request_args | string | 否 | 是否使用原始请求参数 | 鉴权请求参数:是否使用原始请求参数,取值:on /off,没值不传,后端默认是 |
use_original_request_headers | string | 否 | 是否使用原始请求头 | 鉴权请求头:是否使用原始请求头,取值:on /off,没值不传,后端默认是 |
返回参数说明:
参数 | 类型 | 是否必传 | 名称及描述 |
---|---|---|---|
code | int | 是 | 状态码,成功100000 |
message | string | 是 | 描述信息,成功返回success,其他返回异常信息描述 |
success_number | int | 否 | 操作成功的个数 |
domain_details | list | 否 | 每个域名操作结果 |
domain_details[*].domain | string | 否 | 单个域名 |
domain_details[*].code | string | 否 | 单个域名操作的状态码,成功100000 |
domain_details[*].message | string | 否 | 单个域名操作的描述信息,成功返回success,其他返回异常信息描述 |
示例:
请求路径:https://cdnapi-global.ctapi.ctyun.cn/domain/batch-update-domain-configuration-information
示例1:
请求参数:
7{
"domain": [
"ctyun.cn",
"ctyun.cn1",
"ctyun.cn2",
"ctyun.cn3"
]
"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",
"success_number": 4,
"domain_details": [
{
"code": 100000,
"message": "success",
"domain": "www.ctyun.cn"
},
{
"code": 100000,
"message": "success",
"domain": "www.ctyun.cn1"
},
{
"code": 100000,
"message": "success",
"domain": "www.ctyun.cn2"
},
{
"code": 100000,
"message": "success",
"domain": "www.ctyun.cn3"
}
]
}
错误码请参考:API返回参数code和message含义