Apache Tomcat 10

大多数命令接受以下一个或多个查询参数

• path - 您正在处理的 Web 应用程序的上下文路径（包括前导斜杠）。要选择 ROOT Web 应用程序，请指定“/”。
  注意：无法对 Manager 应用程序本身执行管理命令。
  注意：如果未显式指定 path 参数，则路径和版本将使用标准的 上下文命名 规则从 config 参数中推导出来，或者如果 config 参数不存在，则从 war 参数中推导出来。
• version - 此 Web 应用程序的版本，如 并行部署 功能所用。如果您使用并行部署，无论何时需要路径，您都必须除了路径之外还指定一个版本，并且路径和版本的组合必须是唯一的，而不仅仅是路径。
  注意：如果未显式指定路径，则版本参数将被忽略。
• war - Web 应用程序存档 (WAR) 文件的 URL，或包含 Web 应用程序的目录的路径名，或上下文配置“.xml”文件。您可以使用以下任何格式的 URL
  • file:/absolute/path/to/a/directory - 包含解压缩的 Web 应用程序的目录的绝对路径。此目录将附加到您指定的上下文路径，无需任何更改。
  • file:/absolute/path/to/a/webapp.war - Web 应用程序存档 (WAR) 文件的绝对路径。此路径仅对 /deploy 命令有效，并且是该命令唯一可接受的格式。
  • file:/absolute/path/to/a/context.xml - 包含 Context 配置元素的 Web 应用程序 Context 配置“.xml”文件的绝对路径。
  • directory - Host 的应用程序基本目录中 Web 应用程序上下文的目录名称。
  • webapp.war - 位于 Host 的应用程序基本目录中的 Web 应用程序 war 文件的名称。

每个命令都将以 text/plain 格式返回响应（即，没有 HTML 标记的纯 ASCII），便于人和程序读取）。响应的第一行将以 OK 或 FAIL 开头，指示请求的命令是否成功。如果失败，第一行的其余部分将包含遇到的问题的描述。某些命令包含以下所述的附加信息行。

国际化说明 - Manager 应用程序在资源包中查找其消息字符串，因此这些字符串可能已针对您的平台进行了翻译。以下示例显示了消息的英文版本。

https://127.0.0.1:8080/manager/text/deploy?path=/foo

上传作为此 HTTP PUT 请求中的请求数据指定的 Web 应用程序存档 (WAR) 文件，将其安装到我们相应的虚拟主机的 appBase 目录中，并启动，从指定的路径派生添加到 appBase 的 WAR 文件的名称。稍后可以使用 /undeploy 命令取消部署应用程序（并删除相应的 WAR 文件）。

此命令由 HTTP PUT 请求执行。

通过在 /META-INF/context.xml 中包含 Context 配置 XML 文件，.WAR 文件可以包含特定于 Tomcat 的部署配置。

URL 参数包括

• update: 当设置为 true 时，任何现有的更新都将首先被取消部署。默认值为 false。
• tag: 指定标签名称，这允许将部署的 Web 应用程序与标签或标签相关联。如果 Web 应用程序被取消部署，则可以在需要时仅使用标签重新部署它。
• config : Context 配置“.xml”文件的 URL，格式为 file:/absolute/path/to/a/context.xml。这必须是包含 Context 配置元素的 Web 应用程序 Context 配置“.xml”文件的绝对路径。

注意 - 此命令是 /undeploy 命令的逻辑反面。

如果安装和启动成功，您将收到类似以下的响应

OK - Deployed application at context path /foo

否则，响应将以FAIL开头，并包含错误消息。 问题可能的原因包括

• 应用程序已存在于路径 /foo

  所有当前运行的 Web 应用程序的上下文路径必须是唯一的。 因此，您必须使用此上下文路径取消部署现有的 Web 应用程序，或为新的应用程序选择不同的上下文路径。 update 参数可以作为 URL 上的参数指定，值为 true 以避免此错误。 在这种情况下，将在执行部署之前对现有应用程序执行取消部署。

• 遇到异常

  在尝试启动新的 Web 应用程序时遇到异常。 检查 Tomcat 日志以获取详细信息，但可能的解释包括解析 /WEB-INF/web.xml 文件时出现问题，或者在初始化应用程序事件侦听器和过滤器时遇到缺少的类。

