黑名单管理

黑名单列表: /blackLists GET

请求参数

参数名	示列值	类型	必须	说明
page	1	number	否	当前页数
pageSize	10	number	否	每页条数
id	xxx	string	否	ip
sort	-createdAt	string	否	排序。多个排序字段用,号隔开。sort=-a,b
expand	''	string	否	获取指定子资源数据 ''
attributes	"id,name"	string	否	本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回参数 | 参数名 | 示列值 | 说明 | | -------- | ----- | ------ | | page | 1 | 当前页数 | | pageSize | 10 | 每页条数 | | limit | 10 | 同 pageSize | | offset | 2 | 起始条数 | | total | 3231 | 符合条件的总数量 | | items | [{ "id": 4, "name": "test2"}] | 返回数据项 |

• items： 黑名单信息

参数名	示列值	类型	说明
id	1	number	id
ip	127.0.0.1	string	ip
description	''	string	描述
region	''	string	地区
path	''	string	请求地址
query	''	string	请求参数
body	''	string	请求体
status	0	number	状态 0=禁用 1=启用
createdAt	1650160322	number	创建时间
updatedAt	1650160322	number	更新时间

返回示列

HTTP/1.1 200 OK
{
    "items": [
      {
        "createdAt": 1726301762,
        "updatedAt": 1726301762,
        "id": 7,
        "ip": "27.159.96.162",
        "region": "中国福建省厦门市",
        "description": "",
        "path": "",
        "query": {},
        "body": {},
        "status": 1
      }
    ],
    "total": 4070,
    "offset": 1,
    "limit": 2,
    "page": 1,
    "pageSize": 2
  }

新建黑名单: /blackLists POST

请求参数

参数名	示列值	类型	必须	说明
ip	127.0.0.1	string	是	ip

返回结果: 黑名单信息

编辑黑名单: /blackLists/:id PUT

请求参数

参数名	示列值	类型	必须	说明
ip	127.0.0.1	string	是	ip

返回结果: 黑名单信息

黑名单详情: /blackLists/:id GET

请求参数

| 参数名 | 示列值 | 类型 | 必须 | 说明 | | ---------- | -------------- | ------ | ---- | ---------------------------------------- | --- | | id | 1 | number | 是 | 组织 id | | | expand | '' | string | 否 | 获取指定子资源数据 '' | | attributes | ["id", "ip"] | array | 否 | 本资源的字段。不定义该字段时返回所有字段 |

返回结果: 黑名单信息

删除黑名单: /blackLists/:id DELETE

请求参数

参数名	示列值	类型	必须	说明
id	1	number	是	资源 id

返回示列

HTTP/1.1 204 NO CONTENT

所有黑名单: /listAll/blackLists GET

请求参数

参数名	示列值	类型	必须	说明	默认值
name	xxx	string	否	名称
expand	''	string	否	获取指定子资源数据 ''
attributes	"id,name"	string	否	本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回结果: 黑名单信息

返回示列

HTTP/1.1 200 OK
[
  {}
]