HTTP 请求

UiPath.Web.Activities.Http.NetHttpClient

Important: This activity is available in WebAPI package versions starting with 2.0.0-preview and 2.3.0 GA. For the legacy experience, use the previous HTTP Request (legacy) activity included in WebAPI versions earlier than 2.0.0-preview.

描述

使用 WebAPI 2.0.0 预览版中的HTTP 请求活动可自动化并简化向网页服务器或 API 发出的请求。HTTP 请求活动可帮助您：

• 在系统之间安全地发送和接收数据。
• 使用表单上传文件和数据。
• 在出现问题时，通过重试请求正常处理错误。
• 使用 SSL 安全连接以保护数据。
• 自动管理 Cookie 和代理，以处理会话和网络限制。

项目兼容性

Windows | 跨平台

Windows、跨平台配置

活动主体属性
请求方法*	选择 HTTP 请求应如何与服务器交互： GET — 检索数据而不修改数据。 POST —将数据发送到服务器，通常是为了创建或更新资源。 PUT —更新现有资源。 DELETE — 从服务器删除指定资源。 HEAD — 与GET类似，但只检索标头，不检索正文内容。 选项— 提供有关服务器上可用通信选项的信息。 PATCH —部分更新现有资源。 TRACE — 用于诊断目的，将收到的请求回显给客户端。
请求 URL *	请提供要发送请求的服务器网址。例如https://store.example.com/search 。
参数	将特定于服务器的详细信息作为键值对添加到您的请求中。例如query: "laptop" 、 sortBy: "price" 。
标头	以键值对形式添加特定于服务器的说明或身份验证详细信息。例如Authorization: "Bearer <your_access_token>" 、 Accept: "application/json" 。
请求正文类型*	选择要发送到服务器的内容类型： 无 —不发送数据，通常用于检索方法。 “文本” — 以纯文本形式发送数据，通常用于 POST 和 PUT 方法。选择后，系统将显示以下字段： 文本内容类型— 选择要在 HTTP 请求中发送的文本的格式，以便服务器知道如何解释它： text/纯文本— 常规纯文本。 text/html — HTML 格式的文本。 text/css — CSS 格式的文本。 text/csv — 格式化为 CSV 的结构化数据。 text/xml — XML 格式的文本，供人类阅读。 application/xml — XML 格式的文本，供应用程序处理。 application/json — JSON 格式的文本。 文本— 写入要在请求中发送的实际文本或数据。 文本编码— 选择文本有效负载的编码格式，例如 Unicode、ASCII 或 ISO。这可确保接收服务器准确读取您的文本有效负载。 已编码的表单 URL — 发送格式化为简单键值对的数据。选择后，系统将显示以下字段： URL 编码的表单数据— 提供键值对。例如， searchQuery: "Smartphone" 、 brand: "XYZ" 、 inStock: "true" 。 多部分表单数据— 发送文件或复杂数据。当您需要将不同的数据类型组合到请求中时，请使用它。选择后，系统将显示以下字段： 资源文件— 提供在项目中作为 IResource 对象存储的文件的名称。 “本地文件” — 提供指向您设备上某个文件的路径。例如"C:/Images/product-photo.jpg" 。 表单数据部分— 提供表单数据部分的集合 对象： 文本表单数据部分 —对于字符串有效负载，例如 JSON 或纯文本。 二进制表单数据部分— 适用于原始字节数组。 文件表单数据部分 —适用于基于给定路径的文件流。 例如，使用“表达式编辑器” 的“表单数据部件” 集合： #VB New List(Of FormDataPart) From { New TextFormDataPart("{""jsonKey"":""jsonValue""}", "textPart", Encoding.UTF8, "application/json"), New BinaryFormDataPart(Encoding.UTF8.GetBytes("binaryContent"), "binaryPart", "application/octet-stream"), New FileFormDataPart("C:/Work/testfile.txt", "filePart", "text/plain") } 每个“表单数据部件”类型都附带多个构造函数，使您可以从常用的默认值中受益。 该活动会自动为每个 文件表单数据部分 分配正确的“内容类型” 标头。您可以手动覆盖此标头。对于文件列表，无法覆盖自动分配的标头。对于资源文件列表，活动使用可用的 MIME 类型。 URL 编码的表单数据— 提供简单的键值对。 二进制— 发送原始数据。选择后，系统将显示以下字段： 二进制有效负载— 提供原始数据有效负载，例如图像、视频、大文件或流数据。例如，以二进制形式发送图像： File.ReadAllBytes("C:/Images/product-image.jpg") 流— 当数据无法完全加载到内存时，发送连续数据，例如上传大文件（音频或视频）。选择后，系统将显示以下字段： “本地文件” — 提供大文件路径，例如： File.OpenRead("C:/Videos/large-video.mp4") 此活动会自动为上传的文件分配正确的“Content-Type”标头。您可以手动覆盖此标头。

