本地管理控制台的集成 API 参考(公共预览版)

本文列出了支持将 Microsoft Defender for IoT 与合作伙伴服务集成的 API。

例如,此 API 当前通过 教程实现:通过适用于 Defender for IoT 的 ServiceNow Service Graph 连接器将 ServiceNow 与 Microsoft Defender for IoT集成。

注意

集成 API 旨在持续运行并创建一个持续运行的数据流,例如查询过去 5 分钟内的新数据。 集成 API 使用时间戳返回数据。

若要简单地查询数据,请改为对本地管理控制台使用常规的非集成 API 来查询所有设备,或者让特定的传感器仅从该传感器查询设备。 有关详细信息,请参阅 Defender for IoT API 参考

URI/external/v3/integration/

设备(创建和更新设备)

此 API 返回有关给定时间戳后更新的所有设备的数据。

URI/external/v3/integration/devices/<timestamp>

URI 参数

名字 描述 必需/可选
时间戳 从中返回结果的开始时间,以毫秒为单位,从 Epoch 时间 和 UTC 时区。 /external/v3/integration/devices/1664781014000 必填

获取

查询参数

名字 描述 必需/可选
sensorId 仅返回特定传感器看到的设备。 使用 传感器(获取传感器) API 的结果中的 ID 值。 1 自选
notificationType 确定要返回的设备类型。 支持的值包括:
- 0:更新的设备和新设备(默认值)。
- 1:仅新设备。
- 2:仅更新的设备。
2 自选
页面 定义结果页码开始的编号。 例如,0= 第一页 0
默认值 = 0
0 自选
大小 定义页面大小调整。 默认值 = 50 75 自选

连接 (获取设备连接)

此 API 返回有关给定时间戳后更新的所有设备连接的数据。

URI/external/v3/integration/connections/<timestamp>

URI 参数

名字 描述 必需/可选
时间戳 从中返回结果的开始时间,以毫秒为单位,从 Epoch 时间 和 UTC 时区。 /external/v3/integration/devices/1664781014000 必填

获取

查询参数

名字 描述 必需/可选
页面 定义结果页码开始的编号。 例如,0= 第一页 0
默认值 = 0
0 自选
大小 定义页面大小调整。 默认值 = 50 75 自选

设备(获取设备的详细信息)

此 API 根据给定的设备 ID 返回有关特定设备的数据。

URI/external/v3/integration/device/{deviceId}

获取

查询参数

名字 描述 必需/可选
deviceId 本地管理控制台上请求的设备 ID 1 必填

deleteddevices (获取已删除的设备)

此 API 从提供的时间戳返回最近删除设备的 ID 列表。

URI/external/v3/integration/deleteddevices/

获取

URI 参数

名字 描述 必需/可选
时间戳 从中返回结果的开始时间,以毫秒为单位,从 Epoch 时间 和 UTC 时区。 /external/v3/integration/deleteddevices/1664781014000 必填

传感器 (获取传感器)

此 API 返回连接的 OT 网络传感器的传感器对象列表。

URI/external/v3/integration/sensors/

获取

URI/sensors

无查询参数

devicecves (获取设备 CVE)

此 API 返回自提供时间戳以来更新的所有设备的活动 CVE 列表。

URI/external/v3/integration/devicecves/

获取

URI/external/v3/integration/devicecves/<timestamp>

URI 参数

名字 描述 必需/可选
时间戳 从中返回结果的开始时间,以毫秒为单位,从 Epoch 时间 和 UTC 时区。 /external/v3/integration/devicecves/1664781014000 必填

查询参数

名字 描述 必需/可选
页面 定义结果页码开始的编号。 0= 第一页 0
默认值 = 0
自选
大小 定义页面大小调整。 默认值 = 50 自选
sensorId 根据给定的传感器 ID 定义,显示来自特定传感器的结果。 1 自选
分数 确定要检索的最小 CVE 分数。 所有结果将具有等于或大于给定值的 CVE 分数。 默认值 = 0 自选
deviceIds 要从中显示结果的设备 ID 的逗号分隔列表。 例如:1232,34,2,456 自选

后续步骤

有关详细信息,请参阅: