Skip to main content
Version: Next

Status API

在 Apache APISIX 中,Status API 用于:

  • 检查 APISIX 是否已成功启动并正确运行
  • 检查所有 workers 是否已收到配置并加载

要更改 Status API 服务器的默认端点(127.0.0.1:7085),请更改配置文件(conf/config.yaml)中 status 部分中的 ipport

apisix:
status:
ip: "127.0.0.1"
port: 7085

此 API 可用于在 APISIX 开始接收用户请求之前对 APISIX 执行就绪探测。

GET /status#

返回报告 APISIX 工作人员状态的 JSON。如果 APISIX 未运行,建立 TCP 连接时请求将报错。否则,如果请求到达正在运行的 worker,此端点将始终返回 ok。

{
"status": "ok"
}

GET /status/ready#

当所有 worker 都已加载配置时,返回 ok;否则,返回特定错误,错误代码为 503。以下是具体示例。

当所有 worker 都已加载配置时:

{
"status": "ok"
}

当 1 个 workers 尚未初始化时:

{
"status": "error",
"error": "worker count: 16 but status report count: 15"
}

当特定 worker 尚未加载配置时:

{
"error": "worker id: 9 has not received configuration",
"status": "error"
}