長時間実行オペレーションの非同期キャンセルを開始します。サーバーはオペレーションをキャンセルするために最善の努力を行いますが、成功は保証されません。このメソッドがサーバーでサポートされていない場合は、サーバーから google.rpc.Code.UNIMPLEMENTED
が返されます。クライアントは Operations.GetOperation
などのメソッドを使用して、キャンセルが成功したか、あるいはキャンセルしたにもかかわらずオペレーションが完了したかを確認できます。キャンセルが成功した場合、オペレーションは削除されず、オペレーションの Operation.error
値に格納される google.rpc.Status.code
が 1 になります。これは、Code.CANCELLED
に相当します。
HTTP リクエスト
POST https://redis.googleapis.com/v1beta1/{name=projects/*/locations/*/operations/*}:cancel
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
name |
キャンセルするオペレーション リソースの名前。 |
リクエストの本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文は空になります。
承認スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/cloud-platform
詳細については、認証の概要をご覧ください。