PowerShell Invoke-WebRequest在catch块无法获取API错误详情的问题咨询

Invoke-WebRequest遇到HTTP非成功状态码时抛出的WebException，仅会存储HTTP响应的元数据（状态码、响应头、内容长度等），不会自动加载响应体内容。你之前不加try/catch时看到的完整错误，是PowerShell控制台自动读取响应流、把内容拼接在错误输出里的效果；进入catch块后，没有主动读取响应流的话，就只能拿到通用的元数据，拿不到API返回的业务错误JSON。

在catch块中手动读取异常携带的响应流，即可拿到API返回的原始错误文本，具体实现逻辑如下：

• 给调用Invoke-WebRequest的语句加-ErrorAction Stop，确保HTTP错误会触发catch块（默认HTTP错误属于非终止错误，不会进入catch）
• 从$_.Exception.Response拿到HTTP响应对象，通过流读取器读取全量响应内容
• 反序列化JSON响应，直接提取需要的业务错误字段

完整示例代码：

try {
    $Offboarduri = "对应机器的offboard API地址"
    $Headers = @{
        "Authorization" = "Bearer 你的访问令牌"
        "Content-Type"  = "application/json"
    }
    # 必须加 -ErrorAction Stop 让HTTP错误触发catch
    $offboardActionResponse = Invoke-WebRequest -Uri $Offboarduri -Headers $Headers -Method Post -ErrorAction Stop
}
catch {
    $httpResponse = $_.Exception.Response
    # 适配PowerShell 5.1版本的流读取逻辑
    $responseStream = $httpResponse.GetResponseStream()
    $streamReader = New-Object System.IO.StreamReader($responseStream, [System.Text.Encoding]::UTF8)
    $rawApiError = $streamReader.ReadToEnd()
    $streamReader.Dispose()
    $responseStream.Dispose()

    # 反序列化API返回的错误JSON
    $errorPayload = $rawApiError | ConvertFrom-Json

    # 输出结构化的错误信息
    Write-Host "--- 请求失败详情 ---"
    Write-Host "HTTP状态码：$([int]$httpResponse.StatusCode) $($httpResponse.StatusDescription)"
    Write-Host "业务错误码：$($errorPayload.error.code)"
    Write-Host "业务错误描述：$($errorPayload.error.message)"
}

运行到已存在同类型请求的场景时，catch块的输出会和你之前控制台直接看到的内容完全一致：

--- 请求失败详情 ---
HTTP状态码：400 Bad Request
业务错误码：ActiveRequestAlreadyExists
业务错误描述：Action is already in progress

• 必须给Invoke-WebRequest加-ErrorAction Stop参数：默认配置下HTTP错误属于非终止错误，不会触发catch块，你之前未加try/catch时看到的完整错误输出，是PowerShell控制台自动处理非终止错误的结果。
• 不要试图从$_.Exception.Message里找API返回的错误内容：这个字段是.NET内置生成的通用提示，固定为“The remote server returned an error: (400) Bad Request”，永远不会包含API返回的业务错误信息。
• 适配PowerShell版本的读取逻辑：
• PowerShell 5.1中异常携带的Response是HttpWebResponse类型，需要手动通过流读取器获取响应内容
• PowerShell 7及以上版本中异常携带的Response是HttpResponseMessage类型，可直接调用$_.Exception.Response.Content.ReadAsStringAsync().Result拿到原始响应文本，不需要手动操作流对象
• 读取响应流时必须手动指定UTF8编码：Microsoft Defender ATP API默认返回UTF8编码的JSON，使用本地默认编码读取可能出现乱码。
• 流对象读取完成后要及时释放，避免不必要的资源占用。

内容的提问来源于stack exchange，提问作者LinkOps