部署并启动一个新的 Web 应用程序，附加到指定的上下文path（该路径不能被任何其他 Web 应用程序使用）。 此命令是/undeploy命令的逻辑反面。

此命令由 HTTP GET 请求执行。 部署命令可以使用多种不同的方式。

https://127.0.0.1:8080/manager/text/deploy?path=/footoo&tag=footag

https://127.0.0.1:8080/manager/text/deploy?path=/footoo&war=file:/path/to/foo

https://127.0.0.1:8080/manager/text/deploy?war=file:/path/to/bar.war

https://127.0.0.1:8080/manager/text/deploy?war=foo

https://127.0.0.1:8080/manager/text/deploy?war=bar.war

<Context path="/foobar" docBase="/path/to/application/foobar">
</Context>

https://127.0.0.1:8080/manager/text/deploy?config=file:/path/context.xml

https://127.0.0.1:8080/manager/text/deploy
 ?config=file:/path/context.xml&war=file:/path/bar.war

OK - Deployed application at context path /foo

https://127.0.0.1:8080/manager/text/list

列出所有当前部署的Web应用程序的上下文路径、当前状态（running或stopped）以及活动会话数。在启动Tomcat后立即进行的典型响应可能如下所示

OK - Listed applications for virtual host localhost
/webdav:running:0:webdav
/examples:running:0:examples
/manager:running:0:manager
/:running:0:ROOT
/test:running:0:test##2
/test:running:0:test##1

https://127.0.0.1:8080/manager/text/reload?path=/examples

向现有应用程序发出信号，使其自行关闭并重新加载。当Web应用程序上下文不可重新加载并且您已更新/WEB-INF/classes目录中的类或属性文件，或者您已在/WEB-INF/lib目录中添加或更新了jar文件时，这很有用。

如果此命令成功，您将看到类似于此的响应

OK - Reloaded application at context path /examples

否则，响应将以FAIL开头，并包含错误消息。 问题可能的原因包括

• 遇到异常

  尝试重新启动Web应用程序时遇到异常。检查Tomcat日志以获取详细信息。

• 指定了无效的上下文路径

  上下文路径必须以斜杠字符开头。要引用ROOT Web应用程序，请使用“/”。

• 路径/foo不存在上下文

  您指定的上下文路径上没有部署的应用程序。

• 未指定上下文路径

  path参数是必需的。

• 不支持在路径/foo处部署的WAR上重新加载

  目前，当Web应用程序直接从WAR文件部署时，不支持应用程序重新加载（以获取对类或web.xml文件的更改）。它仅在从解压缩的目录部署Web应用程序时才有效。如果您使用的是WAR文件，则应undeploy，然后deploy或使用update参数再次deploy应用程序以获取您的更改。

https://127.0.0.1:8080/manager/text/serverinfo

列出有关 Tomcat 版本、操作系统和 JVM 属性的信息。

如果发生错误，响应将以 FAIL 开头，并包含错误消息。出现问题的原因可能包括

• 遇到异常

  尝试枚举系统属性时遇到异常。检查 Tomcat 日志以获取详细信息。

https://127.0.0.1:8080/manager/text/resources[?type=xxxxx]

列出可用于上下文配置文件资源链接的全局 JNDI 资源。如果您指定 type 请求参数，则该值必须是您感兴趣的资源类型的完全限定 Java 类名（例如，您将指定 javax.sql.DataSource 以获取所有可用 JDBC 数据源的名称）。如果您没有指定 type 请求参数，则将返回所有类型的资源。

根据是否指定了 type 请求参数，正常响应的第一行将是

OK - Listed global resources of all types

或

OK - Listed global resources of type xxxxx

后面跟着每个资源的一行。每行由冒号（“:”）分隔的字段组成，如下所示

• 全局资源名称 - 此全局 JNDI 资源的名称，将在 <ResourceLink> 元素的 global 属性中使用。
• 全局资源类型 - 此全局 JNDI 资源的完全限定 Java 类名。

如果发生错误，响应将以 FAIL 开头，并包含错误消息。出现问题的原因可能包括

