常见Microsoft Defender XDR REST API 错误代码

适用于:

  • Microsoft Defender XDR

注意

使用 MS Graph 安全 API 试用我们的新 API。 有关详细信息,请查看: 使用 Microsoft Graph 安全 API - Microsoft Graph |Microsoft Learn

重要

某些信息与预发布的产品有关,在商业发布之前可能有重大修改。 Microsoft 对此处所提供的信息不作任何明示或默示的保证。

任何Microsoft Defender XDR API 上的操作都可以返回错误代码。 每个错误响应都包含一条错误消息,可帮助解决问题。 表部分中的错误消息列提供了一些示例消息。 实际消息的内容因触发响应的因素而异。 下表中的) 由尖括号 (< > 指示变量内容:

错误代码

错误代码 HTTP 状态代码 邮件
BadRequest BadRequest (400) 常规错误请求错误消息。
ODataError BadRequest (400) 指定的>特定错误的 OData URI 查询<无效。
InvalidInput BadRequest (400) 输入 <无效,输入>无效。
InvalidRequestBody BadRequest (400) 请求正文无效。
InvalidHashValue BadRequest (400) 无效哈希的哈希>值<无效。
InvalidDomainName BadRequest (400) <域名 无效域>无效。
InvalidIpAddress BadRequest (400) 无效 IP> 地址<无效。
InvalidUrl BadRequest (400) 无效 URL 无效的 URL<>。
MaximumBatchSizeExceeded BadRequest (400) 超出最大批大小。 Received: <batch size received>, allowed: {batch size allowed}。
MissingRequiredParameter BadRequest (400) 缺少 <参数> 的参数。
OsPlatformNotSupported BadRequest (400) OS 平台 <客户端 OS 平台> 不支持此操作。
ClientVersionNotSupported BadRequest (400) <客户端版本支持的客户端版本<及更高版本>支持请求的操作>。
未经授权 (Unauthorized) 未经授权的 (401) 未经授权 (Unauthorized)

此错误通常是由授权标头无效或过期导致的。
禁止访问 (Forbidden) 禁止 (403) 禁止访问 (Forbidden)

如果令牌有效,但操作权限不足,则会发生此错误
DisabledFeature 禁止 (403) 未启用租户功能。
DisallowedOperation 禁止 (403) <不允许的操作和原因>。
NotFound 找不到 (404) “常规未找到”错误消息。
ResourceNotFound 找不到 (404) <找不到请求的资源>。
InternalServerError 内部服务器错误 (500) 如果没有错误消息,请重试该操作。 如果问题未得到解决,请联系 Microsoft

示例

{
    "error": {
        "code": "ResourceNotFound",
        "message": "Machine 123123123 was not found",
        "target": "43f4cb08-8fac-4b65-9db1-745c2ae65f3a"
    }
}
{
    "error": {
        "code": "InvalidRequestBody",
        "message": "Request body is incorrect",
        "target": "1fa66c0f-18bd-4133-b378-36d76f3a2ba0"
    }
}

Body 参数

重要

正文参数区分大小写。

如果遇到 InvalidRequestBodyMissingRequiredParameter 错误,则可能是由拼写错误引起的。 查看 API 文档,检查提交的参数与相关示例匹配。

跟踪 ID

每个错误响应都包含用于跟踪的唯一 ID 参数。 此参数的属性名称是 target。 如果因错误而联系 Microsoft,则附加跟踪 ID 可帮助 Microsoft 找到问题的根本原因。

提示

想要了解更多信息? Engage技术社区中的 Microsoft 安全社区:Microsoft Defender XDR技术社区