属性面板
cURL Import and design time testing This section helps you configure the activity via the cURL code snippets, and perform design time testing of the request.	cURL Command Text—Multiline design-time text field where a full cURL command can be pasted. Supports both `cm and bash styles. cURL import button—Action button that immediately triggers parsing/import of the current cURL Command Text into the activity (method, URL, headers, body, auth, files). Test request button—Action button that executes the configured request at design time. While running, it toggles to Cancel. On completion or cancellation it reverts to Test and updates Report field with formatted response or error. Report—Multiline text area used to display the outcome of the last cURL import or design-time test execution (success summary, mapping details, warnings, or errors).
客户端选项 本节帮助您定义与连接相关的设置。	禁用 SSL 验证— 跳过 SSL 安全检查。用于测试 ( True )，不建议用于生产 ( False，默认值)。 TLS 协议— 选择用于安全连接的 TLS 协议。可用选项包括“自动” （默认）、 “TLS 1.2”和“TLS 1.3” 。 “启用 cookie” — 默认情况下，启用自动 Cookie 处理（ “True” ）。设置为False可禁用自动 Cookie 处理。 客户端证书— 指示客户端证书的路径，以便使用安全 API 进行身份验证。例如"C:/certificates/client-cert.pfx" 。 客户端证书安全密码— 存储所提供客户端证书的安全密码。例如"certPassword" 。 通过选择加号图标并选择所需的选项，在明文密码和安全密码之间切换： “使用纯字符串”和“使用安全字符串” 。 代理配置— 配置自定义代理，包括支持身份验证和绕过列表。例如"http://proxy.example.com:8080" 。
身份验证 本节帮助您定义活动如何通过服务器对自身进行身份验证。	身份验证— 选择身份验证方法。可用选项包括： 未进行身份验证— 服务器不需要用户验证即可接受您的请求。 基本身份验证— 通过用户名和安全密码向接收服务器提供用户验证。 通过选择加号图标并选择所需的选项，在明文密码和安全密码之间切换： “使用纯字符串”和“使用安全字符串” 。 持有者令牌— 通过登录后生成的唯一持有者令牌向接收服务器提供用户验证。 Negotiated authentication—Use the HTTP Negotiate scheme for the runtime to select Kerberos or NTLM (and optionally Digest) based on server challenges. When Authentication is set to Negotiated authentication and Use operating system credentials = True, the current OS user context is used (Windows logon token; on Linux/macOS an existing Kerberos ticket, e.g. from kinit). Set Use operating system credentials = False to enable the Custom credentials field; supply a NetworkCredential (domain / username / password or secure password).
请求选项 本部分帮助您定义请求的行为。	“其他 Cookie” — 手动将额外的 Cookie 指定为键值对。 “请求超时” — 指定最长等待时间（以毫秒为单位），如果超出该时间后请求将中止。默认值为 10,000 毫秒（10 秒）。 出错时继续— 决定是否应在活动引发错误时继续自动化（ True ，默认选项）。要在发生错误时停止自动化，请使用False 。 遵循重定向— 决定请求是否应自动遵循服务器提供的 URL 重定向（ True ，默认选项）。要忽略重定向并使用初始响应，请使用False 。 最大重定向次数— 指定请求在停止之前应遵循的自动重定向次数。默认值为 3。
重试策略 本部分帮助您定义请求失败时的重试机制。	重试策略类型— 指定重试请求的方法。可用选项包括： “不可重试” — 您的请求仅调用服务器一次。如果失败，则不会进行进一步的尝试。 基本重试— 失败后按固定延迟时间重试请求。 重试计数— 指定重试次数。默认值为 3。 延迟— 指定每次重试之间的固定时间 (以毫秒为单位)。默认值为 500 毫秒 (0.5 秒)。 使用“之后重试”标头— 确定请求是否应使用服务器推荐的“之后重试”标头（ True ，默认选项）。要忽略“Retry-After”标头值，请使用False 。 延迟限制— 指定“重试”与“重试后”之间允许的最大延迟（以毫秒为单位）。默认值为 30,000 毫秒 (30 秒)。 重试状态代码— 指定应触发重试的状态代码。 指数退缩— 随着每次尝试之间延迟的增加而重试。 重试计数— 指定重试次数。默认值为 3。 初始延迟— 指定第一次重试之前的延迟时间（以毫秒为单位）。默认值为 500 毫秒 (0.5 秒)。 乘数— 指定用于增加每个请求失败后延迟的数字。默认值为 2，每次都会使延迟加倍。 “使用抖动” — 对于延迟，决定是否要添加 0 到 100 毫秒之间的随机偏移量，以避免同步重试（默认为“True” ）。 使用“之后重试”标头— 确定请求是否应使用服务器推荐的“之后重试”标头（ True ，默认选项）。要忽略“Retry-After”标头值，请使用False 。 延迟限制— 指定“重试”与“重试后”之间允许的最大延迟（以毫秒为单位）。默认值为 30,000 毫秒 (30 秒)。 重试状态代码— 指定应触发重试的状态代码。
Response options This section helps you customize how the response will be returned by the server.	Always save tesponse as file—Force writing the response body to disk even when an attachment filename is not inferred. Enable debugging info—Enable extended debug capture (raw request/response metadata, headers snapshot, timing, retry details) and output to the response object or during design time testing. Output file name—Override the server-provided filename (e.g. from Content-Disposition). Output file target folder—Control destination folder for the saved response files. If the file already exists—Define collision strategy when a file with the resolved name already exists in the target folder. Options: Auto rename—Append incremental suffix (_1, _2, …) to produce a unique filename. Replace—Overwrite existing file. Stop and discard— Abort the save operation (and workflow if the exception is not handled) leaving existing file intact.
输出 本节帮助您捕获和存储服务器返回的响应。	响应内容— 从服务器捕获响应并将其存储到变量中，以供日后处理。其中包括： 状态码— HTTP 响应状态代码。 文本内容— 纯文本形式的响应（如果可用）。 二进制内容— 非文本内容的原始响应数据。 文件— 将响应保存为文件 ( ILocalResource ) 在下载文件夹中。文件名来自响应标头或自动生成，以避免覆盖文件。 标头— 所有 HTTP 响应标头。 内容标头— 与响应内容明确相关的标头。例如， Content-Type和Content-Length 。 RawRequestDebuggingInfo—Optional string containing captured low-level request/response details (e.g. constructed request line, headers, retries, timing) populated only when debugging is enabled; empty string otherwise.