• 遇到异常

  尝试枚举全局 JNDI 资源时遇到异常。检查 Tomcat 日志以获取详细信息。

• 没有可用的全局 JNDI 资源

  您正在运行的 Tomcat 服务器已配置为没有全局 JNDI 资源。

https://127.0.0.1:8080/manager/text/sessions?path=/examples

显示 Web 应用程序的默认会话超时时间，以及在其实际超时时间的一分钟范围内处于活动状态的当前活动会话数。例如，在重新启动 Tomcat 并在 /examples Web 应用程序中执行其中一个 JSP 示例后，您可能会得到类似以下内容

OK - Session information for application at context path /examples
Default maximum session inactive interval 30 minutes
<1 minutes: 1 sessions
1 - <2 minutes: 1 sessions

https://127.0.0.1:8080/manager/text/expire?path=/examples&idle=num

显示会话统计信息（如上面的 /sessions 命令）并使空闲时间超过 num 分钟的会话过期。要使所有会话过期，请使用 &idle=0 。

OK - Session information for application at context path /examples
Default maximum session inactive interval 30 minutes
1 - <2 minutes: 1 sessions
3 - <4 minutes: 1 sessions
>0 minutes: 2 sessions were expired

实际上，/sessions 和 /expire 是同一个命令的同义词。区别在于 idle 参数的存在。

https://127.0.0.1:8080/manager/text/start?path=/examples

向已停止的应用程序发出重启信号，使其再次可用。停止和启动很有用，例如，如果您的应用程序所需的数据库暂时不可用。通常，最好停止依赖此数据库的 Web 应用程序，而不是让用户不断遇到数据库异常。

如果此命令成功，您将看到类似于此的响应

OK - Started application at context path /examples

否则，响应将以FAIL开头，并包含错误消息。 问题可能的原因包括

• 遇到异常

  尝试启动 Web 应用程序时遇到异常。检查 Tomcat 日志以获取详细信息。

• 指定了无效的上下文路径

  上下文路径必须以斜杠字符开头。要引用ROOT Web应用程序，请使用“/”。

• 路径/foo不存在上下文

  您指定的上下文路径上没有部署的应用程序。

• 未指定上下文路径

  path参数是必需的。

https://127.0.0.1:8080/manager/text/stop?path=/examples

向现有应用程序发出信号，使其不可用，但将其部署。在应用程序停止时传入的任何请求都将看到 HTTP 错误 404，并且此应用程序将在列出应用程序的命令中显示为“已停止”。

如果此命令成功，您将看到类似于此的响应

OK - Stopped application at context path /examples

否则，响应将以FAIL开头，并包含错误消息。 问题可能的原因包括

• 遇到异常

  尝试停止 Web 应用程序时遇到异常。检查 Tomcat 日志以获取详细信息。

• 指定了无效的上下文路径

  上下文路径必须以斜杠字符开头。要引用ROOT Web应用程序，请使用“/”。

• 路径/foo不存在上下文

  您指定的上下文路径上没有部署的应用程序。

• 未指定上下文路径 path 参数是必需的。

https://127.0.0.1:8080/manager/text/undeploy?path=/examples

警告 - 此命令将删除此虚拟主机 appBase 目录（通常为“webapps”）中存在的任何 Web 应用程序工件。这将删除应用程序 .WAR（如果存在）、从解压缩形式部署或从 .WAR 扩展生成的应用程序目录，以及来自 $CATALINA_BASE/conf/[enginename]/[hostname]/ 目录的 XML 上下文定义。如果您只想使应用程序停止服务，则应使用 /stop 命令。

向现有应用程序发出信号，使其优雅地关闭自身，并将其从 Tomcat 中删除（这也使该上下文路径可供以后重用）。此外，如果文档根目录存在于此虚拟主机的 appBase 目录（通常为“webapps”）中，则该目录将被删除。此命令是 /deploy 命令的逻辑反面。

如果此命令成功，您将看到类似于此的响应

OK - Undeployed application at context path /examples

否则，响应将以FAIL开头，并包含错误消息。 问题可能的原因包括

