Google Cloud Pub/Sub 扩展程序

<ph type="x-smartling-placeholder"></ph> 您正在查看 Apigee Edge 文档。
转到 Apigee X 文档。 信息

<ph type="x-smartling-placeholder">

版本：1.2.0

向 Google Cloud Pub/Sub 服务中的主题发布消息。

本文提供了配置和使用此扩展程序的参考信息。

前提条件

通过 API 代理使用此扩展程序之前，您必须：

  1. 按照快速入门：使用控制台中的说明创建 Cloud Pub/Sub 主题。

  2. 获得主题后，请授予发布到 Cloud Pub/Sub 主题的权限。例如，您可以使用 roles/pubsub.publisher 角色发布到主题。如需详细了解 Cloud Pub/Sub 角色，请参阅访问权限控制。

  3. 使用 GCP Console 为服务账号生成密钥。

  4. 在通过配置参考添加和配置扩展程序时，使用所生成的密钥 JSON 文件的内容。

关于 Cloud Pub/Sub

Cloud Pub/Sub 提供多对多异步消息传递，可将发送者和接收者分隔开来。Cloud Pub/Sub 的消息传递延迟低且持久，可帮助开发者快速集成托管在 Google Cloud Platform 上和外部的系统。

如果您刚开始使用 Cloud Pub/Sub，请查看 Cloud Pub/Sub 文档中的快速入门。

示例

以下示例说明了如何使用 ExtensionCallout 政策配置对 Cloud Pub/Sub 扩展程序操作的支持。

发布消息

在此示例中，publish 操作向扩展程序的配置中指定的主题发布简单消息。publish 操作会返回已发布消息所在的主题中已发布消息的 ID。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Publish-Message">
    <DisplayName>Publish Message</DisplayName>
    <Connector>cloud-pub-sub-extension-example</Connector>
    <Action>publish</Action>
    <Input><![CDATA[
      {
          "message" : "My test message."
      }
    ]]></Input>
    <Output>topic.message.id</Output>
</ConnectorCallout>

以下 Assign Message 政策使用存储扩展程序响应的变量的值来分配响应载荷。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Get-Topic-Message-ID">
    <DisplayName>Get Topic Message ID</DisplayName>
    <AssignTo type="response" createNew="false"/>
    <Set>
        <Payload contentType="application/json">{topic.message.id}</Payload>
    </Set>
</AssignMessage>

在此示例中，响应数据以 JSON 格式返回，如下所示。

{"messageId":"165918654986954"}

操作

<ph type="x-smartling-placeholder">

publish

向此扩展程序的配置中指定的主题发布消息。

语法

<Action>publish</Action>
<Input><![CDATA[{
  "message" : "message-to-publish"
}]]></Input>

示例

<Action>publish</Action>
<Input><![CDATA[
  {
      "message" : "My test message."
  }
]]></Input>

请求参数

参数 说明 类型 默认 必填
消息 要发布的消息。 字符串 无。 是。

响应

包含发布到主题的消息 ID 的 JSON。例如：

{"messageId":"165918654986954"}

配置参考

在配置和部署此扩展程序以供在 API 代理中使用时，请使用以下代码。

常见的扩展属性

每个扩展程序都有以下属性。

属性 说明 默认 必需
name 您为扩展程序配置此名称。 无 是
packageName Apigee Edge 提供的扩展包的名称。 无 是
version 配置扩展程序所用的扩展程序软件包的版本号。 无 是
configuration 特定于您要添加的附加信息的配置值。请参阅此扩展程序软件包的属性 无 是

此扩展程序软件包的属性

属性 说明 默认 必填
topic 要发布到的主题。从 Pub/Sub 服务（例如该服务的 GCP 控制台）获取此值。例如，主题名称可能采用 projects/GCP-PROJECT-ID/topics/TOPIC-NAME 格式 无。 是。
credentials 在 Apigee Edge 控制台中输入时，这是服务账号密钥文件的内容。通过 Management API 发送时，此值为根据服务账号密钥文件生成的 base64 编码值。 无。 是。