获取规则列表
更新时间不可用
获取指定项目下的封禁用户权限规则列表。
GET
https://api.sd-rtn.com/dev/v1/kicking-rule该方法获取封禁用户权限的规则列表。
注意
为了最大程度保障核心功能创建 (POST)、更新 (PUT) 和删除 (DELETE) 的成功率，在公网质量异常抖动下，查询 (GET) 方法的成功率和准确性会有一定程度降级。查询 (GET) 的返回结果中，可能会缺失部分请求记录。
当你要创建 (POST) 一条封禁规则（time 不为 0），并需要在后续更新和删除该规则时，建议：
- 在你的服务端保存 POST 请求返回的规则 ID，并依赖该 ID 实现后续更新和解封操作。
- 为确保在公网质量异常时依然能够获取该请求返回的规则 ID，请求超时时间建议设置为 20 秒以上，最低不低于 5 秒。
- 仅当 POST 请求超时或者返回 504 时，可以参考 GET 结果尝试获取对应规则 ID。如果规则存在，说明 POST 请求成功，则在你的服务端保存规则 ID。
鉴权
appidstring项目的 App ID。可通过以下方式获取：
- 从声网控制台获取。
- 调用获取所有项目信息 API，并读取响应包体中
vendor_key字段的值。
响应
如果状态码为 200，则请求成功。
响应 Body
statusstring本次请求的状态。success 表示请求成功。
封禁用户权限的规则列表。该数组由多个 object 组成，每个 object 表示一条规则的信息。
idnumber规则 ID。当更新或删除封禁用户权限规则时，需要传入规则 ID。
uidnumber用户 ID。
opidnumber操作 ID，用于问题排查时核对操作记录。
cnamestring频道名。
ipstring用户的 IP 地址。
tsstring该规则过期时间（UTC 时间）。
privilegesarray<string>被封禁的用户权限，可能包含的字段如下：
join_channel：加入频道publish_audio：发送音频流publish_video：发送视频流
createAtstring该规则的创建时间（UTC 时间）。
updateAtstring该规则的更新时间（UTC 时间）。
请求示例
curl --request GET \
--url "https://api.sd-rtn.com/dev/v1/kicking-rule" \
--header 'Authorization: Basic <credentials>'响应示例
{
"status": "success",
"rules": [
{
"id": 1953,
"appid": "4855xxxxxxxxxxxxxxxxxxxxxxxxeae2",
"uid": 589517928,
"opid": 1406,
"cname": "11",
"ip": "192.168.0.1",
"ts": "2018-01-09T07:23:06.000Z",
"privileges": [
"join_channel"
],
"createAt": "2018-01-09T06:23:06.000Z",
"updateAt": "2018-01-09T14:23:06.000Z"
}
]
}