• 遇到异常

  在尝试取消部署 Web 应用程序时遇到异常。检查 Tomcat 日志以获取详细信息。

• 指定了无效的上下文路径

  上下文路径必须以斜杠字符开头。要引用ROOT Web应用程序，请使用“/”。

• 不存在名为 /foo 的上下文。

  没有部署与您指定的名称相同的应用程序。

• 未指定上下文路径 path 参数是必需的。

https://127.0.0.1:8080/manager/text/findleaks[?statusLine=[true|false]]

查找泄漏诊断会触发完整的垃圾回收。在生产系统上应谨慎使用。

查找泄漏诊断尝试识别在停止、重新加载或取消部署时导致内存泄漏的 Web 应用程序。结果应始终使用分析器进行确认。诊断使用 StandardHost 实现提供的附加功能。如果使用不扩展 StandardHost 的自定义主机，它将不起作用。

从 Java 代码显式触发完整的垃圾回收被记录为不可靠。此外，根据使用的 JVM，存在禁用显式 GC 触发的选项，例如 -XX:+DisableExplicitGC。如果您想确保诊断成功运行了完整的 GC，则需要使用 GC 日志、JConsole 等工具进行检查。

如果此命令成功，您将看到类似于此的响应

/leaking-webapp

如果您希望在响应中包含状态行，请在请求中包含 statusLine 查询参数，其值为 true。

每个已停止、重新加载或取消部署的 Web 应用程序的上下文路径，但来自先前运行的类仍加载在内存中，从而导致内存泄漏，将在新行中列出。如果应用程序已重新加载多次，则它可能被列出多次。

如果命令未成功，则响应将以 FAIL 开头，并包含错误消息。

https://127.0.0.1:8080/manager/text/sslConnectorCiphers

SSL 连接器/密码诊断列出了当前为每个连接器配置的 SSL/TLS 密码。

响应将类似于以下内容

OK - Connector / SSL Cipher information
Connector[HTTP/1.1-8080]
  SSL is not enabled for this connector
Connector[HTTP/1.1-8443]
  TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  ...

https://127.0.0.1:8080/manager/text/sslConnectorCerts

SSL 连接器/证书诊断列出了当前为每个虚拟主机配置的证书链。

响应将类似于以下内容

