開始以非同步的方式，取消長時間執行的作業。伺服器會盡全力取消作業，但不保證一定會成功。如果伺服器不支援這個方法，就會傳回 google.rpc.Code.UNIMPLEMENTED。用戶端可以使用 Operations.GetOperation 或其他方法，查看作業是否已成功取消，或是作業即使在用戶端下令取消之後仍然執行完畢。作業在成功取消之後，並不會遭到刪除，而是會成為擁有 Operation.error 值，且 google.rpc.Status.code 為 1 (也就是 Code.CANCELLED) 的作業。
HTTP 要求
POST https://firestore.googleapis.com/v1/{name=projects/*/databases/*/operations/*}:cancel
這個網址使用 gRPC 轉碼語法。
路徑參數
| 參數 | |
|---|---|
name |
指出要取消的作業資源名稱。 |
要求主體
要求主體必須為空白。
回應主體
如果成功，回應主體會是空白的。
授權範圍
需要下列其中一種 OAuth 範圍：
https://www.googleapis.com/auth/datastorehttps://www.googleapis.com/auth/cloud-platform
詳情請參閱驗證總覽。