对长时间运行的操作启动异步取消。服务器会尽全力取消操作,但不能保证一定成功。如果服务器不支持此方法,则会返回 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/datastore
https://www.googleapis.com/auth/cloud-platform
如需了解详情,请参阅身份验证概览。