对于 type 字段是个枚举类型，它可以是 consumer_name 或 service_id 。分别代表以下含义：

  • consumer_name：把 consumer 的 username 列入白名单或黑名单（支持单个或多个 consumer）来限制对服务或路线的访问。
  • service_id：把 service 的 id 列入白名单或黑名单（支持一个或多个 service）来限制service的访问，需要结合授权插件一起使用。

下面是一个示例，在指定的 route 上开启了 consumer-restriction 插件，限制 consumer 访问:

测试插件

jack1 访问:

  1. curl -u jack2019:123456 http://127.0.0.1:9080/index.html -i
  2. HTTP/1.1 200 OK
  3. ...
  1. curl -u jack2020:123456 http://127.0.0.1:9080/index.html -i
  2. HTTP/1.1 403 Forbidden
  3. ...
  4. {"message":"The consumer_name is forbidden."}

如何限制 service_id

service_id方式需要与授权插件一起配合使用，这里以key-auth授权插件为例。

1、创建两个 service

2、在 consumer 上绑定 consumer-restriction 插件(需要与一个授权插件配合才能绑定),并添加 service_id 白名单列表

  1. curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  3.     "username": "new_consumer",
  4.     "plugins": {
  5.     "key-auth": {
  6.         "key": "auth-jack"
  7.     "consumer-restriction": {
  8.            "type": "service_id",
  9.             "whitelist": [
  10.                 "1"
  11.             ],
  12.             "rejected_code": 403
  13.         }
  14.     }
  15. }'

3、在 route 上开启 key-auth 插件并绑定 service_id 为1

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/index.html",
  4.     "upstream": {
  5.         "type": "roundrobin",
  6.         "nodes": {
  7.             "127.0.0.1:1980": 1
  8.         }
  9.     },
  10.     "service_id": 1,
  11.     "plugins": {
  12.         }
  13.     }
  14. }'

说明在白名单列中的 service_id 允许访问，插件配置生效。

4、在 route 上开启 key-auth 插件并绑定 service_id 为2

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/index.html",
  4.     "upstream": {
  5.         "type": "roundrobin",
  6.         "nodes": {
  7.             "127.0.0.1:1980": 1
  8.         }
  9.     },
  10.     "service_id": 2,
  11.     "plugins": {
  12.          "key-auth": {
  13.         }
  14.     }
  15. }'

测试插件

  1. curl http://127.0.0.1:9080/index.html -H 'apikey: auth-jack' -i
  2. HTTP/1.1 403 Forbidden
  3. {"message":"The service_id is forbidden."}

说明不在白名单列表的 service_id 被拒绝访问，插件配置生效。

现在就已移除 插件，其它插件的开启和移除也类似。