监视器查询API¶
监视器扩展提供了一个简单的基于HTTP的API来查询请求信息。它允许以HTML或CSV格式检索单个请求记录或请求记录集。记录可以按时间范围和按任何字段排序的结果集进行筛选。大型结果集可以通过多个查询进行分页。
实例¶
以下示例显示了常见监视查询的语法。
所有请求为HTML¶
最简单的查询是检索包含所有请求信息的HTML文档：
GET http://localhost:8080/geoserver/rest/monitor/requests.html
所有请求作为csv¶
可以以csv格式返回请求信息，以便后期处理：
GET http://localhost:8080/geoserver/rest/monitor/requests.csv
包含换行符的请求正文用带引号的文本处理。如果csv阅读器不处理引用的换行符，它将无法正常工作。
所有请求作为pkzip¶
包含上述csv文件的pkzip存档，所有请求主体和错误作为单独的文件：
GET http://localhost:8080/geoserver/rest/monitor/requests.zip
所有请求均为MS Excel¶
包含与csv文件相同信息的Microsoft Excel电子表格：
GET http://localhost:8080/geoserver/rest/monitor/requests.xls
一段时间内的请求¶
可以按日期和时间范围筛选请求：
GET http://localhost:8080/geoserver/rest/monitor/requests.html?from=2010-06-20&to=2010-07-20
GET http://localhost:8080/geoserver/rest/monitor/requests.html?from=2010-06-20T2:00:00&to=2010-06-20T16:00:00
请求集分页¶
可以通过多个查询对大型结果集进行分页：
GET http://localhost:8080/geoserver/rest/monitor/requests.html?count=100
GET http://localhost:8080/geoserver/rest/monitor/requests.html?count=100&offset=100
GET http://localhost:8080/geoserver/rest/monitor/requests.html?count=100&offset=200
GET http://localhost:8080/geoserver/rest/monitor/requests.html?count=100&offset=300
单一请求¶
可以通过指定其ID来检索单个请求：
GET http://localhost:8080/geoserver/rest/monitor/requests/12345.html
API引用¶
有两种查询：一种用于单个请求，另一种用于请求集。
单个请求查询¶
单个请求记录的查询具有以下结构：
GET http://<host>:<port>/geoserver/rest/monitor/requests/<id>.<format>
在哪里？ id 是单个请求的数字标识符，并且 format 指定返回结果的表示形式为：
html-HTML表。csv-逗号分隔的值表。zip-包含上述CSV的PKZip存档，加上错误的纯文本和请求正文。xls-Microsoft Excel电子表格。
备注
使用 format 扩展是使用http Accept 头并将MIME类型指定为以下类型之一：
text/html
application/csv
application/zip
application/vnd.ms-excel
见 HTTP specification 有关 Accept 标题。
请求集查询¶
一组请求的查询结构为：
GET http://<host>:<port>/geoserver/rest/monitor/requests.<format>[?parameter{¶meter}]
在哪里？ format 如上所述，以及 parameter 是下面列出的一个或多个参数。
请求集查询接受各种参数，这些参数控制返回的请求及其排序方式。可用参数为：
计数参数¶
指定应返回的记录数。
句法 |
例子 |
|---|---|
|
requests.html?count=100 |
偏移参数¶
指定应从结果集中返回记录的位置。
句法 |
例子 |
|---|---|
|
requests.html?count=100&offset=500 |
活参数¶
指定只返回活动（当前正在执行）请求。
句法 |
例子 |
|---|---|
|
requests.html?live=yes |
此参数依赖于 监视器模式 用于维护实时请求信息（或者 live 或 混合的 ）
From参数¶
指定请求开始时间戳的包含下限。时间戳可以指定为任何所需的精度。
句法 |
例子 |
|---|---|
|
请求.html？自=2010-07-23t16:16:44 |
请求.html？自=2010-07-23 |
目标参数¶
指定请求开始时间戳的包含上限。时间戳可以指定为任何所需的精度。
句法 |
例子 |
|---|---|
|
请求.html？至=2010-07-24t00:00:00 |
请求.html？至=2010-07-24 |
订单参数¶
指定要排序的请求属性，并可以选择指定排序方向。
句法 |
例子 |
|---|---|
|
requests.html?order=path |
请求.html？顺序=开始时间；描述 |
|
请求.html？顺序=总时间；asc |