代理镜像插件,该插件提供了镜像客户端请求的能力。

注:镜像请求返回的响应会被忽略。

参数

名称 类型 必选项 默认值 有效值 描述
host string 必须 指定镜像服务地址,例如:http://127.0.0.1:9797(地址中需要包含 schema :http或https,不能包含 URI 部分)

示例

启用插件

示例1:为特定路由启用 proxy-mirror 插件:

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3. "plugins": {
  4. "proxy-mirror": {
  5. "host": "http://127.0.0.1:9797"
  6. }
  7. },
  8. "upstream": {
  9. "nodes": {
  10. "127.0.0.1:1999": 1
  11. },
  12. "type": "roundrobin"
  13. },
  14. "uri": "/hello"
  15. }'

测试:

  1. $ curl http://127.0.0.1:9080/hello -i
  2. HTTP/1.1 200 OK
  3. Content-Type: application/octet-stream
  4. Content-Length: 12
  5. Connection: keep-alive
  6. Server: APISIX web server
  7. Date: Wed, 18 Mar 2020 13:01:11 GMT
  8. Last-Modified: Thu, 20 Feb 2020 14:21:41 GMT
  9. hello world

由于指定的 mirror 地址是127.0.0.1:9797,所以验证此插件是否已经正常工作需要在端口为9797的服务上确认,例如,我们可以通过 python 启动一个简单的 server: python -m SimpleHTTPServer 9797。

禁用插件

移除插件配置中相应的 JSON 配置可立即禁用该插件,无需重启服务:

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

这时该插件已被禁用。