地图统计 API

在 UDB-SX Dashboards 中创建并保存地图后,该地图会成为类型为 map 的保存对象。Maps Stats API 提供有关这些保存对象的统计信息。

示例请求

可通过以下格式的 URL 访问 Maps Stats API:

<oudbsx-dashboards-endpoint-address>/api/maps-dashboards/stats

UDB-SX Dashboards 端点地址若在配置文件中指定了端口,则可能包含端口号。具体 URL 格式取决于 UDB-SX 部署类型及所处网络环境。

您可通过两种方式查询该端点:

  • 在浏览器中直接访问端点地址(例如 http://localhost:6601/api/maps-dashboards/stats

  • 在终端使用 curl 命令:

    curl -k -u admin:admin -X GET http://localhost:6601/api/maps-dashboards/stats
    

示例响应

上述请求的返回结果如下:

{
  "maps_total": 2,
  "layers_filters_total": 4,
  "layers_total": {
    "opensearch_vector_tile_map": 2,
    "documents": 5,
    "wms": 0,
    "tms": 0
  },
  "maps_list": [
    {
      "id": "88a24e6c-0216-4f76-8bc7-c8db6c8705da",
      "layers_filters_total": 4,
      "layers_total": {
        "opensearch_vector_tile_map": 1,
        "documents": 3,
        "wms": 0,
        "tms": 0
      }
    },
    {
      "id": "d6f736d0-cf59-11f0-b0a0-7591c2d17c8d",
      "layers_filters_total": 0,
      "layers_total": {
        "opensearch_vector_tile_map": 1,
        "documents": 2,
        "wms": 0,
        "tms": 0
      }
    }
  ]
}

响应体字段

响应包含以下图层类型的统计信息:

  • 基础图层:默认 UDB-SX 地图或自定义基础图层。

  • WMS 图层:自定义 WMS 基础图层。

  • TMS 图层:自定义 TMS 基础图层。

  • 文档图层:地图的数据图层。

有关图层类型的更多信息,参见添加图层

下表列出所有响应字段。

字段 数据类型 描述
maps_total Integer 在 Maps 插件中注册为保存对象的地图总数。
layers_filters_total Integer 所有地图中所有图层的过滤器总数。包括图层级过滤器,不包括形状过滤器等全局过滤器。
layers_total Object 所有地图中所有图层的总计统计。
layers_total.opensearch_vector_tile_map Integer 所有地图中 UDB-SX 基础图层总数。
layers_total.documents Integer 所有地图中文档图层总数。
layers_total.wms Integer 所有地图中 WMS 图层总数。
layers_total.tms Integer 所有地图中 TMS 图层总数。
maps_list Array UDB-SX Dashboards 中保存的所有地图列表。

maps_list 中每张地图包含以下字段。

字段 数据类型 描述
id String 地图的保存对象 ID。
layers_filters_total Integer 该地图中所有图层的过滤器总数。包括图层级过滤器,不包括形状过滤器等全局过滤器。
layers_total Object 该地图中所有图层的总计统计。
layers_total.opensearch_vector_tile_map Integer 该地图中 UDB-SX 底图数量。
layers_total.documents Integer 该地图中文档图层数量。
layers_total.wms Integer 该地图中 WMS 图层数量。
layers_total.tms Integer 该地图中 TMS 图层数量。