メソッド: operations.cancel

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

HTTP リクエスト

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

この URL は Google API HTTP アノテーション構文を使用します。

パスパラメータ

パラメータ
name

string

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

リクエストの本文

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

レスポンスの本文

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

承認

以下のいずれかの OAuth スコープを設定する必要があります。

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

詳細は、Auth ガイドを参照してください。

試してみましょう

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...