运行防病毒扫描 API
适用于:
希望体验 Microsoft Defender for Endpoint? 注册免费试用版。
注意
如果你是美国政府客户,请使用美国政府客户Microsoft Defender for Endpoint中列出的 URI。
提示
为了提高性能,可以使用离地理位置更近的服务器:
- us.api.security.microsoft.com
- eu.api.security.microsoft.com
- uk.api.security.microsoft.com
- au.api.security.microsoft.com
- swa.api.security.microsoft.com
- ina.api.security.microsoft.com
API 说明
在设备上启动Microsoft Defender防病毒扫描。
限制
- 此 API 的速率限制是每分钟 100 个调用和每小时 1500 个调用。
注意
本页重点介绍如何通过 API 执行计算机作。 有关通过Microsoft Defender for Endpoint响应作功能的详细信息,请参阅在计算机上执行响应作。
重要
- 此作适用于 Windows 10 版本 1709 或更高版本以及 Windows 11 上的设备。
- 无论Microsoft Defender防病毒是否是活动防病毒解决方案,Microsoft Defender防病毒扫描都可以与其他防病毒解决方案一起运行。 Microsoft Defender防病毒可以处于被动模式。 有关详细信息,请参阅Microsoft Defender防病毒兼容性。
权限
要调用此 API,需要以下权限之一。 若要了解详细信息(包括如何选择权限),请参阅使用Microsoft Defender for Endpoint API
权限类型 | 权限 | 权限显示名称 |
---|---|---|
应用程序 | Machine.Scan | “扫描计算机” |
委派(工作或学校帐户) | Machine.Scan | “扫描计算机” |
注意
使用用户凭据获取令牌时:
Defender for Endpoint 计划 1 和计划 2 支持创建设备组。
HTTP 请求
POST https://api.security.microsoft.com/api/machines/{id}/runAntiVirusScan
请求标头
名称 | 类型 | 说明 |
---|---|---|
Authorization | String | 持有者 {token}。 必需。 |
Content-Type | string | application/json |
请求正文
在请求正文中,提供具有以下参数的 JSON 对象:
参数 | 类型 | 说明 |
---|---|---|
评论 | 字符串 | 要与作关联的注释。 必需。 |
ScanType | String | 定义扫描的类型。 必需。 |
ScanType 控制要执行的扫描类型,可以是以下选项之一:
- 快速:在设备上执行快速扫描
- 完整:在设备上执行完全扫描
响应
如果成功,此方法在响应正文中返回 201、Created 响应代码和 MachineAction 对象。
如果发送多个 API 调用来为同一设备运行防病毒扫描,则会返回“挂起的计算机作”或 HTTP 400,并显示消息“作已在进行中”。
示例
请求
下面是一个请求示例。
POST https://api.security.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/runAntiVirusScan
{
"Comment": "Check machine for viruses due to alert 3212",
"ScanType": "Full"
}
提示
想要了解更多信息? Engage技术社区中的Microsoft安全社区:Microsoft Defender for Endpoint技术社区。