Method: transferOperations.cancel

取消转移。使用 transferOperations.get 方法检查取消操作是否成功,或者操作是否在 cancel 请求后完成。

取消操作后,当前正在运行的传输会中断。对于周期性转移作业,转移作业的下一个实例仍会运行。例如,如果您的作业配置为每天下午 1 点运行,而您在下午 1:05 取消了周一的操作,则周一的转移将停止。不过,系统仍会在周二尝试执行转移作业。

这仅适用于当前正在运行的操作。如果当前没有运行任何操作,cancel 不会执行任何操作。

取消作业后,下一个作业会计算文件的增量,并可能会修复任何不一致的状态。例如,如果您每天运行一个作业,并且今天的作业在您取消作业之前找到了 10 个新文件并转移了 5 个文件,那么明天的传输操作将根据今天未复制的 5 个文件以及明天发现的所有新文件计算出新的增量。

HTTP 请求

POST https://storagetransfer.googleapis.com/v1/{name=transferOperations/**}:cancel

网址采用 gRPC 转码语法。

路径参数

参数
name

string

要取消的操作资源的名称。

请求正文

请求正文必须为空。

响应正文

如果成功,响应正文将为空的 JSON 对象。

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅 Authentication Overview