Pub/Sub

借助 Cloud Pub/Sub 连接器,您可以对 Google Cloud Pub/Sub 数据执行插入、删除、更新和读取操作。

准备工作

在使用 Pub/Sub 连接器之前,请先完成以下任务:

  • 在您的 Google Cloud 项目中:
    • 将 IAM 角色 roles/connectors.admin 授予该用户 配置连接器。
    • 将以下 IAM 角色授予您要用其来使用连接器的服务账号:
      • roles/pubsub.publisher

      服务账号是一种特殊类型的 Google 账号,用于表示需要验证身份并获得授权以访问 Google API 数据的非人类用户。如果您没有服务账号,则必须创建一个服务账号。如需了解详情,请参阅创建服务账号

    • 启用以下服务:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      如需了解如何启用服务,请参阅启用服务

    如果之前没有为您的项目启用这些服务或权限,则在您配置连接器时,系统会提示您启用。

配置连接器

配置连接器时,您需要创建与数据源(即后端系统)的连接。一个连接需专用于一个数据源。这意味着,如果您有许多数据源,则必须为每个数据源创建单独的连接。如需创建连接,请执行以下步骤:

  1. Cloud 控制台 中,进入 Integration Connectors > 连接页面,然后选择或创建一个 Google Cloud 项目。

    转到“连接”页面

  2. 点击 + 新建以打开创建连接页面。
  3. 位置部分中,选择连接的位置。
    1. 区域:从下拉列表中选择一个位置。

      如需查看所有受支持区域的列表,请参阅位置

    2. 点击下一步
  4. 连接详情部分中,完成以下操作:
    1. 连接器:从可用连接器的下拉列表中选择 Pub/Sub
    2. 连接器版本:从可用版本的下拉列表中选择一个连接器版本。
    3. 连接名称字段中,输入连接实例的名称。

      连接名称必须符合以下条件:

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头,以字母或数字结尾。
      • 连接名称不能超过 49 个字符。
    4. (可选)输入连接实例的说明
    5. (可选)启用 Cloud Logging。 然后选择一个日志级别默认情况下,日志级别设置为 Error
    6. 服务账号:选择具有所需角色的服务账号。
    7. (可选)配置连接节点设置

      • 节点数下限:输入连接节点数下限。
      • 节点数上限:输入连接节点数上限。

      节点是处理事务的连接单元(或副本)。 连接处理越多事务就需要越多节点,相反,处理越少事务需要越少节点。 如需了解节点如何影响连接器价格,请参阅连接节点的价格。如果未输入任何值,则默认情况下,节点数下限设置为 2(以便提高可用性),节点数上限设置为 50。

    8. 项目 ID:Pub/Sub 实例所在的 Google Cloud 项目 ID。
    9. 主题 ID:可选,输入应在其中发布消息的 Pub/Sub 主题的名称。

      如果您未在此处指定主题名称,则可以通过在 PublishMessage 操作中配置 topic 参数,在运行时指定主题。

    10. (可选)点击 + 添加标签,以键值对的形式向连接添加标签。
    11. 点击下一步
  5. Authentication(身份验证)部分中,输入身份验证详细信息。
    1. Pub/Sub 连接不需要任何身份验证。
    2. 点击下一步
  6. 查看:查看您的连接和身份验证详细信息。
  7. 点击创建

实体、操作和动作

所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。

  • 实体:实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如,在数据库连接器中,表是实体;在文件服务器连接器中,文件夹是实体;在消息传递系统连接器中,队列是实体。

    但可能的情况是,连接器不支持或不具有任何实体,在这种情况下,Entities 列表将为空。

  • 操作:操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作:

    从可用列表中选择一个实体,系统会生成该实体可用的操作列表。如需了解操作的详细说明,请参阅连接器任务的实体操作。不过,如果连接器不支持任何实体操作,则 Operations 列表中不会列出此类不受支持的操作。

  • 动作:动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改,并且动作因连接器而异。通常,操作有一些输入参数和一个输出 参数。但可能的情况是,连接器不支持任何动作,在这种情况下,Actions 列表将为空。

系统限制

Pub/Sub 连接器每个节点每秒最多可处理 27 笔事务,并会对超出此限制的所有事务进行节流。默认情况下,Integration Connectors 会为连接分配 2 个节点(以提高可用性)。

如需了解适用于集成连接器的限制,请参阅限制

操作

本部分介绍了 Pub/Sub 连接器支持的操作。

PublishMessage 操作

此操作会向 Pub/Sub 主题发布消息。以下 表介绍了 PublishMessage 操作的输入参数。

参数名称 需要 数据类型 说明
主题 字符串 您要将消息发布到的主题的名称。
消息 字符串 您要发布的消息。消息应为字符串化 JSON,支持的消息大小上限为 10 MB。
attributes 字符串 自定义元数据(采用字符串化 JSON 格式)以键值对的形式。

消息的架构验证

在 Pub/Sub 中创建主题时,您可以选择为主题分配新主题或 现有架构如需了解详情,请参阅在 Pub/Sub 中创建和管理架构。如果您已为主题分配架构,则已发布的消息会自动 根据架构进行验证,如果消息无法与架构确认,则消息 未发布。

示例

本部分中的示例介绍了以下操作:

  • 向主题发布消息

下表列出了连接器任务中的示例场景和相应的配置:

任务 配置
向主题发布消息
  1. Configure connector task 对话框中,点击 Actions
  2. 选择 PublishMessage 操作,然后点击完成
  3. 连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 中输入类似于以下内容的值字段:
    {"message" : "This is a test message.",
    "topic":"mytopic",
    "attributes":"{\"key1\":\"value1\"}"}
  4. 点击保存

此示例将指定的 message 发布到 mytopic 主题。

运行此示例会在连接器任务的 connectorOutputPayload 输出变量中返回类似于以下内容的响应:

{"messageIds": [
"7865292560686229"]}

使用 Terraform 创建连接

您可以使用 Terraform 资源创建新的连接。

如需了解如何应用或移除 Terraform 配置,请参阅基本 Terraform 命令

如需查看用于创建连接的 Terraform 模板示例,请参阅示例模板

使用 Terraform 创建此连接时,您必须在 Terraform 配置文件中设置以下变量:

参数名称 数据类型 必需 说明
project_id STRING True Pub/Sub 实例所在的 Google Cloud 项目 ID。
topic_id STRING 错误 应在其中发布消息的 Pub/Sub 主题的名称。

在集成中使用 Pub/Sub 连接

创建连接后,该连接将在 Apigee Integration 和 Application Integration 中可用。您可以使用连接 通过连接器任务在集成中进行集成。

  • 如需了解如何在 Apigee Integration 中创建和使用连接器任务,请参阅连接器任务
  • 如需了解如何在应用集成中创建和使用连接器任务,请参阅连接器任务

向 Google Cloud 社区寻求帮助

您可以在 Google Cloud 社区的 Cloud 论坛中发布您的问题以及讨论此连接器。

后续步骤