常见问题

    APISIX 和其他的 API 网关有什么不同之处？

    APISIX 基于 etcd 来完成配置的保存和同步，而不是 postgres 或者 MySQL 这类关系型数据库。 这样不仅去掉了轮询，让代码更加的简洁，配置同步也更加实时。同时系统也不会存在单点，可用性更高。

    另外，APISIX 具备动态路由和插件热加载，特别适合微服务体系下的 API 管理。

    APISIX 的性能怎么样？

    APISIX 设计和开发的目标之一，就是业界最高的性能。具体测试数据见这里：benchmark

    APISIX 是当前性能最好的 API 网关，单核 QPS 达到 2.3 万，平均延时仅有 0.6 毫秒。

    APISIX 是否有控制台界面？

    是的，APISIX 具有功能强大的 Dashboard。APISIX 与 APISIX Dashboard 是相互独立的项目，你可以部署 通过 web 界面来操作 APISIX。

    我可以自己写插件吗？

    当然可以，APISIX 提供了灵活的自定义插件，方便开发者和企业编写自己的逻辑。

    我们为什么选择 etcd 作为配置中心？

    对于配置中心，配置存储只是最基本功能，APISIX 还需要下面几个特性：

    1. 集群支持
    2. 事务
    3. 历史版本管理
    4. 变化通知
    5. 高性能

    APISIX 需要一个配置中心，上面提到的很多功能是传统关系型数据库和 KV 数据库是无法提供的。与 etcd 同类软件还有 Consul、ZooKeeper 等，更详细比较可以参考这里：，在将来也许会支持其他配置存储方案。

    为什么在用 Luarocks 安装 APISIX 依赖时会遇到超时，很慢或者不成功的情况？

    遇到 luarocks 慢的问题，有以下两种可能：

    1. luarocks 安装所使用的服务器不能访问
    2. 你所在的网络到 github 服务器之间有地方对 git 协议进行封锁

    针对第一个问题，你可以使用 https_proxy 或者使用 --server 选项来指定一个你可以访问或者访问更快的 luarocks 服务。 运行 luarocks config rocks_servers 命令（这个命令在 luarocks 3.0 版本后开始支持） 可以查看有哪些可用服务。对于中国大陆用户，你可以使用 luarocks.cn 这一个 luarocks 服务。

    我们已经封装好了选择服务地址的操作：

    如果使用代理仍然解决不了这个问题，那可以在安装的过程中添加 --verbose 选项来查看具体是慢在什么地方。排除前面的 第一种情况，只可能是第二种，git 协议被封。这个时候可以执行 git config --global url."https://".insteadOf git:// 命令使用 https 协议替代。

    如何通过 APISIX 支持灰度发布？

    比如，foo.com/product/index.html?id=204&page=2, 根据 URL 中 query string 中的 id 作为条件来灰度发布：

    1. A 组：id <= 1000
    2. B 组：id > 1000

    有两种不同的方法来实现：

    1、使用 route 的 vars 字段来实现

    1. curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "uri": "/index.html",    "vars": [        ["arg_id", "<=", "1000"]    ],    "plugins": {        "redirect": {            "uri": "/test?group_id=1"        }    }}'
    2. curl -i http://127.0.0.1:9080/apisix/admin/routes/2 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "uri": "/index.html",    "vars": [        ["arg_id", ">", "1000"]    ],    "plugins": {        "redirect": {            "uri": "/test?group_id=2"        }    }}'

    更多的 lua-resty-radixtree 匹配操作，可查看操作列表： https://github.com/api7/lua-resty-radixtree#operator-list

    2、通过 traffic-split 插件来实现

    详细使用示例请参考 插件文档。

    如何支持 http 自动跳转到 https？

    比如，将 http://foo.com 重定向到 https://foo.com

    有几种不同的方法来实现：

    1. 直接使用 redirect 插件的 http_to_https 功能：
    1. curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "uri": "/hello",    "host": "foo.com",    "plugins": {        "redirect": {            "http_to_https": true        }    }}'
    1. 结合高级路由规则 vars 和 redirect 插件一起使用：
    1. curl -i http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "uri": "/hello",    "host": "foo.com",    "vars": [        [            "scheme",            "==",            "http"        ]    ],    "plugins": {        "redirect": {            "uri": "https://$host$request_uri",            "ret_code": 301        }    }}'
    1. 使用serverless插件：
    1. curl -i http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "uri": "/hello",    "plugins": {        "serverless-pre-function": {            "phase": "rewrite",            "functions": ["return function() if ngx.var.scheme == \"http\" and ngx.var.host == \"foo.com\" then ngx.header[\"Location\"] = \"https://foo.com\" .. ngx.var.request_uri; ngx.exit(ngx.HTTP_MOVED_PERMANENTLY); end; end"]        }    }}'

    然后测试下是否生效：

    1. curl -i -H 'Host: foo.com' http://127.0.0.1:9080/hello

    响应体应该是：

    1. HTTP/1.1 301 Moved PermanentlyDate: Mon, 18 May 2020 02:56:04 GMTContent-Type: text/htmlContent-Length: 166Connection: keep-aliveLocation: https://foo.com/helloServer: APISIX web server
    2. <html><head><title>301 Moved Permanently</title></head><body><center><h1>301 Moved Permanently</h1></center><hr><center>openresty</center></body></html>

    默认的 APISIX 日志等级为warn，如果需要查看core.log.info的打印结果需要将日志等级调整为info。

    1、修改 conf/config.yaml 中的 nginx_config 配置参数error_log_level: "warn" 为 error_log_level: "info"。

    1. nginx_config:  error_log_level: "info"

    2、重启抑或 reload APISIX

    之后便可以在 logs/error.log 中查看到 info 的日志了。

    如何加载自己编写的插件

    Apache APISIX 的插件支持热加载。

    具体怎么做参考 插件 中关于“热加载”的部分。

    如何让 APISIX 在处理 HTTP 或 HTTPS 请求时监听多个端口

    默认情况下，APISIX 在处理 HTTP 请求时只监听 9080 端口。如果你想让 APISIX 监听多个端口，你需要修改配置文件中的相关参数，具体步骤如下：

    1. 修改 中 HTTP 端口监听的参数node_listen，示例：

        处理 HTTPS 请求也类似，修改conf/config.yaml中 HTTPS 端口监听的参数ssl.listen_port，示例：

      2.重启抑或 reload APISIX

      APISIX 利用 etcd 如何实现毫秒级别的配置同步

      etcd 提供订阅接口用于监听指定关键字、目录是否发生变更（比如： 、watchdir）。

      APISIX 主要使用 监视目录内容变更：

      • 如果监听目录没有数据更新：该调用会被阻塞，直到超时或其他错误返回。
      • 如果监听目录有数据更新：etcd 将立刻返回订阅(毫秒级)到的新数据，APISIX 将它更新到内存缓存。

      借助 etcd 增量通知毫秒级特性，APISIX 也就完成了毫秒级的配置同步。

      如何自定义 APISIX 实例 id

      默认情况下，APISIX 会从 conf/apisix.uid 中读取实例 id。如果找不到，且没有配置 id，APISIX 会生成一个 uuid 作为实例 id。

      如果你想指定一个有意义的 id 来绑定 APISIX 实例到你的内部系统，你可以在 conf/config.yaml 中进行配置，示例：

      1. ```apisix:  id: "your-meaningful-id"```

      为什么 error.log 中会有许多诸如 “failed to fetch data from etcd, failed to read etcd dir, etcd key: xxxxxx” 的错误？

      首先请确保 APISIX 和 etcd 之间不存在网络分区的情况。

      如果网络的确是健康的，请检查你的 etcd 集群是否启用了 gRPC gateway 特性。然而，当你使用命令行参数或配置文件启动 etcd 时，此特性的默认启用情况又是不同的。

      1. 当使用命令行参数启动 etcd，该特性默认被启用，相关选项是 enable-grpc-gateway。
      1. etcd --enable-grpc-gateway --data-dir=/path/to/data

      注意该选项并没有展示在 etcd --help 的输出中。

      1. 使用配置文件时，该特性默认被关闭，请明确启用 enable-grpc-gateway 配置项。
      1. # etcd.json{    "enable-grpc-gateway": true,    "data-dir": "/path/to/data"}
      1. # etcd.conf.ymlenable-grpc-gateway: true

      事实上这种差别已经在 etcd 的 master 分支中消除，但并没有向后移植到已经发布的版本中，所以在部署 etcd 集群时，依然需要小心。

      如何创建高可用的 Apache APISIX 集群？

      APISIX 的高可用可分为两个部分：

      1、Apache APISIX 的数据平面是无状态的，可以进行随意的弹性伸缩，前面加一层 LB 即可。

      2、Apache APISIX 的控制平面是依赖于 etcd cluster 的高可用实现的，不需要任何关系型数据库的依赖。

      为什么源码安装中执行 make deps 命令失败？

      1、当执行 make deps 命令时，发生诸如下面所示的错误。这是由于缺少 OpenResty 的 openssl 开发软件包导致的，你需要先安装它。请参考 文档进行安装。

      1. $ make deps......Error: Failed installing dependency: https://luarocks.org/luasec-0.9-1.src.rock - Could not find header file for OPENSSL  No file openssl/ssl.h in /usr/local/includeYou may have to install OPENSSL in your system and/or pass OPENSSL_DIR or OPENSSL_INCDIR to the luarocks command.Example: luarocks install luasec OPENSSL_DIR=/usr/localmake: *** [deps] Error 1

      如何通过 APISIX 代理访问 APISIX Dashboard

      1、保持 APISIX 代理端口和 Admin API 端口不同（或禁用 Admin API）。例如，在 conf/config.yaml 中做如下配置。

      Admin API 使用独立端口 9180：

      1. apisix:  port_admin: 9180            # use a separate port

      注意：这里的 APISIX Dashboard 服务正在监听 127.0.0.1:9000。

      1. curl -i http://127.0.0.1:9180/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "uris":[ "/*" ],    "name":"apisix_proxy_dashboard",    "upstream":{        "nodes":[            {                "host":"127.0.0.1",                "port":9000,                "weight":1            }        ],        "type":"roundrobin"    }}'

      这里通过 route 的 vars 字段来实现 uri 的正则匹配。

      1. curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "uri": "/*",    "vars": [        ["uri", "~~", "^/[a-z]+$"]    ],    "upstream": {            "type": "roundrobin",            "nodes": {                "127.0.0.1:1980": 1            }    }}'

      测试请求：

      在 route 中，我们可以通过 uri 结合 vars 字段来实现更多的条件匹配，vars 的更多使用细节请参考 。

      upstream 节点是否支持配置 地址?

      这是支持的，下面是一个 FQDN 为 httpbin.default.svc.cluster.local(一个 Kubernetes Service) 的示例：

      1. curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "uri": "/ip",    "upstream": {        "type": "roundrobin",        "nodes": {            "httpbin.default.svc.cluster.local": 1        }    }}'
      1. # 测试请求$ curl http://127.0.0.1:9080/ip -iHTTP/1.1 200 OK...

      Admin API 的 X-API-KEY 指的是什么？是否可以修改？

      1、Admin API 的 X-API-KEY 指的是 config.yaml 文件中的 apisix.admin_key.key，默认值是 edd1c9f034335f136f87ad84b625c8f1。它是 Admin API 的访问 token。

      注意：使用默认的 API token 存在安全风险，建议在部署到生产环境时对其进行更新。

      2、X-API-KEY 是可以修改的。

      例如：在 文件中对 apisix.admin_key.key 做如下修改并 reload APISIX。

      1. apisix:  admin_key    -      name: "admin"      key: abcdefghabcdefgh      role: admin

      访问 Admin API：

      1. $ curl -i http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: abcdefghabcdefgh' -X PUT -d '{    "uris":[ "/*" ],    "name":"admin-token-test",    "upstream":{        "nodes":[            {                "host":"127.0.0.1",                "port":1980,                "weight":1            }        ],        "type":"roundrobin"    }}'
      2. HTTP/1.1 200 OK......

      路由创建成功，表示 X-API-KEY 修改生效。

      如何允许所有 IP 访问 Admin API

      Apache APISIX 默认只允许 127.0.0.0/24 的 IP 段范围访问 Admin API，如果你想允许所有的 IP 访问，那么你只需在 conf/config.yaml 配置文件中添加如下的配置。

      1. apisix:  allow_admin:    - 0.0.0.0/0

      重启或 reload APISIX，所有 IP 便可以访问 Admin API。

      注意：您可以在非生产环境中使用此方法，以允许所有客户端从任何地方访问您的 Apache APISIX 实例，但是在生产环境中使用它并不安全。在生产环境中，请仅授权特定的 IP 地址或地址范围访问您的实例。

      基于 acme.sh 自动更新 apisix ssl 证书

      1. $ curl --output /root/.acme.sh/renew-hook-update-apisix.sh --silent https://gist.githubusercontent.com/anjia0532/9ebf8011322f43e3f5037bc2af3aeaa6/raw/65b359a4eed0ae990f9188c2afa22bacd8471652/renew-hook-update-apisix.sh
      2. $ chmod +x /root/.acme.sh/renew-hook-update-apisix.sh
      3. $ acme.sh  --issue  --staging  -d demo.domain --renew-hook "~/.acme.sh/renew-hook-update-apisix.sh  -h http://apisix-admin:port -p /root/.acme.sh/demo.domain/demo.domain.cer -k /root/.acme.sh/demo.domain/demo.domain.key -a xxxxxxxxxxxxx"
      4. $ acme.sh --renew --domain demo.domain

      详细步骤，可以参考博客

      如何在路径匹配时剪除请求路径前缀

      在转发至上游之前剪除请求路径中的前缀，比如说从 /foo/get 改成 /get，可以通过插件 proxy-rewrite 实现。

      1. curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "uri": "/foo/*",    "plugins": {        "proxy-rewrite": {            "regex_uri": ["^/foo/(.*)","/$1"]        }    },    "upstream": {        "type": "roundrobin",        "nodes": {            "httpbin.org:80": 1        }    }}'

      测试请求：

      1. $ curl http://127.0.0.1:9080/foo/get -iHTTP/1.1 200 OK...{  ...  "url": "http://127.0.0.1/get"}

      如何解决 unable to get local issuer certificate 错误

      修改 conf/config.yaml

      注意:

      尝试使用 cosocket 连接任何 TLS 服务时，如果 APISIX 不信任对端 TLS 服务证书，都需要配置 apisix.ssl.ssl_trusted_certificate。

      举例：在 APISIX 中使用 Nacos 作为服务发现时，Nacos 开启了 TLS 协议， 即 Nacos 配置的 host 是 https:// 开头，需要配置 apisix.ssl.ssl_trusted_certificate，并且使用和 Nacos 相同的 CA 证书。

      如何解决 module 'resty.worker.events' not found 错误

      在 /root 目录下安装 APISIX 会导致这个问题。因为 worker 进程的用户是 nobody，无权访问 /root 目录下的文件。需要移动 APISIX 安装目录，推荐安装在 /usr/local 目录下。

      plugin-metadata 和 plugin-configs 有什么区别

      plugin-metadata 是插件的元数据，由插件的所有配置实例共享。在编写插件时，如果有一些属性变化需要对该插件的所有配置实例生效，那么放在 plugin-metadata 合适。

      plugin-configs 是指多个不同插件的配置实例的组合，如果你想要复用一组通用的插件配置实例，你可以把它们提取成一个 Plugin Config，并绑定到对应的路由上。

      • 绑定主体作用范围：plugin-metadata 作用于该插件的所有配置实例绑定的主体。 作用于绑定了该 plugin-configs 的路由。