Method: projects.locations.jobs.cancel

指定されたプロジェクトのバッチジョブをキャンセルします。

IAM 権限:

プロジェクトに対する storagebatchoperations.jobs.cancel IAM 権限が必要です。

HTTP リクエスト

POST https://storagebatchoperations.googleapis.com/v1/{name=projects/*/locations/global/jobs/*}:cancel

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。キャンセルするジョブの name。

形式: projects/{projectId}/locations/global/jobs/{jobId}。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "requestId": string
}
フィールド
requestId

string

省略可。リクエストの一意の識別子。リクエストの再試行が必要な場合は、リクエスト ID を指定します。60 分以内に同じ ID でリクエストを再試行すると、元のリクエストがすでに完了している場合、サーバーはリクエストを無視します。

たとえば、最初のリクエストがタイムアウトし、同じリクエスト ID を使用してリクエストを再試行すると、サーバーは元のリクエストを認識し、新しいリクエストは処理されません。

リクエスト ID は有効な UUID でなければなりません。ゼロ UUID（00000000-0000-0000-0000-000000000000）は使用できません。

レスポンスの本文

成功すると、レスポンスの本文は空になります。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。