Metadata API 指南#

视觉元数据由元数据帧组成

Metadata API 端点#

分析 Web API 通过 Ingress 控制器公开。

URL 前缀是 http://<INGRESS-HOST-IP>:<INGRESS-PORT>/emdx/

将 INGRESS-HOST-IP 替换为 Jetson 设备 IP。将 INGRESS-PORT 替换为 30080 或 Ingress 配置中定义的最后一个值。

注意

URL 前缀路径在未来版本中可能会更改

Metadata API 版本 v2#

Metadata API 有一个新的主要版本 v2，它与早期版本不向后兼容。此版本仍然支持 JPS 1.0 版本附带的先前版本。但是，强烈建议采用/迁移到 v2 版本。v2 版本在路径 /api/v2 下提供。早期版本仍然在 /api 下运行。

检索视觉元数据#

获取给定传感器的给定时间段的元数据

HTTP GET

/api/v2/frames?sensorId=Amcrest_3&fromTimestamp=2020-10-30T20:00:00.000Z&toTimestamp=2020-10-31T01:00:00.000Z

强制查询参数#

sensorId

描述: 要返回元数据的传感器。

类型: 字符串

示例: sensorId=Amcrest_3

fromTimestamp

描述: 需要返回元数据的timestamp的下限

类型: UTC / GMT 时间戳字符串

示例: 2020-10-30T20:00:00.000Z

toTimestamp

描述: 需要返回元数据的 timestamp 的上限。

类型: UTC / GMT 时间戳字符串

示例: 2020-10-30T20:05:00.000Z

响应#

{
    "frames": [
        {
            "timestamp": "2022-08-09T21:25:13.208Z",
            "version": 4.0,
            "id": 4508668,
            "sensorId": "Amcrest_3",
            "objects": [
                {
                    "id": 899,
                    "type": "Person",
                    "bbox": {
                        "leftX": 1075.61,
                        "topY": 364.011,
                        "rightX": 1230.41,
                        "bottomY": 754.086
                    }
                }
            ]
        }
    ]
}

错误响应#

响应正文：请参阅页面末尾的错误响应正文定义。

HTTP 状态代码

422：未找到请求的 sensorId 和时间范围的元数据帧 500：内部服务器错误

错误响应正文：#

所有 API 的错误响应都是具有以下属性的 JSON 对象。

{
   "detail": "#Detailed error string"
}
本页内容