OK - Connector / Certificate Chain information
Connector[HTTP/1.1-8080]
SSL is not enabled for this connector
Connector[HTTP/1.1-8443]-_default_-RSA
[
[
  Version: V3
  Subject: CN=localhost, OU=Apache Tomcat PMC, O=The Apache Software Foundation, L=Wakefield, ST=MA, C=US
  Signature Algorithm: SHA256withRSA, OID = 1.2.840.113549.1.1.11
  ...

https://127.0.0.1:8080/manager/text/sslConnectorTrustedCerts

SSL 连接器/证书诊断列出了当前为每个虚拟主机配置的受信任证书。

响应将类似于以下内容

OK - Connector / Trusted Certificate information
Connector[HTTP/1.1-8080]
SSL is not enabled for this connector
Connector[HTTP/1.1-8443]-_default_
[
[
  Version: V3
  Subject: CN=Apache Tomcat Test CA, OU=Apache Tomcat PMC, O=The Apache Software Foundation, L=Wakefield, ST=MA, C=US
  ...

https://127.0.0.1:8080/manager/text/sslReload?tlsHostName=name

重新加载 TLS 配置文件（证书和密钥文件，这不会触发对 server.xml 的重新解析）。要重新加载所有主机的文件，请不要指定 tlsHostName 参数。

OK - Reloaded TLS configuration for [_default_]

https://127.0.0.1:8080/manager/text/threaddump

写入 JVM 线程转储。

响应将类似于以下内容

OK - JVM thread dump
2014-12-08 07:24:40.080
Full thread dump Java HotSpot(TM) Client VM (25.25-b02 mixed mode):

"http-nio-8080-exec-2" Id=26 cpu=46800300 ns usr=46800300 ns blocked 0 for -1 ms waited 0 for -1 ms
   java.lang.Thread.State: RUNNABLE
        locks java.util.concurrent.ThreadPoolExecutor$Worker@1738ad4
        at sun.management.ThreadImpl.dumpThreads0(Native Method)
        at sun.management.ThreadImpl.dumpAllThreads(ThreadImpl.java:446)
        at org.apache.tomcat.util.Diagnostics.getThreadDump(Diagnostics.java:440)
        at org.apache.tomcat.util.Diagnostics.getThreadDump(Diagnostics.java:409)
        at org.apache.catalina.manager.ManagerServlet.threadDump(ManagerServlet.java:557)
        at org.apache.catalina.manager.ManagerServlet.doGet(ManagerServlet.java:371)
        at jakarta.servlet.http.HttpServlet.service(HttpServlet.java:618)
        at jakarta.servlet.http.HttpServlet.service(HttpServlet.java:725)
...

https://127.0.0.1:8080/manager/text/vminfo

写入有关 Java 虚拟机的一些诊断信息。

响应将类似于以下内容

OK - VM info
2014-12-08 07:27:32.578
Runtime information:
  vmName: Java HotSpot(TM) Client VM
  vmVersion: 25.25-b02
  vmVendor: Oracle Corporation
  specName: Java Virtual Machine Specification
  specVersion: 1.8
  specVendor: Oracle Corporation
  managementSpecVersion: 1.2
  name: ...
  startTime: 1418012458849
  uptime: 393855
  isBootClassPathSupported: true

OS information:
...

https://127.0.0.1:8080/manager/text/save

如果未指定任何参数，则此命令会将服务器的当前配置保存到 server.xml。如果需要，现有文件将被重命名为备份。

如果指定了与已部署 Web 应用程序的路径匹配的 path 参数，则该 Web 应用程序的配置将保存到当前 Host 的 xmlBase 中的适当命名的 context.xml 文件中。

要使用该命令，必须存在 StoreConfig MBean。通常，这使用 StoreConfigLifecycleListener 进行配置。

如果命令未成功，则响应将以 FAIL 开头，并包含错误消息。

它采用以下形式

http://webserver/manager/jmxproxy/?qry=STUFF

其中STUFF是您希望执行的 JMX 查询。例如，以下是一些您可能希望运行的查询

• qry=*%3Atype%3DRequestProcessor%2C* --> type=RequestProcessor，它将找到所有可以处理请求的 worker 并报告其状态。
• qry=*%3Aj2eeType=Servlet%2c* --> j2eeType=Servlet，它将返回所有已加载的 Servlet。
• qry=Catalina%3Atype%3DEnvironment%2Cresourcetype%3DGlobal%2Cname%3DsimpleValue --> Catalina:type=Environment,resourcetype=Global,name=simpleValue，它将根据给定名称查找特定 MBean。

您需要对此进行试验才能真正了解其功能。如果您没有提供qry参数，则将显示所有 MBean。我们强烈建议您查看 Tomcat 源代码并了解 JMX 规范，以便更好地理解您可以运行的所有查询。

JMXProxyServlet 还支持一个“get”命令，您可以使用它来获取特定 MBean 属性的值。get 命令的一般形式是

http://webserver/manager/jmxproxy/?get=BEANNAME&att=MYATTRIBUTE&key=MYKEY

您必须提供以下参数

1. get：完整的 Bean 名称
2. att：您要获取的属性
3. key：（可选）CompositeData MBean 属性的键

如果一切顺利，它将显示 OK，否则将显示错误消息。例如，假设我们要获取当前堆内存数据

http://webserver/manager/jmxproxy/?get=java.lang:type=Memory&att=HeapMemoryUsage

或者，如果您只想获取“used”键

http://webserver/manager/jmxproxy/
 ?get=java.lang:type=Memory&att=HeapMemoryUsage&key=used

现在您可以查询 MBean 了，是时候修改 Tomcat 的内部结构了！set 命令的一般形式是

http://webserver/manager/jmxproxy/?set=BEANNAME&att=MYATTRIBUTE&val=NEWVALUE

因此您需要提供 3 个请求参数

1. set：完整的 Bean 名称
2. att：您要更改的属性
3. val：新值

如果一切顺利，它将显示 OK，否则将显示错误消息。例如，假设我们要动态地为 ErrorReportValve 启用调试。以下操作将调试设置为 10。

https://127.0.0.1:8080/manager/jmxproxy/
 ?set=Catalina%3Atype%3DValve%2Cname%3DErrorReportValve%2Chost%3Dlocalhost
 &att=debug&val=10

我的结果是（结果可能会有所不同）

Result: ok

以下是我传入错误值时看到的内容。这是我使用的 URL，我尝试将调试设置为“cow”

https://127.0.0.1:8080/manager/jmxproxy/
 ?set=Catalina%3Atype%3DValve%2Cname%3DErrorReportValve%2Chost%3Dlocalhost
 &att=debug&val=cow

当我尝试这样做时，我的结果是

Error: java.lang.NumberFormatException: For input string: "cow"

invoke 命令允许在 MBean 上调用方法。该命令的一般形式是

http://webserver/manager/jmxproxy/
 ?invoke=BEANNAME&op=METHODNAME&ps=COMMASEPARATEDPARAMETERS

例如，要调用 **Service** 的 findConnectors() 方法，请使用

https://127.0.0.1:8080/manager/jmxproxy/
 ?invoke=Catalina%3Atype%3DService&op=findConnectors&ps=

使用Ant版本1.6.2或更高版本，Catalina 任务提供将输出捕获到属性或外部文件中的选项。它们直接支持以下<redirector>类型属性子集

还可以指定一些其他属性

它们还支持嵌入的 <redirector> 元素，您可以在其中指定其完整的属性集，但 input、inputstring 和 inputencoding 即使被接受，也不会被使用，因为它们在这个上下文中没有意义。有关 <redirector> 元素属性的详细信息，请参阅 Ant 手册。

以下是一个示例构建文件摘录，展示了如何使用此输出重定向支持

    <target name="manager.deploy"
        depends="context.status"
        if="context.notInstalled">
        <deploy url="${mgr.url}"
            username="${mgr.username}"
            password="${mgr.password}"
            path="${mgr.context.path}"
            config="${mgr.context.descriptor}"/>
    </target>

    <target name="manager.deploy.war"
        depends="context.status"
        if="context.deployable">
        <deploy url="${mgr.url}"
            username="${mgr.username}"
            password="${mgr.password}"
            update="${mgr.update}"
            path="${mgr.context.path}"
            war="${mgr.war.file}"/>
    </target>

    <target name="context.status">
        <property name="running" value="${mgr.context.path}:running"/>
        <property name="stopped" value="${mgr.context.path}:stopped"/>

        <list url="${mgr.url}"
            outputproperty="ctx.status"
            username="${mgr.username}"
            password="${mgr.password}">
        </list>

        <condition property="context.running">
            <contains string="${ctx.status}" substring="${running}"/>
        </condition>
        <condition property="context.stopped">
            <contains string="${ctx.status}" substring="${stopped}"/>
        </condition>
        <condition property="context.notInstalled">
            <and>
                <isfalse value="${context.running}"/>
                <isfalse value="${context.stopped}"/>
            </and>
        </condition>
        <condition property="context.deployable">
            <or>
                <istrue value="${context.notInstalled}"/>
                <and>
                    <istrue value="${context.running}"/>
                    <istrue value="${mgr.update}"/>
                </and>
                <and>
                    <istrue value="${context.stopped}"/>
                    <istrue value="${mgr.update}"/>
                </and>
            </or>
        </condition>
        <condition property="context.undeployable">
            <or>
                <istrue value="${context.running}"/>
                <istrue value="${context.stopped}"/>
            </or>
        </condition>
    </target>

警告：即使它没有太多意义，并且始终是一个坏主意，多次调用 Catalina 任务，设置不当的 Ant 任务依赖链可能会导致在同一个 Ant 运行中多次调用一个任务，即使并非有意为之。在捕获该任务的输出时，应谨慎操作，因为这可能会导致一些意外情况

• 当在属性中捕获时，您将只在其中找到第一次调用的输出，因为 Ant 属性是不可变的，一旦设置就不能更改。
• 当在文件中捕获时，每次运行都会覆盖它，您将只在其中找到最后一次调用的输出，除非您使用 append="true" 属性，在这种情况下，您将看到每次任务调用的输出附加到文件中。