你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

中止复制文件

Abort Copy File 操作取消挂起 Copy File 的操作,并将目标文件保留为零长度和完整元数据。 此操作适用于版本 2015-02-21 及更新版本。

协议可用性

已启用文件共享协议 可用
SMB 是
NFS 否

请求

可以按如下所示构造 Abort Copy File 请求。 建议使用 HTTPS。

从版本 2013-08-15 开始,如果目标文件与源文件位于同一帐户中,则可以为其指定共享访问签名。 从版本 2015-04-05 开始,如果目标文件位于其他存储帐户中,还可以指定共享访问签名。

方法 请求 URI HTTP 版本
PUT https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=copy&copyid=<id> HTTP/1.1

将请求 URI 中所示的路径组件替换为你自己的组件,如下所示:

路径组件 说明
myaccount 存储帐户的名称。
myshare 文件共享的名称。
mydirectorypath 可选。 父目录的路径。
myfile 文件的名称。

有关路径命名限制的详细信息,请参阅 命名和引用共享、目录、文件和元数据

URI 参数

可以在请求 URI 上指定以下附加参数。

参数 说明
timeout 可选。 超时参数以秒表示。 有关详细信息,请参阅设置Azure 文件存储操作的超时

请求标头

下表介绍必需的和可选的请求标头。

请求标头 说明
Authorization 必需。 指定授权方案、帐户名称和签名。 有关详细信息,请参阅授权对 Azure 存储的请求
Datex-ms-date 必需。 指定请求的协调世界时 (UTC)。 有关详细信息,请参阅授权对 Azure 存储的请求
x-ms-version 对于所有已授权的请求是必需的。 指定用于此请求的操作的版本。 此操作仅在版本 2015-02-21 及更高版本中可用。

有关详细信息,请参阅 Azure 存储服务的版本控制
x-ms-copy-action:abort 必需。
x-ms-lease-id:<ID> 如果目标文件具有活动租约,则为必需。 适用于版本 2019-02-02 及更高版本。
x-ms-client-request-id 可选。 提供客户端生成的不透明值,其中包含 1 kibite (KiB) 配置日志记录时记录在日志中的字符限制。 强烈建议使用此标头将客户端活动与服务器接收的请求相关联。 有关详细信息,请参阅监视Azure 文件存储
x-ms-file-request-intent 如果 Authorization 标头指定 OAuth 令牌,则为必需。 可接受的值为 backup。 此标头指定Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/actionMicrosoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action如果或包含在分配给使用 标头授权的标识的 RBAC 策略中,则应授予 或 Authorization 。 适用于版本 2022-11-02 及更高版本。
x-ms-allow-trailing-dot: { <Boolean> } 可选。 版本 2022-11-02 及更高版本。 布尔值指定是否应剪裁请求 URL 中存在的尾随点。 有关详细信息,请参阅 命名和引用共享、目录、文件和元数据

请求正文

无。

响应

响应包括 HTTP 状态代码和一组响应标头。

状态代码

成功的操作将返回状态代码 204(无内容)。 有关状态代码的信息,请参阅 状态和错误代码

响应标头

此操作的响应包括以下标头。 响应还包含其他标准 HTTP 标头。 所有标准标头都符合 HTTP/1.1 协议规范。

响应标头 说明
x-ms-request-id 此标头唯一标识发出的请求,可用于对请求进行故障排除。
x-ms-version 指示用于运行请求Azure 文件存储的版本。
Datex-ms-date 指示启动响应的时间的 UTC 日期/时间值。 服务生成此值。
x-ms-client-request-id 可以使用此标头对请求和相应的响应进行故障排除。 如果请求中存在,则此标头的值等于 标头的值 x-ms-client-request-id 。 该值最多为 1024 个可见 ASCII 字符。 x-ms-client-request-id如果请求中不存在标头,则响应中不会显示此标头。

响应正文

无。

授权

只有帐户所有者才能调用此操作。

注解

取消挂起 Copy File 的操作时,目标文件的 x-ms-copy-status 标头设置为 aborted。 取消复制操作会导致目标文件长度为零。 但是,目标文件的元数据将具有从源 Blob 或文件复制的新值,或者在操作调用中 Copy File 显式设置。

只能取消挂起的复制操作。 尝试取消已完成或失败的副本会导致冲突错误。 尝试使用不正确的复制 ID 取消复制操作也会导致冲突错误。