Kong学习笔记：命令行工具

本文更新于2026-09-21，操作系统为Debian 12.13 (bookworm)，使用Kong Enterprise 3.13.0.1（含OpenResty 1.27.1.2）。

目录

• kong check
• kong config
  • kong config db_export
  • kong config db_import
  • kong config init
  • kong config parse
• kong health
• kong hybrid
  • kong hybrid gen_cert
• kong migrations
  • kong migrations bootstrap
  • kong migrations finish
  • kong migrations list
  • kong migrations reset
  • kong migrations up
• kong prepare
• kong quit
• kong reload
• kong restart
• kong roar
• kong start
• kong stop
• kong version

命令行工具仅能管理本地节点，不能跨节点管理。

各子命令对应的源码位于/usr/local/share/lua/5.1/kong/cmd目录中。

所有子命令的OPTIONS都可使用以下通用选项：

• --help：打印此命令的帮助信息。
• -v：打印详细信息。
• -vv：打印更详细的调试信息。

kong check

检查.conf配置文件的有效性。不会给出具体的错误行数和对应配置。

kong check [CONFFILENAME]

如不指定CONFFILENAME，默认为/etc/kong/kong.conf。

kong config

元数据配置文件.yml工具。

kong config db_export

从数据库导出至元数据配置文件.yml。

kong config db_export [YMLFILENAME]

如不指定YMLFILENAME，默认为./kong.yml。

kong config db_import

将元数据配置文件.yml导入数据库。

kong config db_import YMLFILENAME

kong config init

初始化元数据配置文件.yml。

kong config init [OPTIONS] [YMLFILENAME]

• -c CONFFILENAME：.conf配置文件名。据此生成.yml配置文件。默认会查找以下文件：/etc/kong/kong.conf、/etc/kong.conf。

如不指定YMLFILENAME，默认为./kong.yml。

kong config parse

解析并检查元数据配置文件.yml是否有语法错误。

kong config parse YMLFILENAME

kong health

检查Kong进程健康状态。

kong health [OPTIONS]

kong hybrid

混合部署模式工具。

kong hybrid gen_cert

生成混合部署模式使用的证书。

kong hybrid gen_cert [OPTIONS]

• -d|--days N：有效期天数。默认为1095（3年）。

kong migrations

数据库数据迁移工具。

kong migrations bootstrap

初始化数据库。

kong migrations bootstrap [OPTIONS]

• -c CONFFILENAME：配置文件。默认会查找以下文件：/etc/kong/kong.conf、/etc/kong.conf。

kong migrations finish

完成kong migrations up挂起的迁移操作。该子命令关联的Kong版本非常旧。

kong migrations list

列出执行完的迁移操作。

kong migrations list

打印信息中，core代表核心元数据，hmac-auth、oauth2、jwt等代表插件数据，000_base等包含数字的信息为版本号。

kong migrations reset

重置数据库。不是清空表数据，而是删除所有与Kong服务相关的表，使用时需谨慎考虑。

kong migrations reset

kong migrations up

初始化数据库。效果与kong migrations bootstrap一样，针对不同的Kong版本。当Kong版本低于0.15时，需使用kong migrations up。

kong migrations up [OPTIONS]

kong prepare

执行此命令后，可以不使用kong start命令，而使用nginx命令启动Kong服务。该命令在生产环境中的使用率不高。

kong prepare [OPTIONS]

kong quit

优雅退出Kong。会向Nginx发送SIGQUIT信号，服务器在处理完所有当前的请求后关闭服务。如果处理超时，则发送SIGTERM信号，强制停止。

kong quit [OPTIONS]

kong reload

重新加载Kong。会向Nginx发送SIGHUP信号，如果Nginx可应用新的配置文件，会创建新的worker进程，并发送信号给旧worker进程，旧worker进程关闭监听socket，待处理完当前请求后优雅退出。如Nginx不能应用新的配置文件，仍使用旧的配置文件来提供服务。

kong reload [OPTIONS]

kong restart

重启Kong。为kong stop和kong start的组合。

kong restart [OPTIONS]

kong roar

打印一幅King Kong字符画。

kong roar

kong start

启动Kong。如果Kong正在运行中，则会报错，但不会影响运行中的服务。

kong start [OPTIONS]

• -c|--conf CONFFILENAME：配置文件。默认会查找以下文件：/etc/kong/kong.conf、/etc/kong.conf。
• --nginx-conf NGINXCONFFILENAME：Nginx配置模板文件名。
• --nginx-conf-flags FLAGS：Nginx配置模板文件的渲染方式。该模板文件使用Penlight引擎，在启动Nginx服务前，Kong会对模板文件进行编译，并转储到Kong启动目录中。
• -p|--prefix DIR：Kong运行时的工作目录前缀。

kong stop

强制停止Kong。会向Nginx发送SIGTERM信号，会导致当前处理的请求全部丢失。不建议在生产环境使用。

kong stop

kong version

打印Kong版本号。

kong version [OPTIONS]

• -a|--all：打印所有底层依赖的版本号。