注意:说明:当前功能灰度开放中,若你需要使用可以通过工单 联系我们。
一、使用场景
黑名单支持按 Client ID、Username、IP 地址三种维度设置封禁规则,并支持通配符和 CIDR 匹配,适用于少量客户端的快速封禁场景。如需更精细的权限管控,建议配置数据面授权策略。
二、限制与约束
·每个实例最多支持创建 10 条黑名单规则,每条规则最多支持 3 个排除条件。
·仅对标准 MQTT 客户端连接生效,暂不对 HTTP Publish 方式生效
·封禁规则顺序不敏感,多条规则之间为 OR 关系,命中任意一条即拦截。
三、新建规则
1. 登录消息队列 MQTT 版控制台 > 客户端管理 > 黑名单管理,单击左上角新建规则按钮,进行配置。
| 参数 | 是否必填 | 说明 |
| 规则名称 | 是 | 黑名单规则的唯一标识符。仅支持英文字母、数字、连字符(-)和下划线(_),长度 3-64 个字符。 |
| 备注 | 否 | 对规则用途的自由描述,支持中文,最多128个字符。 |
| 匹配维度 | 是 | 规则生效的匹配维度,支持 Client ID、Username、IP Address 三选一,一条规则只能选择一个维度且匹配条件和排除条件需属于同一维度 |
| 匹配条件 | 是 | 在所选维度下的匹配表达式。Client ID 和 Username 支持通配符(* 匹配任意字符,? 匹配单个字符);IP Address 支持精确 IP 或 CIDR 格式(如 203.0.113.0/24) |
| 排除条件 | 否 | 在匹配条件命中范围内,指定不受规则影响的具体对象,与匹配维度相同,支持通配符(* 匹配任意字符,? 匹配单个字符)。每条规则下最多填写 3 个排除条件。 |
| 到期时间 | 否 | 规则的自动失效时间。可选择永久生效或指定到期时间。到期后规则自动失效,但记录会在控制台上保留,可进行手动删除。 |
2. 单击提交,规则创建后立即生效,已匹配的存量连接和后续新建连接均会被阻断。
四、查看规则
1. 登录消息队列 MQTT 版控制台 > 客户端管理 > 黑名单管理,即可查看当前实例下所有黑名单规则。
列表展示以下信息:
| 字段 | 说明 |
| 规则名称 | 黑名单规则的唯一标识 |
| 备注 | 规则的描述信息 |
| 匹配维度 | 规则生效的连接属性维度(Client ID / Username / IP Address) |
| 匹配条件 | 规则的匹配表达式 |
| 排除条件 | 规则排除的对象列表(如有) |
| 到期时间 | 规则的失效时间。显示为具体时间或"永久生效" |
| 状态 | 规则当前状态:生效中或已过期 |
| 操作 | 支持编辑和删除操作 |
五、编辑规则
1. 在黑名单管理页面,找到目标规则,单击操作列的编辑。
2. 在弹出的对话框中修改规则参数。
3. 单击确定保存修改,修改后立即生效。
六、删除规则
1. 在黑名单管理页面,找到目标规则,单击操作列的删除。
2. 在弹出的确认对话框中,确认删除操作。
3. 单击确认删除,完成规则删除。
七、使用示例
场景:封禁异常测试客户端,保留监控客户端。某业务测试完成后,需要批量封禁所有以 test- 为前缀的测试客户端,但保留 test-monitor 监控客户端的连接。
配置方式:
·匹配维度:Client ID
·匹配条件:test-*
·排除条件:test-monitor
·到期时间:指定到期时间(如 7 天后自动失效)