跳到主要内容
版本：3.18.0

APISIX CLI

APISIX CLI 是 Apache APISIX 内置的 apisix 运行时命令。你可以使用它初始化、启动、停止、重新加载和测试 APISIX 实例。

apisix [action] <argument>

命令​

apisix help​

打印 APISIX CLI 帮助菜单。

apisix init​

初始化 nginx.conf 配置。

apisix init_etcd​

初始化 etcd 中的数据。

apisix start​

初始化并启动 APISIX 实例。

选项：

  • -h 或 --help：打印帮助菜单。

  • -c 或 --config：启动 APISIX 时指定自定义 配置文件 的路径。例如：

    apisix start -c /path/to/custom_config.yaml

    如果未设置 -c，APISIX 将回退到默认配置。

  • --verbose：显示 init_etcd 调试信息。

apisix stop​

立即停止正在运行的 APISIX 实例。APISIX 将停止所有工作进程，而不等待它们完成对任何未完成请求的服务。

apisix quit​

优雅地退出正在运行的 APISIX 实例。APISIX 将等待所有工作进程完成对任何未完成请求的服务后再停止。

apisix restart​

重启 APISIX 实例。此命令在停止和重启 APISIX 之前首先检查生成的 nginx.conf 配置。

apisix reload​

重新加载 APISIX 实例。重新初始化 nginx.conf 并应用配置更改而不中断现有连接。

apisix test​

测试生成的 nginx.conf 以验证配置。

apisix version​

打印 APISIX 版本。

apisix 命令用于管理 APISIX 进程，而不是路由和上游等网关资源。有关资源管理方式，请参阅管理方式。