重要
本文中的某些信息与预发行的产品有关,该产品在商业发布之前可能有重大修改。 Microsoft 对此处所提供的信息不作任何明示或默示的保证。
API 说明
按会话检索扫描历史记录的列表。
限制
此 API 的速率限制是每分钟 100 个调用和每小时 1,500 个调用。
权限
使用用户凭据获取令牌时:
- 若要查看数据,用户至少需要具有以下角色权限:
ViewData或TvmViewData。 有关详细信息,请参阅 创建和管理角色。
要调用此 API,需要以下权限之一。 若要了解详细信息(包括如何选择权限),请参阅使用Microsoft Defender for Endpoint API。
| 权限类型 | 权限 | 权限显示名称 |
|---|---|---|
| 应用程序 | Machine.Read.All | 读取所有扫描信息。 |
| 委派(工作或学校帐户) | Machine.Read.All | 读取所有扫描信息。 |
HTTP 请求
POST /api/DeviceAuthenticatedScanDefinitions/GetScanHistoryBySessionId
请求标头
| 名称 | 类型 | 说明 |
|---|---|---|
| Authorization | string | 持有者 {token}。 必需。 |
| Content-Type | string | application/json. 必需。 |
请求正文
在请求正文中,提供具有以下参数的 JSON 对象:
| 参数 | 类型 | 说明 |
|---|---|---|
| SessionIds | String | 会话 ID。 必需。 |
响应
如果成功,此方法返回 200 - 正常响应代码,其中包含会话的扫描历史记录列表。
示例请求
下面是请求的示例。
POST https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/GetScanHistoryBySessionId
{
"SessionIds": ["01decc497f4b4ec49a5fc4e12597f8c8"]
}
响应示例
{
"@odata.context": "https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/GetScanHistoryBySessionId",
"value": [
{
"orgId": "asdf781a0c-792d-46d3-bbea-a93dbc0bfcaa",
"ScanDefinitionIds": "4ad8d463-6b3a-4894-b42a-a2de9ea0a8ae",
"SessionIds": "01decc497f4b4ec49a5fc4e12597f8c8",
"NumberOfSuccessfullyScannedTargets": 3,
"NumberOfTargets": 3,
"ScanStatus": "Success",
"LastScanned": "2022-12-19T15:14:24.5561791Z",
"ListScannedTargets": {
"Ip": "127.0.0.1",
"Hostname": "DESKTOP-Test",
"ScannedDeviceDescription": "Network device",
"ErrorMessage": "",
"ScanStatus": "Success",
"ScanDuration": "00:08:30",
},
{
"Ip": "127.0.0.2",
"Hostname": "DESKTOP-Test2",
"ScannedDeviceDescription": "Network device 2",
"ErrorMessage": "",
"ScanStatus": "Success",
"ScanDuration": "00:08:00",
},
{
"Ip": "127.0.0.3",
"Hostname": "DESKTOP-Test3",
"ScannedDeviceDescription": "Network device 3",
"ErrorMessage": "",
"ScanStatus": "Success",
"ScanDuration": "00:08:50",
},
}
]
}