跳到主要内容

AISIX OSS Admin API(Dev)

AISIX OSS Admin API 是直接运维开源网关时可选的运维接口。资源管理操作为只读;同一监听器上的 Playground 会转发测试推理请求。连接 AISIX Enterprise 或 AISIX Cloud 的网关不公开此监听器,请通过对应控制面配置。

Health

  • GET Get Gateway Health /admin/v1/health

    Get model health levels and configuration-watch freshness for this gateway.

  • GET Get Liveness Status /livez

    Process liveness: should this instance be restarted? Answers 200 whenever it answers at all, including throughout a graceful drain — draining is deliberate work, and restarting an instance that is finishing the requests it accepted would kill exactly those. Use /readyz for traffic eligibility (readiness), which is what reports the drain.

  • GET Get Readiness Status /readyz

    Traffic eligibility (readiness): 200 when the instance can serve, 503 while draining or before the first config apply. Stays 200 for as long as the instance keeps serving that configuration, however long ago the last config event was — see /admin/v1/health and /status/config for configuration freshness. Distinct from /livez (process liveness).

OpenAPI

Models

Caller API Keys

Provider Keys

MCP Servers

A2A Agents

Passthrough Routes

Guardrails

Cache Policies

Observability Exporters

Playground