Cloud Tasks キューに HTTP ターゲット タスクを追加する

Cloud Tasks キューに HTTP ターゲット タスクを追加する

このクイックスタートでは、Cloud Tasks API を使用して HTTP ターゲット タスクを Cloud Tasks キューに追加する方法について説明します。

始める前に

Google Cloud アカウントにログインします。 Google Cloudを初めて使用する場合は、 アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。
Google Cloud CLI をインストールします。
外部 ID プロバイダ（IdP）を使用している場合は、まず連携 ID を使用して gcloud CLI にログインする必要があります。
gcloud CLI を初期化するには、次のコマンドを実行します。
gcloud init
Google Cloud プロジェクトを作成または選択します。
プロジェクトの選択または作成に必要なロール
• プロジェクトを選択する: プロジェクトの選択に特定の IAM ロールは必要ありません。ロールが付与されているプロジェクトであれば、どのプロジェクトでも選択できます。
• プロジェクトを作成する: プロジェクトを作成するには、resourcemanager.projects.create 権限を含むプロジェクト作成者ロール（roles/resourcemanager.projectCreator）が必要です。ロールを付与する方法を確認する。
注: この手順で作成するリソースをそのまま保持する予定でない場合、既存のプロジェクトを選択するのではなく、新しいプロジェクトを作成してください。チュートリアルの終了後にそのプロジェクトを削除すれば、プロジェクトに関連するすべてのリソースを削除できます。
• Google Cloud プロジェクトを作成します。

  gcloud projects create PROJECT_ID

  PROJECT_ID は、作成する Google Cloud プロジェクトの名前に置き換えます。

• 作成した Google Cloud プロジェクトを選択します。

  gcloud config set project PROJECT_ID

  PROJECT_ID は、 Google Cloud プロジェクトの名前に置き換えます。
Google Cloud プロジェクトに対して課金が有効になっていることを確認します。
Cloud Tasks API を有効にします。
API を有効にするために必要なロール
API を有効にするには、serviceusage.services.enable 権限を含む Service Usage 管理者 IAM ロール（roles/serviceusage.serviceUsageAdmin）が必要です。ロールを付与する方法を確認する。
gcloud services enable cloudtasks.googleapis.com
ローカルシェルを使用している場合は、ユーザー アカウントのローカル認証情報を作成します。
gcloud auth application-default login
Cloud Shell を使用している場合は、この操作を行う必要はありません。
認証エラーが返され、外部 ID プロバイダ（IdP）を使用している場合は、 連携 ID を使用して gcloud CLI にログインしていることを確認します。
ユーザー アカウントにロールを付与します。次の IAM ロールごとに次のコマンドを 1 回実行します。 roles/cloudtasks.admin, roles/logging.viewer
gcloud projects add-iam-policy-binding PROJECT_ID --member="user:USER_IDENTIFIER" --role=ROLE
次のように置き換えます。
• PROJECT_ID: プロジェクト ID。
• USER_IDENTIFIER: ユーザー アカウントの識別子。例: [e-mail]
• ROLE: ユーザー アカウントに付与する IAM ロール。

Google Cloud CLI をインストールします。

外部 ID プロバイダ（IdP）を使用している場合は、まず連携 ID を使用して gcloud CLI にログインする必要があります。

gcloud CLI を初期化するには、次のコマンドを実行します。

gcloud init

Google Cloud プロジェクトを作成または選択します。

プロジェクトの選択または作成に必要なロール

• プロジェクトを選択する: プロジェクトの選択に特定の IAM ロールは必要ありません。ロールが付与されているプロジェクトであれば、どのプロジェクトでも選択できます。
• プロジェクトを作成する: プロジェクトを作成するには、resourcemanager.projects.create 権限を含むプロジェクト作成者ロール（roles/resourcemanager.projectCreator）が必要です。ロールを付与する方法を確認する。

注: この手順で作成するリソースをそのまま保持する予定でない場合、既存のプロジェクトを選択するのではなく、新しいプロジェクトを作成してください。チュートリアルの終了後にそのプロジェクトを削除すれば、プロジェクトに関連するすべてのリソースを削除できます。

• Google Cloud プロジェクトを作成します。

  gcloud projects create PROJECT_ID

  PROJECT_ID は、作成する Google Cloud プロジェクトの名前に置き換えます。

• 作成した Google Cloud プロジェクトを選択します。

  gcloud config set project PROJECT_ID

  PROJECT_ID は、 Google Cloud プロジェクトの名前に置き換えます。

Google Cloud プロジェクトに対して課金が有効になっていることを確認します。

Cloud Tasks API を有効にします。

API を有効にするために必要なロール

API を有効にするには、serviceusage.services.enable 権限を含む Service Usage 管理者 IAM ロール（roles/serviceusage.serviceUsageAdmin）が必要です。ロールを付与する方法を確認する。

