本文档介绍了如何创建推送订阅。您可以使用 Google Cloud 控制台、Google Cloud CLI、客户端库或 Pub/Sub API 创建推送订阅。
准备工作
所需的角色和权限
如需创建订阅,您必须在 项目级别。如果您的订阅 和主题属于不同的项目,如本部分稍后所述。
如需获取创建推送订阅所需的权限,
请让管理员授予您
项目的 Pub/Sub Editor (roles/pubsub.editor
) IAM 角色。
如需详细了解如何授予角色,请参阅管理访问权限。
此预定义角色包含 创建推送订阅所需的权限。如需查看所需的确切权限,请展开所需权限部分:
所需权限
创建推送订阅需要以下权限:
-
创建订阅:
pubsub.subscriptions.create
-
删除订阅:
pubsub.subscriptions.delete
-
获取订阅:
pubsub.subscriptions.get
-
列出订阅:
pubsub.subscriptions.list
-
更新订阅:
pubsub.subscriptions.update
-
将订阅附加到主题:
pubsub.topics.attachSubscription
-
获取订阅的 IAM 政策:
pubsub.subscriptions.getIamPolicy
-
为订阅配置 IAM 政策:
pubsub.subscriptions.setIamPolicy
如果您需要创建推送
一个项目中的订阅与另一个项目中的主题关联
项目,请让主题管理员也授予您 Pub/Sub Editor
(roles/pubsub.editor)
IAM 角色。
推送订阅属性
配置推送订阅时,您可以指定以下内容 属性。
通用属性
了解常见的订阅属性 您可以为所有订阅设置此折扣
端点
端点网址(必填)。可公开访问的 HTTPS 地址。用于推送的服务器 端点必须具有由证书授权机构签名的有效 SSL 证书。 Pub/Sub 服务会将同一 Google Cloud 地区中的消息传送至 Pub/Sub 服务存储消息所在的推送端点。Pub/Sub 服务会尽最大努力传送来自同一 Google Cloud 地区的消息。
Pub/Sub 不再要求提供所有权证明才能推送 订阅网址网域。如果您的网域收到意外的 POST 请求 您可以举报疑似滥用行为。
身份验证
启用身份验证。启用后,Pub/Sub 传送到推送端点的消息将包含授权标头, 允许端点对请求进行身份验证自动身份验证和 授权机制适用于订阅所属项目内托管的 App Engine 标准环境和 Cloud Functions 端点。
身份验证配置 由用户代管式服务账号、 以及用来创建细分受众群的受众群体参数 在 create 中指定, patch 或 ModifyPushConfig 调用。您还必须向服务代理授予特定角色,如 下一部分。
代管式服务账号(必需)。与推送关联的服务账号 订阅。此账号将用作生成的 JSON Web 令牌 (JWT) 的
email
声明。 下面列出了服务账号的要求:此服务账号必须与推送订阅位于同一项目中。
创建或修改推送订阅的主账号必须 拥有该服务账号的
iam.serviceAccounts.actAs
权限。 您可以针对项目、文件夹、 或组织),以允许 来模拟多个服务账号或授予具有此角色的角色 针对该服务的权限 账号来允许来电者 仅模拟此服务账号。
受众群体:一个不区分大小写的字符串 用于验证此特定令牌的目标受众群体。
服务代理(必需)。
Pub/Sub 自动为您创建服务账号 格式为
service-{PROJECT_NUMBER}@gcp-sa-pubsub.iam.gserviceaccount.com
。必须为此服务代理授予
iam.serviceAccounts.getOpenIdToken
权限(包含在roles/iam.serviceAccountTokenCreator
角色)以允许 Pub/Sub 为其创建 JWT 令牌 进行身份验证的推送请求
载荷解封
启用载荷解封 (Enable payload unwrapping) 选项会剥离 Pub/Sub 所有消息元数据(消息数据除外)的消息。含载荷 解封装,则消息数据将作为 HTTP 正文直接传送。
- 写入元数据。将之前移除的邮件元数据添加回 请求标头。
VPC Service Controls
对于受以下项保护的项目: VPC Service Controls, 请注意推送订阅存在以下限制:
您只能创建推送端点为 设置为具有默认
run.app
网址或 Workflows 执行。自定义网域不起作用。通过 Eventarc 将事件路由到 Workflows 时 将推送端点设置为 Workflows 的目标 则只能通过 Eventarc 创建新的推送订阅。
您无法更新现有推送订阅。这些推送订阅 尽管它们不受 VPC Service Controls 保护,但仍继续正常运行。
创建推送订阅
以下示例演示了如何使用推送创建订阅 投放订单项。
默认情况下,订阅使用 拉取传送 如以下示例中所示,除非您明确设置了推送配置。
控制台
如需创建推送订阅,请完成以下步骤:
- 在 Google Cloud 控制台中,前往订阅页面。
- 点击创建订阅。
- 对于订阅 ID 字段,输入名称。
如需了解如何命名订阅,请参阅主题或订阅命名准则。
- 从下拉菜单中选择或创建一个主题。订阅将接收来自该主题的消息。
- 选择传送类型作为推送。
- 指定端点网址。
- 保留所有其他默认值。
- 点击创建。
您还可以通过主题部分创建订阅。此快捷方式可帮助您将主题与订阅关联。
gcloud
-
In the Google Cloud console, activate Cloud Shell.
At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.
-
如需创建推送订阅,请运行
gcloud pubsub subscriptions create
命令。gcloud pubsub subscriptions create SUBSCRIPTION_ID \ --topic=TOPIC_ID \ --push-endpoint=PUSH_ENDPOINT
替换以下内容:
SUBSCRIPTION_ID
:新推送的名称或 ID 订阅。TOPIC_ID
:主题的名称或 ID。- PUSH_ENDPOINT:要用作此订阅端点的网址。
例如
https://myproject.appspot.com/myhandler
。
REST
如需创建推送订阅,请使用
projects.subscriptions.create
方法:
请求:
必须使用 Authorization
标头中的访问令牌对请求进行身份验证。如需获取当前应用默认凭据的访问令牌,请运行以下命令:gcloud auth application-default print-access-token。
PUT https://pubsub.googleapis.com/v1/projects/PROJECT_ID/subscriptions/SUBSCRIPTION_ID Authorization: Bearer ACCESS_TOKEN
请求正文:
{ "topic": "projects/PROJECT_ID/topics/TOPIC_ID", // Only needed if you are using push delivery "pushConfig": { "pushEndpoint": "PUSH_ENDPOINT" } }
其中:
https://myproject.appspot.com/myhandler
。响应:
{ "name": "projects/PROJECT_ID/subscriptions/SUBSCRIPTION_ID", "topic": "projects/PROJECT_ID/topics/TOPIC_ID", "pushConfig": { "pushEndpoint": "https://PROJECT_ID.appspot.com/myhandler", "attributes": { "x-goog-version": "v1" } }, "ackDeadlineSeconds": 10, "messageRetentionDuration": "604800s", "expirationPolicy": { "ttl": "2678400s" } }
C++
在尝试此示例之前,请按照《快速入门:使用客户端库》中的 C++ 设置说明进行操作。如需了解详情,请参阅 Pub/Sub C++ API 参考文档。
C#
在尝试此示例之前,请按照C# Pub/Sub 快速入门: 客户端库。 有关详情,请参阅 Pub/Sub C# API 参考文档。
如需向 Pub/Sub 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为客户端库设置身份验证。
Go
在尝试此示例之前,请按照Go Pub/Sub 快速入门: 客户端库。 有关详情,请参阅 Pub/Sub Go API 参考文档。
如需向 Pub/Sub 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为客户端库设置身份验证。
Java
在尝试此示例之前,请按照Java Pub/Sub 快速入门: 客户端库。 有关详情,请参阅 Pub/Sub Java API 参考文档。
如需向 Pub/Sub 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为客户端库设置身份验证。
Node.js
Node.js
PHP
在尝试此示例之前,请按照PHP Pub/Sub 快速入门: 客户端库。 有关详情,请参阅 Pub/Sub PHP API 参考文档。
如需向 Pub/Sub 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为客户端库设置身份验证。
Python
在尝试此示例之前,请按照Python Pub/Sub 快速入门: 客户端库。 有关详情,请参阅 Pub/Sub Python API 参考文档。
如需向 Pub/Sub 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为客户端库设置身份验证。
Ruby
在尝试此示例之前,请按照Ruby Pub/Sub 快速入门: 客户端库。 有关详情,请参阅 Pub/Sub Ruby API 参考文档。
如需向 Pub/Sub 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为客户端库设置身份验证。