你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

OT 监视传感器的库存管理 API 参考

本文列出了 Defender for IoT OT 传感器支持的设备库存管理 API。

连接(检索设备连接信息)

使用此 API 可请求所有设备连接的列表。

URI/api/v1/devices/connections

GET

查询参数

定义以下任何查询参数以筛选返回的结果。 如果未设置查询参数,则返回所有设备连接。

名称 步骤 示例 必需/可选
discoveredBefore 数值。 筛选在给定时间之前检测到的结果,其中给定时间以毫秒为单位定义,采用 Epoch 时间和 UTC 时区。 /api/v1/devices/2/connections?discoveredBefore=<epoch> 可选
discoveredAfter 数值。 筛选在给定时间之后检测到的结果,其中给定时间以毫秒为单位定义,采用 Epoch 时间和 UTC 时区。 /api/v1/devices/2/connections?discoveredAfter=<epoch> 可选
lastActiveInMinutes 数值。 按连接处于活动状态的给定时间范围筛选结果。 从当前时间向后定义(以分钟为单位)。 /api/v1/devices/2/connections?lastActiveInMinutes=20 可选

每个设备的连接(检索特定设备连接信息)

使用此 API 可请求每个设备的所有连接的列表。

URI/api/v1/devices/<deviceID>/connections

GET

路径参数

名称 步骤 示例 必需/可选
deviceId 获取给定设备的连接。 /api/v1/devices/<deviceId>/connections 必需

查询参数

名称 步骤 示例 必需/可选
discoveredBefore 数值。 筛选在给定时间之前检测到的结果,其中给定时间以毫秒为单位定义,采用 Epoch 时间和 UTC 时区。 /api/v1/devices/2/connections?discoveredBefore=<epoch> 可选
discoveredAfter 数值。 筛选在给定时间之后检测到的结果,其中给定时间以毫秒为单位定义,采用 Epoch 时间和 UTC 时区。 /api/v1/devices/2/connections?discoveredAfter=<epoch> 可选
lastActiveInMinutes 数值。 按连接处于活动状态的给定时间范围筛选结果。 从当前时间向后定义(以分钟为单位)。 /api/v1/devices/2/connections?lastActiveInMinutes=20 可选

cve(检索有关 CVE 的信息)

使用此 API 可请求在网络中的设备上发现的所有已知 CVE 的列表,按 CVE 分数降序排序。

URI/api/v1/devices/cves

GET

示例/api/v1/devices/cves

定义以下任何查询参数以筛选返回的结果。

名称 步骤 示例 必需/可选
返回页首 数值。 确定要为每个设备 IP 地址获取多少个得分最高的 CVE。 /api/v1/devices/cves?top=50

/api/v1/devices/<ipAddress>/cves?top=50
可选。 默认值 = 100

每个 IP 地址的 cve(检索有 CVE 的具体信息)

使用此 API 可请求在网络中的设备上为特定 IP 地址发现的所有已知 CVE 的列表。

URI/api/v1/devices/cves

GET

示例/api/v1/devices/cves

路径参数

名称 步骤 示例 必需/可选
ipAddress 获取给定 IP 地址的 CVE。 /api/v1/devices/<ipAddress>/cves 必需

定义以下查询参数以筛选返回的结果。

名称 步骤 示例 必需/可选
返回页首 数值。 确定要为每个设备 IP 地址获取多少个得分最高的 CVE。 /api/v1/devices/cves?top=50

/api/v1/devices/<ipAddress>/cves?top=50
可选。 默认值 = 100

设备(检索设备信息)

使用此 API 可请求此传感器检测到的所有设备的列表。

URIapi/v1/devices/

GET

查询参数

定义以下查询参数以筛选返回的结果。 如果未设置查询参数,则返回所有设备连接。

名称 步骤 示例 必需/可选
已授权 布尔:

- true:仅筛选已授权设备上的数据。
- false:仅筛选未经授权的设备上的数据。
/api/v1/devices/ 可选

后续步骤

有关详细信息,请参阅 Defender for IoT API 参考概述