gcloud services enable cloudtasks.googleapis.com

ローカルシェルを使用している場合は、ユーザー アカウントのローカル認証情報を作成します。

gcloud auth application-default login

Cloud Shell を使用している場合は、この操作を行う必要はありません。

認証エラーが返され、外部 ID プロバイダ（IdP）を使用している場合は、 連携 ID を使用して gcloud CLI にログインしていることを確認します。

ユーザー アカウントにロールを付与します。次の IAM ロールごとに次のコマンドを 1 回実行します。 roles/cloudtasks.admin, roles/logging.viewer

gcloud projects add-iam-policy-binding PROJECT_ID --member="user:USER_IDENTIFIER" --role=ROLE

次のように置き換えます。

• PROJECT_ID: プロジェクト ID。
• USER_IDENTIFIER: ユーザー アカウントの識別子。例: [e-mail]
• ROLE: ユーザー アカウントに付与する IAM ロール。

Cloud Tasks キューを作成する

gcloud tasks queues create コマンドを使用してキューを作成します。

注意: Cloud Tasks gcloud キュー管理の手法と、queue.yaml/queue.xml のアップロードに基づく手法を同時に使用することにはリスクが伴います。詳細については、キュー管理または queue.yaml の使用をご覧ください。

1. ターミナルで、すべてのオペレーションをロギングするキューを作成します。

   gcloud tasks queues create QUEUE_NAME \
       --log-sampling-ratio=1.0 \
       --location=REGION
   

   以下を置き換えます。

   • QUEUE_NAME: Cloud Tasks キューの名前
   • REGION: サービスまたはアプリをデプロイしたサポート対象リージョン

2. キューが初期化されたら、キューが正常に作成されたことを確認します。

   gcloud tasks queues describe QUEUE_NAME \
       --location=REGION
   

   出力例を以下に示します。

    name: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_NAME
    rateLimits:
      maxBurstSize: 100
      maxConcurrentDispatches: 1000
      maxDispatchesPerSecond: 500.0
    retryConfig:
      maxAttempts: 100
      maxBackoff: 3600s
      maxDoublings: 16
      minBackoff: 0.100s
    state: RUNNING
   

Cloud Tasks キューにタスクを追加する

gcloud tasks create-http-task コマンドを使用して、HTTP エンドポイントをターゲットとするタスクを作成し、タスクをキューに追加します。

1. タスクを作成して作成したキューに追加し、そのタスクを HTTP エンドポイントに配信します。

   gcloud tasks create-http-task \
       --queue=QUEUE_NAME \
       --url=URL_PATH \
       --method=GET \
       --location=REGION \
       --project=PROJECT_ID
   

   URL_PATH は、リクエストの送信先となる完全な URL パスに置き換えます。パスは http:// または https:// で始まる必要があります（例: https://www.example.com）。

   注: Cloud Run サービスまたは関数をターゲットにするには、そのデフォルトの run.app URL を使用します。

2. ログを読んで、タスクが正常に実行されたことを確認します。

   gcloud logging read --limit=3
   

   ログは次のようになります。

   jsonPayload:
   '@type': type.googleapis.com/google.cloud.tasks.logging.v1.TaskActivityLog
   task: projects/PROJECT_ID/locations/REGION/queues/QUEUE_NAME/tasks/TASK_ID
   taskCreationLog:
      scheduleTime: '2024-07-04T19:00:27.801837Z'
      status: OK
      targetAddress: GET https://www.example.com/
      targetType: HTTP
   

クリーンアップ

このページで使用したリソースについて、 Google Cloud アカウントに課金されないようにするには、リソースを含む Google Cloud プロジェクトを削除します。

注意: プロジェクトを削除すると、次のような影響があります。

• プロジェクト内のすべてのものが削除されます。既存のプロジェクトを使用してこのドキュメントのタスクを行った場合、そのプロジェクトを削除すると、プロジェクト内で行った他の作業もすべて削除されます。
• カスタム プロジェクト ID が失われます。このプロジェクトを作成したときに、将来使用するカスタム プロジェクト ID を作成した可能性があります。そのプロジェクト ID を使用した URL（例: appspot.com）を保持するには、プロジェクト全体ではなく、プロジェクト内の選択したリソースだけを削除します。

複数のアーキテクチャ、チュートリアル、クイックスタートを実施する予定がある場合は、プロジェクトを再利用すると、プロジェクトの割り当て上限を超えないようにすることができます。

Google Cloud プロジェクトを削除します。

gcloud projects delete PROJECT_ID

または、Cloud Tasks キューを削除することもできます。

gcloud tasks queues delete QUEUE_NAME \
    --location=REGION

次のステップ

• キューとタスクの管理
• Cloud Tasks キューを作成する
• RPC API リファレンス
• REST API リファレンス