跳到主要内容

APISIX Control API

使用 APISIX Control API 检查或控制单个 APISIX 实例的运行时状态。该 API 默认在 http://127.0.0.1:9090 启用；请在配置文件中设置 apisix.enable_control 和 apisix.control。此 API 不提供身份认证，因此应仅监听环回地址或其他受信任的内部接口，切勿暴露到公网。

Schema

Health Check

  • GET Get Health Check Information /v1/healthcheck

    Get health check information for this APISIX instance. Send traffic to initialize upstream checker targets. The listing also includes checkers exposed by enabled plugins, such as ai-proxy-multi. An empty listing, and a checker with no targets, use JSON arrays ([]). Each plugin entry identifies the owning plugin in plugin and can include plugin-defined meta information. This is local runtime state, not fleet-wide readiness.

  • GET List All Checkers Owned by a Resource /v1/healthcheck/{src_type}/{src_id}/checkers

    List the upstream checker and checkers exposed by enabled plugins on this resource. Returns an empty array for an existing resource without checkers. Does not follow a route's service or upstream references; query the owning resource. The Control API has no authentication and must remain on a trusted interface.

  • GET Get Health Status By Type and ID /v1/healthcheck/{src_type}/{src_id}

    Get the single upstream health checker for a resource. This endpoint retains an object response and returns 404 when the resource has no upstream checker, even if a plugin owns checkers. Use the /checkers subresource to list both upstream and plugin-owned checkers.

Garbage Collection

  • POST Trigger Garbage Collection /v1/gc

    Trigger a full garbage collection (GC) in the HTTP subsystem. Note that a request to this endpoint would not trigger a garbage collection in the stream subsystem because the subsystems are run in the separate Lua VM.

Route

Upstream

Service

Plugin Metadata

Plugin

Service Discovery

Server Information