设置访问ua控制
更新时间:2026-07-16
接口
设置域名的访问ua控制接口。
| Method | Path | 说明 |
|---|---|---|
| PUT | /v2/domain/{domain}/config?uaAcl | 设置访问ua配置 |
domain:修改配置的CDN加速域名。
请求体(Request Body)
| 参数 | 可选 | 类型 | 说明 |
|---|---|---|---|
| uaAcl | 必选 | uaAcl | 访问ua配置规则 |
uaAcl类型如下:
| 参数 | 可选 | 类型 | 说明 |
|---|---|---|---|
| blackList | 可选 | list |
(旧格式) ua黑名单列表,单个ua长度限制为 1~200 字符。与 isBlackList/patterns/regexPatterns/exactPatterns 互斥,不可混用。 |
| whiteList | 可选 | list |
(旧格式) ua白名单列表,单个ua长度限制为 1~200 字符。与 isBlackList/patterns/regexPatterns/exactPatterns 互斥,不可混用。 |
| isBlackList | 可选 | Boolean | true 表示黑名单,false 表示白名单。与 blackList/whiteList 互斥,不可混用。 |
| patterns | 可选 | list |
字符串包含匹配列表,单个ua长度限制为 1~200 字符。与 blackList/whiteList 互斥,不可混用。 |
| regexPatterns | 可选 | list |
正则匹配列表,需符合 RE2 语法,单个ua长度限制为 1~200 字符。与 blackList/whiteList 互斥,不可混用。正则 ^$ 可以匹配空的 User-Agent,若规则中包含可匹配空 User-Agent 的正则:白名单场景下,User-Agent 为空的请求会被允许;黑名单场景下,User-Agent 为空的请求会被拒绝。 |
| exactPatterns | 可选 | list |
精确匹配列表,单个ua长度限制为 1~200 字符。与 blackList/whiteList 互斥,不可混用。 |
兼容说明
- 旧格式(
blackList/whiteList)与新格式(isBlackList/patterns/regexPatterns/exactPatterns)不可同时出现,混用会返回 400 错误。 - 旧格式
blackList等价于新格式中isBlackList=true+patterns;whiteList等价于isBlackList=false+patterns。 - 建议新接入方使用新格式,旧格式将来可能废弃。
- 使用新格式时,
patterns/regexPatterns/exactPatterns三项均为空时等价于删除 uaAcl 配置。
响应码 (Http Status Code)
| HTTP Status Code | 说明 |
|---|---|
| 200 | 成功 |
| 400 | 更新失败,参数错误等 |
请求示例1——旧格式,配置白名单
Text
1PUT /v2/domain/geloutinyyu11.yy.com/config?uaAcl
2
3{
4 "uaAcl": {
5 "whiteList": [
6 "MQQBrowser/5.3/Mozilla/5.0",
7 "Mozilla/5.0 (Linux; Android 7.0"
8 ]
9 }
10}
请求示例2——旧格式,配置黑名单
Text
1PUT /v2/domain/geloutinyyu11.yy.com/config?uaAcl
2
3{
4 "uaAcl": {
5 "blackList": [
6 "MQQBrowser/5.3/Mozilla/5.0",
7 "Mozilla/5.0 (Linux; Android 7.0"
8 ]
9 }
10}
请求示例3——新格式,配置黑名单(包含正则和精确匹配)
Text
1PUT /v2/domain/geloutinyyu11.yy.com/config?uaAcl
2
3{
4 "uaAcl": {
5 "isBlackList": true,
6 "patterns": ["curl", "python-requests"],
7 "regexPatterns": ["^Mozilla.*Chrome.*"],
8 "exactPatterns": ["Chrome/120.0.0.0"]
9 }
10}
请求示例4——删除uaAcl
Text
1PUT /v2/domain/geloutinyyu11.yy.com/config?uaAcl
2
3{
4 "uaAcl": null
5}
响应示例
Text
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3Transfer-Encoding: chunked
4
5{"status":"RUNNING"}
评价此篇文章
