Control API

    • 暴露 APISIX 内部状态信息
    • 控制单个 APISIX 的数据平面的行为

    默认情况下，control API 是启用的，监听 。你可以通过修改 apisix/conf/config.yaml 中的 control 部分来更改设置，如下：

    注意: control API server 不应该被配置成监听公网地址。

    APISIX 中一些插件添加了自己的 control API。如果你对他们感兴趣，请参阅对应插件的文档。

    独立于插件的 control API

    以下是支持的 API:

    使用以下格式返回被该 APISIX 实例使用的 json schema：

    只有启用了的插件才会被包含在返回结果中 plugins 部分。(返回结果中的)一些插件可能会缺失如 或者 type 字段，这取决于插件的定义。

    引入自 2.3 版本

    使用以下格式返回当前的 状态

    • src_id：表示创建 health checker 的对象的id。例如，假设 id 为 1 的 Upstream 对象创建了一个 health checker，那么 就是 upstreams，src_id 就是 1
    • name： 表示 health checker 的名称
    • nodes： health checker 的目标节点

    用户也可以通过 来获取指定 health checker 的状态。

    例如，GET /v1/healthcheck/upstreams/1 返回：

    引入自 2.8 版本

    在 http 子系统中触发一次全量 GC