内置命令

Invoke-RestMethod 命令

调用 Web API 并将响应内容转换为 PowerShell 对象。

适用版本／范围: PowerShell version and module availability vary; check the installed systemEnglish

语法

Invoke-RestMethod [-Uri] <uri> [-Method <WebRequestMethod>]

此处为常用语法摘要，并非全部参数集。请在当前安装版本运行 Get-Command Invoke-RestMethod -Syntax 和 Get-Help Invoke-RestMethod -Full，查看完整语法与参数元数据。通用参数及 -WhatIf/-Confirm 是否可用取决于命令和 PowerShell 版本。

用法示例

调用 Web API 并将响应内容转换为 PowerShell 对象。

Invoke-RestMethod -Uri https://api.example.com/status

查看当前已安装模块提供的参数集和完整帮助。

Get-Help Invoke-RestMethod -Full

参数、选项与子句

参数 / 子句	说明
`-Uri <uri>`	指定 API 端点。
`-Method <method>`	选择 HTTP 方法。
`-Body <object>`	按 API 预期格式提供请求数据。
`-ContentType <type>`	设置请求内容类型。
`-Headers <hashtable>`	添加认证或其他请求标头。
`-Verbose`	向详细信息流输出更多诊断信息。
`-Debug`	向调试信息流输出消息。
`-ErrorAction <action>`	控制如何处理非终止错误。
`-ErrorVariable <name>`	将错误记录保存到变量。
`-WarningAction <action>`	控制如何处理警告。
`-WarningVariable <name>`	将警告消息保存到变量。
`-InformationAction <action>`	控制如何处理信息消息。
`-InformationVariable <name>`	将信息消息保存到变量。
`-OutVariable <name>`	将输出保存到变量，同时继续传递。
`-OutBuffer <count>`	设置向下游命令传递前收集的对象数量。
`-PipelineVariable <name>`	处理管道时将当前对象保存到变量。
`-ProgressAction <action>`	在支持此参数的版本中控制进度信息。
`-WhatIf / -Confirm`	仅支持 ShouldProcess 的命令提供的风险控制参数。

PowerShell 相关参考

PowerShell common parameters ↗

安全提示

执行前请核对命令和目标路径。修改文件、服务、账户、磁盘、权限或数据库的操作可能难以撤销；建议先在安全环境测试并保留备份。

参考文档 ↗返回目录