url封禁相关接口
更新时间：2023-02-10
quota查询接口
本接口用于查询当前用户的url封禁容量以及使用了多少
| Method | Path | 说明 |
|---|---|---|
| GET | /v2/firewalls/forbidden/quota | 查询当前用户的url封禁容量以及使用了多少 |
请求示例：
GET /v2/firewalls/forbidden/quota HTTP/1.1
Host: cdn.baidubce.com响应体 (Response Body)
| 参数 | 可选 | 类型 | 说明 |
|---|---|---|---|
| quota | 必选 | unsigned int | url封禁总容量 |
| count | 必选 | unsigned int | 当前封禁的url数目 |
响应示例：
HTTP/1.1 200 OK
Server: nginx/1.1.10
Date: Thu, 17 Dec 2020 12:14:38 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
X-Powered-By: PHP/7.2.28
x-bce-request-id: b1c22e2f-6a28-2f7b-a06a-df4de49cee98
{"quota":50,"count":5}url封禁列表查询接口
本接口用于查询url封禁列表——查询的结果不带协议，不带url参数，支持分页
| Method | Path | 说明 |
|---|---|---|
| GET | /v2/firewalls/forbidden/urls | 查询url封禁列表 |
url参数
| 参数 | 可选 | 类型 | 说明 |
|---|---|---|---|
| pageSize | 可选 | unsigned int | 分页查询页面大小，默认值为10，最大不超过100 |
| pageNo | 可选 | unsigned int | 指定查询第几页，默认值为1 |
| orderBy | 可选 | string | 值为desc或asc，指定时间倒序输出还是时间顺序输出。默认为desc，时序倒序输出。设置为asc时按时序顺序输出 |
| url | 可选 | string | 指定的url查询，url path不能超过1024字符 |
请求示例：
GET /v2/firewalls/forbidden/urls HTTP/1.1
Host: cdn.baidubce.com响应体 (Response Body)
| 参数 | 可选 | 类型 | 说明 |
|---|---|---|---|
| count | 必选 | unsigned int | 查询结果总条数，用于分页 |
| urlRecords | 必选 | list<urlRecord> | 查询结果 |
urlRecord类型说明
| 参数 | 可选 | 类型 | 说明 |
|---|---|---|---|
| url | 必选 | string | 封禁的url |
| time | 必选 | string | 封禁的时间，北京时间 |
响应示例：
HTTP/1.1 200 OK
Server: nginx/1.1.10
Date: Thu, 17 Dec 2020 12:02:36 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
X-Powered-By: PHP/7.2.28
x-bce-request-id: 847dd852-5f97-d906-e2c8-af6fd1231b97
{
"count": "5",
"urlRecords": [
{
"url": "test.aaa.baidu.com\/1.html",
"time": "2020-08-18 16:31:13"
},
{
"url": "test.aaa.baidu.com\/3.html",
"time": "2020-08-18 16:31:13"
},
{
"url": "test.aaa.baidu.com\/a.html",
"time": "2020-08-18 16:31:13"
},
{
"url": "test.aaa.baidu.com\/b.html",
"time": "2020-08-18 16:31:13"
},
{
"url": "test.aaa.baidu.com\/c.html",
"time": "2020-08-18 16:31:13"
}
]
}url封禁操作记录查询
本接口用于查询url封禁操作记录——查询的结果url不带协议，不带参数，支持分页
| Method | Path | 说明 |
|---|---|---|
| GET | /v2/firewalls/forbidden/operateHistories | 查询url封禁操作记录 |
url参数
| 参数 | 可选 | 类型 | 说明 |
|---|---|---|---|
| pageSize | 可选 | unsigned int | 分页查询页面大小，默认值为10，最大不超过100 |
| pageNo | 可选 | unsigned int | 指定查询第几页，默认值为1 |
| startTime | 可选 | string | 指定时间范围查询，开始时间，距当前时间点不能超过90天，北京时间 |
| endTime | 可选 | string | 指定时间范围查询，截止时间，不能大于当前时间，北京时间 |
| orderBy | 可选 | string | 值为desc或asc，指定时间倒序输出还是时间顺序输出。默认为desc，时序倒序输出。设置为asc时按时序顺序输出 |
| url | 可选 | string | 指定的url查询，url path不能超过1024字符 |
请求示例：
GET /v2/firewalls/forbidden/operateHistories HTTP/1.1
Host: cdn.baidubce.com响应体 (Response Body)
| 参数 | 可选 | 类型 | 说明 |
|---|---|---|---|
| count | 必选 | unsigned int | 查询结果总条数，用于分页 |
| operateHistories | 必选 | list<operateHistory> | 查询结果 |
operateHistory类型说明
| 参数 | 可选 | 类型 | 说明 |
|---|---|---|---|
| url | 必选 | string | 封禁的url |
| action | 必选 | unsigned int | 执行的操作，1表ban操作，0表unban操作 |
| time | 必选 | string | 封禁的时间，北京时间 |
响应示例：
HTTP/1.1 200 OK
Server: nginx/1.1.10
Date: Thu, 17 Dec 2020 12:05:17 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
X-Powered-By: PHP/7.2.28
x-bce-request-id: 88a24d76-5348-4c22-60d1-d31ddfc8f12
{
"count": "7",
"urlHistories": [
{
"url": "test.aaa.baidu.com\/1.html",
"action": 1,
"time": "2020-08-18 16:31:13"
},
{
"url": "test.aaa.baidu.com\/3.html",
"action": 1,
"time": "2020-08-18 16:31:13"
},
{
"url": "test.aaa.baidu.com\/a.html",
"action": 1,
"time": "2020-08-18 16:31:13"
},
{
"url": "test.aaa.baidu.com\/7.html",
"action": 0,
"time": "2020-08-18 12:52:55"
},
{
"url": "test.aaa.baidu.com\/4.html",
"action": 0,
"time": "2020-08-18 12:52:55"
},
{
"url": "test.aaa.baidu.com\/b.html",
"action": 1,
"time": "2020-08-18 16:31:13"
},
{
"url": "test.aaa.baidu.com\/c.html",
"action": 1,
"time": "2020-08-18 16:31:13"
}
]
}url封禁接口
本接口用于提交url封禁，默认封禁时间为30天。
| Method | Path | 说明 |
|---|---|---|
| POST | /v2/firewalls/forbidden/ban | url封禁操作 |
请求体
| 参数 | 可选 | 类型 | 说明 |
|---|---|---|---|
| urls | 必选 | list<string> | 要封禁的url列表，封禁时是忽略协议以及参数的。urls列表不能超过10条。url path不能超过1024字符 |
请求示例：
POST /v2/firewalls/forbidden/ban HTTP/1.1
Host: cdn.baidubce.com
{
"urls": [
"www.test.com/case.xml",
"https://www.test.com/case.index",
"http://www.test.com/case.xml"
]
}响应体 (Response Body)
空
url解封禁接口
本接口用于执行url解封禁操作
| Method | Path | 说明 |
|---|---|---|
| POST | /v2/firewalls/forbidden/unban | url解封禁操作 |
请求体
| 参数 | 可选 | 类型 | 说明 |
|---|---|---|---|
| urls | 必选 | list<string> | 要解封禁的url列表，封禁时是忽略协议以及参数的。urls列表不能超过10条。url path不能超过1024字符 |
请求示例：
GET /v2/firewalls/forbidden/unban HTTP/1.1
Host: cdn.baidubce.com
{
"urls": [
"www.test.com/case.xml",
"https://www.test.com/case.index",
"http://www.test.com/case.xml"
]
}响应体 (Response Body)
空