Apache APISIX控制API详解：管理与监控API网关内部状态

富珂祯

于 2025-06-03 09:00:33 发布

阅读量343

点赞数 3

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00966/article/details/148391523

Apache APISIX控制API详解：管理与监控API网关内部状态

apisix The Cloud-Native API Gateway 项目地址: https://gitcode.com/gh_mirrors/ap/apisix

控制API概述

Apache APISIX的控制API是一组专门用于管理和监控网关内部状态的接口，它为运维人员提供了以下核心功能：

实时获取APISIX内部运行状态
查看和验证配置信息
执行特定的管理操作
监控上游服务健康状态

这些API设计初衷是供内部管理使用，绝对不能将其暴露在公网环境中，否则会带来严重的安全风险。

基础配置

控制API默认监听127.0.0.1:9090，如需修改，需要在配置文件(config.yaml)中进行调整：

apisix:
  enable_control: true  # 必须显式启用
  control:
    ip: "127.0.0.1"    # 建议保持本地回环
    port: 9090         # 可自定义端口

核心控制API详解

1. 配置结构查询API

GET /v1/schema

此API返回APISIX当前实例使用的完整JSON Schema结构，包括：

主配置结构(route/upstream等)
已启用插件的完整定义
流处理插件配置

典型响应示例：

{
    "main": {
        "route": {/*路由结构定义*/},
        "upstream": {/*上游结构定义*/}
    },
    "plugins": {
        "limit-count": {/*限流插件定义*/}
    }
}

2. 健康检查API

GET /v1/healthcheck

该API返回所有配置了健康检查的上游节点状态，数据结构包含：

资源标识(name字段)
检查类型(http/https/tcp)
节点详细信息(IP、端口、状态)
各类检查计数器

状态类型说明：

healthy：完全健康
unhealthy：不健康
mostly_healthy：基本健康(部分检查失败)
mostly_unhealthy：基本不健康(少量检查成功)

精确查询：可通过/v1/healthcheck/$src_type/$src_id查询特定资源，如：

GET /v1/healthcheck/upstreams/1

3. 资源管理API

APISIX提供了完整的资源查询接口：

| API端点 | 功能描述 | 引入版本 | |---------|---------|---------| | GET /v1/routes | 获取所有路由配置 | v2.10.0 | | GET /v1/route/{id} | 获取特定路由详情 | v2.10.0 | | GET /v1/services | 获取所有服务配置 | v2.11.0 | | GET /v1/service/{id} | 获取特定服务详情 | v2.11.0 | | GET /v1/upstreams | 获取所有上游配置 | v2.11.0 | | GET /v1/upstream/{id} | 获取特定上游详情 | v2.11.0 |

这些API返回的数据结构与Admin API保持一致，但仅提供只读访问。

4. 插件元数据API

| API端点 | 功能描述 | 引入版本 | |---------|---------|---------| | GET /v1/plugin_metadatas | 获取所有插件元数据 | v3.0.0 | | GET /v1/plugin_metadata/{name} | 获取特定插件元数据 | v3.0.0 |

元数据是插件的配置信息，不同于插件本身的Schema定义。