Method: operations.cancel

長時間実行オペレーションの非同期キャンセルを開始します。サーバーは操作のキャンセルに全力を尽くしますが、成功は保証されません。このメソッドがサーバーでサポートされていない場合は、google.rpc.Code.UNIMPLEMENTED を返します。クライアントは Operations.GetOperation などのメソッドを使用して、キャンセルが成功したか、あるいはキャンセルしたにもかかわらずオペレーションが完了したかを確認できます。キャンセルが成功するとそのオペレーションは削除されず、google.rpc.Status.code が 1 の Operation.error 値を持つオペレーションになります。これは Code.CANCELLED に相当します。

HTTP リクエスト

POST https://runtimeconfig.googleapis.com/v1/{name=operations/**}:cancel

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

パスパラメータ

パラメータ
name

string

キャンセルするオペレーション リソースの名前。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

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

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、認証の概要をご覧ください。