Version: 2.11

Control API

control API 可以被用来:

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

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

  1. apisix:
  2. ...
  3. enable_control: true
  4. control:
  5. ip: "127.0.0.1"
  6. port: 9090

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

通过插件添加的 control API

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

独立于插件的 control API

以下是支持的 API:

GET /v1/schema

引入自 2.2 版本

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

  1. {
  2. "main": {
  3. "route": {
  4. "properties": {...}
  5. },
  6. "upstream": {
  7. "properties": {...}
  8. },
  9. ...
  10. },
  11. "plugins": {
  12. "example-plugin": {
  13. "consumer_schema": {...},
  14. "metadata_schema": {...},
  15. "schema": {...},
  16. "type": ...,
  17. "priority": 0,
  18. "version": 0.1
  19. },
  20. ...
  21. },
  22. "stream-plugins": {
  23. "mqtt-proxy": {
  24. ...
  25. },
  26. ...
  27. }
  28. }

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

GET /v1/healthcheck

引入自 2.3 版本

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

  1. [
  2. {
  3. "healthy_nodes": [
  4. {
  5. "host": "127.0.0.1",
  6. "port": 1980,
  7. "priority": 0,
  8. "weight": 1
  9. }
  10. ],
  11. "name": "upstream#/upstreams/1",
  12. "nodes": [
  13. {
  14. "host": "127.0.0.1",
  15. "port": 1980,
  16. "priority": 0,
  17. "weight": 1
  18. },
  19. {
  20. "host": "127.0.0.2",
  21. "port": 1988,
  22. "priority": 0,
  23. "weight": 1
  24. }
  25. ],
  26. "src_id": "1",
  27. "src_type": "upstreams"
  28. },
  29. {
  30. "healthy_nodes": [
  31. {
  32. "host": "127.0.0.1",
  33. "port": 1980,
  34. "priority": 0,
  35. "weight": 1
  36. }
  37. ],
  38. "name": "upstream#/routes/1",
  39. "nodes": [
  40. {
  41. "host": "127.0.0.1",
  42. "port": 1980,
  43. "priority": 0,
  44. "weight": 1
  45. },
  46. {
  47. "host": "127.0.0.1",
  48. "port": 1988,
  49. "priority": 0,
  50. "weight": 1
  51. }
  52. ],
  53. "src_id": "1",
  54. "src_type": "routes"
  55. }
  56. ]

每个 entry 包含以下字段:

  • src_type:表示 health checker 的来源。值是 [routes,services,upstreams] 其中之一
  • src_id:表示创建 health checker 的对象的id。例如,假设 id 为 1 的 Upstream 对象创建了一个 health checker,那么 src_type 就是 upstreamssrc_id 就是 1
  • name: 表示 health checker 的名称
  • nodes: health checker 的目标节点
  • healthy_nodes: 表示 health checker 检测到的健康节点

用户也可以通过 /v1/healthcheck/$src_type/$src_id 来获取指定 health checker 的状态。

例如,GET /v1/healthcheck/upstreams/1 返回:

  1. {
  2. "healthy_nodes": [
  3. {
  4. "host": "127.0.0.1",
  5. "port": 1980,
  6. "priority": 0,
  7. "weight": 1
  8. }
  9. ],
  10. "name": "upstream#/upstreams/1",
  11. "nodes": [
  12. {
  13. "host": "127.0.0.1",
  14. "port": 1980,
  15. "priority": 0,
  16. "weight": 1
  17. },
  18. {
  19. "host": "127.0.0.2",
  20. "port": 1988,
  21. "priority": 0,
  22. "weight": 1
  23. }
  24. ],
  25. "src_id": "1",
  26. "src_type": "upstreams"
  27. }

POST /v1/gc

引入自 2.8 版本

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

注意,当你启用 stream proxy 时,APISIX 将为 stream 子系统运行另一个 Lua 虚拟机。它不会触发这个 Lua 虚拟机中的全量 GC。