Invoke-WebRequest

语法

Invoke-WebRequest
      [-UseBasicParsing]
      [-Uri] <Uri>
      [-WebSession <WebRequestSession>]
      [-SessionVariable <String>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-CertificateThumbprint <String>]
      [-Certificate <X509Certificate>]
      [-UserAgent <String>]
      [-DisableKeepAlive]
      [-TimeoutSec <Int32>]
      [-Headers <IDictionary>]
      [-MaximumRedirection <Int32>]
      [-Method <WebRequestMethod>]
      [-Proxy <Uri>]
      [-ProxyCredential <PSCredential>]
      [-ProxyUseDefaultCredentials]
      [-Body <Object>]
      [-ContentType <String>]
      [-TransferEncoding <String>]
      [-InFile <String>]
      [-OutFile <String>]
      [-PassThru]
      [<CommonParameters>]

说明

cmdlet Invoke-WebRequest 将 HTTP、HTTPS、FTP 和 FILE 请求发送到网页或 Web 服务。 它将分析该响应并返回表单、链接、图像和其他重要的 HTML 元素的集合。

此 cmdlet 是在 Windows PowerShell 3.0 中引入的。

示例

示例 1：发送 Web 请求

此命令使用 Invoke-WebRequest cmdlet 将 Web 请求发送到 Bing.com 站点。

$R = Invoke-WebRequest -URI https://www.bing.com?q=how+many+feet+in+a+mile
$R.AllElements | Where-Object {
    $_.name -like "* Value" -and $_.tagName -eq "INPUT"
} | Select-Object Name, Value

name       value
----       -----
From Value 1
To Value   5280

第一个命令发出请求并将响应保存在 变量中 $R 。

第二个命令筛选 AllElements 属性中的对象，其中 name 属性类似于“* Value”， tagName 为“INPUT”。 筛选的结果通过管道传递到 Select-Object 以选择名称和值属性。

示例 2：使用有状态 Web 服务

此示例演示如何将 Invoke-WebRequest cmdlet 与有状态 Web 服务（如 Facebook）一起使用。

$R = Invoke-WebRequest https://www.facebook.com/login.php -SessionVariable fb
# This command stores the first form in the Forms property of the $R variable in the $Form variable.
$Form = $R.Forms[0]
# This command shows the fields available in the Form.
$Form.fields

Key                     Value
---                     -----
...
email
pass
...

# These commands populate the username and password of the respective Form fields.
$Form.Fields["email"]="User01@Fabrikam.com"
$Form.Fields["pass"]="P@ssw0rd"
# This command creates the Uri that will be used to log in to facebook.
# The value of the Uri parameter is the value of the Action property of the form.
$Uri = "https://www.facebook.com" + $Form.Action
# Now the Invoke-WebRequest cmdlet is used to sign into the Facebook web service.
# The WebRequestSession object in the $FB variable is passed as the value of the WebSession parameter.
# The value of the Body parameter is the hash table in the Fields property of the form.
# The value of the *Method* parameter is POST. The command saves the output in the $R variable.
$R = Invoke-WebRequest -Uri $Uri -WebSession $FB -Method POST -Body $Form.Fields
$R.StatusDescription

第一个命令使用 Invoke-WebRequest cmdlet 发送登录请求。 命令为 SessionVariable 参数的值指定值“FB”，并将结果保存在 变量中 $R 。 命令完成后， $R 变量包含 HtmlWebResponseObject ， $FB 变量包含 WebRequestSession 对象。

cmdlet Invoke-WebRequest 登录到 facebook 后，变量中 $R Web 响应对象的 StatusDescription 属性指示用户已成功登录。

示例 3：从网页获取链接

此命令将获取网页中的链接。

(Invoke-WebRequest -Uri "https://devblogs.microsoft.com/powershell/").Links.Href

cmdlet Invoke-WebRequest 获取网页内容。 然后，返回的 HtmlWebResponseObject 的 Links 属性用于显示每个链接的 Href 属性。

示例 4：从 Invoke-WebRequest 捕获非成功消息

当遇到不成功的 HTTP 消息 (404、500 等 ) 时 Invoke-WebRequest ，它将不返回任何输出并引发终止错误。 若要捕获错误并查看 StatusCode ，可以将执行包含在 块中 try/catch 。 以下示例演示如何完成此操作。

try
{
    $response = Invoke-WebRequest -Uri "www.microsoft.com/unkownhost" -ErrorAction Stop
    # This will only execute if the Invoke-WebRequest is successful.
    $StatusCode = $Response.StatusCode
}
catch
{
    $StatusCode = $_.Exception.Response.StatusCode.value__
}
$StatusCode

404

第一个命令调用 Invoke-WebRequestErrorAction 为 Stop，这会强制 Invoke-WebRequest 对任何失败的请求引发终止错误。 终止错误由 catch 块捕获，该块从 Exception 对象中检索 StatusCode。

参数

-Body

-Certificate

-CertificateThumbprint

-ContentType

-Credential

-DisableKeepAlive

-Headers

-InFile

-MaximumRedirection

-Method

-OutFile

-PassThru

-Proxy

-ProxyCredential

-ProxyUseDefaultCredentials

-SessionVariable

-TimeoutSec

-TransferEncoding

-Uri

-UseBasicParsing

-UseDefaultCredentials

-UserAgent

-WebSession

输入

Object

可以通过管道将 Web 请求的正文传递给 Invoke-WebRequest。

输出

HtmlWebResponseObject

相关链接

• Invoke-RestMethod
• ConvertFrom-Json
• ConvertTo-Json