“调用 REST 端点”任务

通过调用 REST 端点任务,您可以从集成调用任何第三方 REST API。REST API 调用返回的响应将以集成变量的形式向您提供,您可以在其他下游任务中使用该变量。

准备工作

  • 如需连接到 REST API 调用的身份验证端点,请确保已创建 OAuth 2.0 配置文件将用户管理的服务账号关联到您的集成。如果您的 API 不需要进行身份验证,则任务配置窗格中的身份验证配置文件字段可以留空。要查看配置列表,请参阅配置属性

    如果您的集成同时配置了 OAuth 2.0 配置文件和用户管理的服务账号,则默认使用 OAuth 2.0 配置文件进行身份验证。如果 OAuth 2.0 配置文件和用户管理的服务账号均未配置,则执行将失败。

  • 如果您的集成关联了服务账号,则根据 REST 端点网址向该服务账号授予所需的 IAM 角色。例如,如果您的 REST 端点网址调用 Cloud Storage 服务,则为 Cloud Storage 服务授予所需的 IAM 角色。

    如需了解如何向服务账号授予角色,请参阅管理对服务账号的访问权限

  • 确保在 Google Cloud 项目中为 Apigee Integration 设置 VPC Service Controls

配置“调用 REST 端点”任务

如需配置调用 REST 端点任务,请执行以下操作:

  1. Apigee 界面中,选择您的 Apigee 组织
  2. 点击开发 > 集成
  3. 选择现有集成,或通过点击创建集成来创建新集成。

    要创建新的集成,请执行以下操作:

    1. 创建 Integrations对话框中输入名称和说明。
    2. 从支持的区域列表中选择集成的区域
    3. 点击创建

    这将在集成设计器中打开集成。

  4. 集成设计器导航栏中,点击 + 添加任务/触发器 > 任务以查看可用任务列表。
  5. 点击调用 REST 端点元素,并将其放置到集成编辑器中。
  6. 点击设计器上的调用 REST 端点元素,以查看调用 REST 端点任务配置窗格。
  7. 使用任务的配置属性配置显示的字段,详见下表。

    系统会自动保存对属性的更改。

配置属性

下表介绍了调用 REST 端点任务的配置属性。

属性 数据类型 说明
标签 字符串 可选:为任务添加标签。
Authentication 字符串 可选:配置和存储与外部系统连接的身份验证详细信息。如需了解详情,请参阅在 Apigee Integration 中创建身份验证配置文件
端点基准网址 字符串 没有查询参数的 REST 端点网址。
HTTP 方法 要使用的 HTTP 方法。

您可以选择以下任意一种 HTTP 方法:

  • DELETE
  • GET
  • HEAD
  • PATCH
  • POST
  • PUT
网址查询字符串参数 查询字符串键 - 字符串

值 - 字符串

进行 REST API 调用所需的查询参数。

查询参数采用键值对形式,其中键是键名称,值是相应的键值。您可以通过点击加号图标输入多个键值对。

HTTP 标头 HTTP 标头键 - 字符串

值 - 字符串

进行 REST API 调用所需的 HTTP 标头。

HTTP 标头采用键值对形式,其中键是键名称,值是相应的键值。您可以通过点击加号图标输入多个键值对。

遵循重定向 布尔值 遵循网址重定向。

您可以选择以下任意一个值:

  • True:如果端点基准网址已转发到另一个网址,则调用重定向网址。
  • False:如果端点基准网址已转发到其他网址,请勿调用重定向网址。
任务应在出现 HTTP 错误时失败 布尔值 REST API 调用失败时的异常处理策略。 如果 HTTP 响应代码为 4xx5xx,则调用 REST 端点会失败。如需查看错误代码列表,请参阅错误代码。对于其他 HTTP 响应代码,会在响应中返回错误代码和错误消息。

您可以选择以下任意一个值:

  • True:抛出异常。
  • False:不抛出异常。但会在响应中返回错误代码和错误消息。
响应标头(<任务名称>) 字符串 REST API 响应中未压缩的响应标头。
响应正文(<任务名称>) 字符串 REST API 响应中未压缩的响应正文。
响应状态(<任务名称>) 字符串 REST API 响应中的 HTTP 响应代码和相应代码文本。

最佳做法

如需了解适用于调用 REST 端点任务的用量限额,请参阅用量限额

错误处理策略

任务的错误处理策略指定当任务因暂时性错误而失败时要执行的操作。如需了解如何使用错误处理策略,以及了解不同类型的错误处理策略,请参阅错误处理策略

如需了解如何为 4xx5xx 错误处理重试策略,请参阅如何基于响应状态重试 REST 调用方任务博客。