このページでは、Cloud Storage 用に Cloud Pub/Sub Notifications を設定して使用する方法について説明します。Google Cloud Pub/Sub Notifications では、Cloud Storage オブジェクトに関する変更内容を記録できます。Cloud Pub/Sub for Cloud Storage についての詳細は、Notifications の概念ページをご覧ください。
前提条件
gsutil
gsutil コマンドライン ツールでこの機能を使用する前に、次のように準備する必要があります。
通知を受け取るプロジェクトの Cloud Pub/Sub API を有効にすること。
モニタリングするバケットに対して十分な権限を持っていること。
バケットを含むプロジェクトを所有している場合は、必要な権限を持っていると考えられます。
IAM を使用する場合は、
storage.buckets.update権限が必要です。これを行う方法については、IAM 権限の使用をご覧ください。
通知を受け取るプロジェクトに対して十分な権限を持っていること。
通知を受け取るプロジェクトを所有している場合は、必要な権限を持っていると考えられます。
通知を受け取るトピックを作成する場合は、
pubsub.topics.create権限が必要です。新規トピックまたは既存トピックを使用する予定がある場合は、
pubsub.topics.setIamPolicy権限が必要です。トピックを作成する場合、通常はpubsub.topics.setIamPolicy権限を持っています。これらの Cloud Pub/Sub 権限を取得する方法については、Cloud Pub/Sub アクセス制御をご覧ください。
JSON API
JSON API でこの機能を使用する前に、次のように準備する必要があります。
通知を受け取るプロジェクトの Cloud Pub/Sub API を有効にすること。
モニタリングするバケットに対して十分な権限を持っていること。
バケットを含むプロジェクトを所有している場合は、必要な権限を持っていると考えられます。
IAM を使用する場合は、
storage.buckets.update権限が必要です。これを行う方法については、IAM 権限の使用をご覧ください。
通知を受け取るプロジェクトに対して十分な権限を持っていること。
通知を受け取るプロジェクトを所有している場合は、必要な権限を持っていると考えられます。
通知を受け取るトピックを作成する場合は、
pubsub.topics.create権限が必要です。新規トピックまたは既存トピックを使用する予定がある場合は、
pubsub.topics.setIamPolicy権限が必要です。トピックを作成する場合、通常はpubsub.topics.setIamPolicy権限を持っています。これらの Cloud Pub/Sub 権限を取得する方法については、Cloud Pub/Sub アクセス制御をご覧ください。
通知を送信する既存の Cloud Pub/Sub トピックを持っていること。
Cloud Storage バケットを含むプロジェクトに関連付けられているサービス アカウントのメールアドレスを取得すること。
サービス アカウントのメールアドレスを確認するには、バケットを含むプロジェクトの名前に
[PROJECT_ID]を置き換えて、次の URL にクエリを実行します。https://www.googleapis.com/storage/v1/projects/[PROJECT_ID]/serviceAccount
このクエリの結果は、次のようになります。
{ "email_address": "[PROJECT_ID]@gs-project-accounts.iam.gserviceaccount.com", "kind": "storage#serviceAccount" }前の手順で取得したメールアドレスに、任意の Cloud Pub/Sub トピックの IAM 役割
pubsub.publisherを指定します。指定する方法については、Cloud Pub/Sub アクセス制御をご覧ください。
通知設定の適用
次の手順では、すべてのサポートされているイベントの通知を送信するバケットに通知構成を追加します。サブセットのイベントの通知を送信するには、gsutil コマンドで -e フラグを付加するか、JSON リクエストの本文に event_types キーを含めます。
gsutil
gsutil notification create コマンドを使用します。[VALUES_IN_BRACKETS] は適切な値に置き換えます。
gsutil notification create -t [TOPIC_NAME] -f json gs://[BUCKET_NAME]
プロジェクトに存在しない [TOPIC_NAME] を使用すると、それが自動的に作成されます。
JSON API
OAuth 2.0 Playground から承認アクセス トークンを取得します。固有の OAuth 認証情報を使用するように Playground を構成します。
次の情報を含む .json ファイルを作成し、
[VALUES_IN_BRACKETS]を適切な値に置き換えます。{ "topic": "projects/[PROJECT_ID]/topics/[TOPIC_NAME]", "payload_format": "JSON_API_V1" }cURLを使用して、JSON API をPOST notificationConfigsリクエストで呼び出します。[VALUES_IN_BRACKETS]は適切な値に置き換えます。curl -X POST --data-binary @[JSON_FILE_NAME].json \ -H "Authorization: Bearer [OAUTH2_TOKEN]" \ -H "Content-Type: application/json" \ "https://www.googleapis.com/storage/v1/b/[BUCKET_NAME]/notificationConfigs"
バケットの通知構成の一覧表示
特定のバケットに関連付けられた通知構成を一覧表示するには:
gsutil
gsutil notification list コマンドを使用します。[VALUES_IN_BRACKETS] は適切な値に置き換えます。
gsutil notification list gs://[BUCKET_NAME]
JSON API
OAuth 2.0 Playground から承認アクセス トークンを取得します。固有の OAuth 認証情報を使用するように Playground を構成します。
cURLを使用して、JSON API をGET notificationConfigsリクエストで呼び出します。[VALUES_IN_BRACKETS]は適切な値に置き換えます。curl -X GET \ -H "Authorization: Bearer [OAUTH2_TOKEN]" \ "https://www.googleapis.com/storage/v1/b/[BUCKET_NAME]/notificationConfigs"
通知構成の削除
バケットから既存の通知構成を削除するには:
gsutil
gsutil notification delete コマンドを使用します。[VALUES_IN_BRACKETS] は適切な値に置き換えます。
gsutil notification delete projects/_/buckets/[BUCKET_NAME]/notificationConfigs/[CONFIGURATION_NAME]
送信後、通知構成によってトリガーされたすべての通知が停止するまでに最大 30 秒かかる場合があります。
JSON API
OAuth 2.0 Playground から承認アクセス トークンを取得します。固有の OAuth 認証情報を使用するように Playground を構成します。
cURLを使用して、JSON API をDELETE notificationConfigsリクエストで呼び出します。[VALUES_IN_BRACKETS]は適切な値に置き換えます。curl -X DELETE \ -H "Authorization: Bearer [OAUTH2_TOKEN]" \ "https://www.googleapis.com/storage/v1/b/[BUCKET_NAME]/notificationConfigs/[CONFIGURATION_NAME]"
送信後、通知構成によってトリガーされたすべての通知が停止するまでに最大 30 秒かかる場合があります。
次のステップ
- Pub/Sub でサブスクリプションを作成して、Cloud Storage によって送信された通知を確認する。
