Skip to content

黑名单管理

本页 API 文档提供了与客户端黑名单管理相关的各种操作信息,包括查看黑名单、将某个客户端添加到黑名单以及删除黑名单信息。

查看黑名单

URI

GET /banned

返回集群下所有黑名单数据,支持分页。

查询参数:

参数类型描述
_pageInteger页码
_limitInteger每页显示的数据条数

请求消息

响应消息

名称类型描述
codeInteger0
dataArray of Objects所有黑名单数据
data[].whoString黑名单的对象
data[].asString对象类型
data[].reasonString详细信息
data[].byString添加者
data[].atInteger添加至黑名单的时间
data[].untilInteger何时从黑名单中解除
metaObject分页信息
meta.pageInteger页码
meta.limitInteger每页显示的数据条数
meta.countInteger数据总条数

请求示例

bash
$ curl -u app_id:app_secret -X GET {api}/banned

响应示例

JSON
{
  "meta": {
    "page": 1,
    "limit": 10,
    "count": 2
  },
  "data": [
    {
      "who": "clientid_test",
      "until": 1668504415,
      "reason": "reason_test",
      "by": "user",
      "at": 1668504115,
      "as": "clientid"
    },
    {
      "who": "user_test",
      "until": 1668504469,
      "reason": "reason_test",
      "by": "admin",
      "at": 1668504169,
      "as": "username"
    }
  ],
  "code": 0
}

添加黑名单信息

URI

POST /banned

将对象添加至黑名单。

请求消息

名称类型是否必须默认值描述
whoString必须添加至黑名单的对象,可以是客户端标识符、用户名和 IP 地址
asString必须用于区分黑名单对象类型,可以是clientidusernamepeerhost
reasonString必须详细信息
byString非必须user指示该对象被谁添加至黑名单
atInteger非必须当前系统时间添加至黑名单的时间,单位:秒
untilInteger非必须当前系统时间 + 5 分钟何时从黑名单中解除,单位:秒

响应消息

名称类型描述
codeInteger0
dataObjects黑名单信息
data.whoString黑名单的对象
data.asString对象类型
data.reasonString详细信息
data.byString添加者
data.atInteger添加至黑名单的时间
data.untilInteger何时从黑名单中解除

请求示例

bash
$ curl -u app_id:app_secret -X POST {api}/banned -d '{"who":"example","as":"clientid","reason":"example"}'

响应示例

JSON
{
  "code": 0,
  "data": {
    "who": "example",
    "until": 1668504415,
    "reason": "example",
    "by": "user",
    "at": 1668504115,
    "as": "clientid"
  }
}

删除黑名单信息

URI

DELETE /banned/{as}/{who}

将对象从黑名单中删除

请求消息

响应消息

名称类型描述
codeInteger0
messageString仅在发生错误时返回,用于提供更详细的错误信息

请求示例

bash
$ curl -u app_id:app_secret -X DELETE {api}/banned/clientid/example

响应示例

JSON
{
  "code": 0
}