从 URL 放置页面

Put Page From URL 作将一系列页写入页 blob,其中内容是从 URL 读取的。 此 API 从版本 2018-11-09 开始提供。

请求

可以按如下所示构造 Put Page From URL 请求。 建议使用 HTTPS。 将 myaccount 替换为存储帐户的名称:

PUT 方法请求 URI HTTP 版本
https://myaccount.blob.core.windows.net/mycontainer/myblob?comp=page HTTP/1.1

模拟存储服务 URI

对模拟存储服务发出请求时,请将模拟器主机名和 Blob 服务端口指定为 127.0.0.1:10000,后跟模拟的存储帐户名称:

PUT 方法请求 URI HTTP 版本
http://127.0.0.1:10000/devstoreaccount1/mycontainer/myblob?comp=page HTTP/1.1

有关详细信息,请参阅 使用 Azurite 模拟器进行本地 Azure 存储开发

URI 参数

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

参数 DESCRIPTION
timeout 可选。 timeout 参数以秒为单位表示。 有关详细信息,请参阅 设置 Blob 服务操作的超时

请求标头

下表描述了必需和可选的请求标头:

请求标头 DESCRIPTION
Authorization 必填。 指定授权方案、帐户名称和签名。 有关详细信息,请参阅 授权对 Azure 存储的请求。
Datex-ms-date 必填。 指定请求的协调世界时(UTC)。 有关详细信息,请参阅 授权对 Azure 存储的请求。
x-ms-version 所有授权请求都是必需的。 指定要用于此请求的操作的版本。 有关详细信息,请参阅 Azure 存储服务的版本控制
Range Rangex-ms-range 是必需的。

指定要写入页面的字节范围。 必须指定范围的开始和结尾。 此标头由 HTTP/1.1 协议规范定义。

对于页面更新作,页面范围最大为 4 MiB。

由于页面必须与 512 字节边界对齐,因此起始偏移量必须为 512 的模数,结束偏移量必须为 512 – 1 的模数。 有效字节范围的示例包括 0-511、512-1023 等。

Blob 服务只接受标头的 Range 单个字节范围,并且必须按以下格式指定字节范围: bytes=startByte-endByte

如果同时指定了 Rangex-ms-range,则服务将使用 x-ms-range的值。 有关详细信息,请参阅 指定 Blob 服务作的范围标头
x-ms-range Rangex-ms-range 是必需的。

指定要写入页面的字节范围。 必须指定范围的开始和结尾。 此标头由 HTTP/1.1 协议规范定义。

页面范围最大为 4 MiB。

由于页面必须与 512 字节边界对齐,因此起始偏移量必须为 512 的模数,结束偏移量必须为 512 – 1 的模数。 有效字节范围的示例包括 0-511、512-1023 等。

Blob 服务只接受标头的 x-ms-range 单个字节范围,并且必须按以下格式指定字节范围: bytes=startByte-endByte

如果同时指定了 Rangex-ms-range,则服务将使用 x-ms-range的值。 有关详细信息,请参阅 指定 Blob 服务作的范围标头
Content-Length 必填。 指定在请求正文中传输的字节数。 此标头的值必须设置为零。 当长度不为零时,作将失败,状态代码为 400 (Bad Request)。
x-ms-copy-source:name 必填。 指定源 blob 的 URL。 该值可以是长度不超过 2 KiB 的 URL,用于指定 blob。 该值应采用 URL 编码,因为它将显示在请求 URI 中。 源 blob 必须是公共的,或者必须通过共享访问签名进行授权。 如果源 blob 是公共的,则无需授权即可执行该作。 下面是源对象 URL 的一些示例:

- https://myaccount.blob.core.windows.net/mycontainer/myblob
- https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=<DateTime>
- https://myaccount.blob.core.windows.net/mycontainer/myblob?versionid=<DateTime>
x-ms-copy-source-authorization: <scheme> <signature> 可选。 指定副本源的授权方案和签名。 有关详细信息,请参阅 授权对 Azure 存储的请求。
Microsoft Entra 仅支持方案持有者。
版本 2020-10-02 及更高版本中支持此标头。
x-ms-source-range 在指定范围内的源 URL 中上传 blob 的字节数。 必须指定范围的开始和结尾。 此标头由 HTTP/1.1 协议规范定义。

页面范围最大为 4 MiB。

Blob 服务只接受标头的 x-ms-source-range 单个字节范围,并且必须按以下格式指定字节范围: bytes=startByte-endByte

有关详细信息,请参阅 为 Blob 服务作指定范围标头
x-ms-source-content-md5 可选。 URI 中页面内容的 MD5 哈希值。 此哈希用于在从 URI 传输数据期间验证页面的完整性。 指定此标头后,存储服务会将从 copy-source 到达的内容的哈希值与此标头值进行比较。

注意:此 MD5 哈希值不与 blob 一起存储。

如果两个哈希不匹配,则作将失败,错误代码为 400 (Bad Request)。
x-ms-source-content-crc64 可选。 来自 URI 的页面内容的 CRC64 哈希值。 此哈希用于在从 URI 传输数据期间验证页面的完整性。 指定此标头后,存储服务会将从 copy-source 到达的内容的哈希值与此标头值进行比较。

注意:此 CRC64 哈希值不与 blob 一起存储。

如果两个哈希不匹配,则作将失败,错误代码为 400 (Bad Request)。

如果同时 x-ms-source-content-md5 存在 和 x-ms-source-content-crc64 标头,则请求将失败,并显示 400 (Bad Request)。

版本 2019-02-02 及更高版本中支持此标头。
x-ms-lease-id:<ID> 如果 Blob 具有活动租约,则为必需。 若要对具有活动租约的 blob 执行此作,请为此标头指定有效的租约 ID。
x-ms-if-sequence-number-le: <num> 可选。 如果 blob 的序列号小于或等于指定值,则请求将继续。 否则,它将失败,并显示 SequenceNumberConditionNotMet 错误(HTTP 状态代码 412 – 前提条件失败)。
x-ms-if-sequence-number-lt: <num> 可选。 如果 blob 的序列号小于指定值,则请求将继续。 否则,它将失败,并显示 SequenceNumberConditionNotMet 错误(HTTP 状态代码 412 – 前提条件失败)。
x-ms-if-sequence-number-eq: <num> 可选。 如果 blob 的序列号等于指定值,则请求将继续。 否则,它将失败,并显示 SequenceNumberConditionNotMet 错误(HTTP 状态代码 412 – 前提条件失败)。
If-Modified-Since 可选。 一个 DateTime 值。 指定此条件标头,以便仅在 blob 自指定日期/时间以来被修改时写入页面。 如果尚未修改 Blob,则 Blob 服务将返回状态代码 412(前提条件失败)。
If-Unmodified-Since 可选。 一个 DateTime 值。 指定此条件标头,以便仅在 blob 自指定日期/时间以来未修改时写入页面。 如果 blob 已被修改,则 Blob 服务将返回状态代码 412(不满足前提条件)。
If-Match 可选。 ETag 值。 为此条件标头指定 ETag 值,以便仅在 blob 的 ETag 值与指定的值匹配时写入页面。 如果值不匹配,则 Blob 服务将返回状态代码 412 (Precondition Failed)。
If-None-Match 可选。 ETag 值。

为此条件标头指定 ETag 值,以便仅在 blob 的 ETag 值与指定的值不匹配时写入页面。 如果值相同,Blob 服务将返回状态代码 412(前置条件失败)。
x-ms-encryption-scope 可选。 指示用于加密源内容的加密范围。 版本 2019-02-02 及更高版本中支持此标头。
x-ms-client-request-id 可选。 提供客户端生成的不透明值,该值具有配置日志记录时日志中记录的 1-kibibyte (KiB) 字符限制。 强烈建议使用此标头将客户端活动与服务器接收的请求相关联。 有关详细信息,请参阅 监视 Azure Blob 存储
x-ms-file-request-intent 如果 x-ms-copy-source header 是 Azure 文件 URL,则 x-ms-copy-source-authorization 为 Required,并且 header 指定 OAuth 令牌。 可接受的值为 backup。 此标头指定,如果 Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/actionMicrosoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action 包含在分配给使用 x-ms-copy-source-authorization 标头授权的标识的 RBAC 策略中,则应授予 Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action。 适用于版本 2025-07-05 及更高版本。

此操作还支持仅在满足指定条件时使用条件标头来执行该操作。 有关详细信息,请参阅 为 Blob 服务操作指定条件标头

请求标头(客户提供的加密密钥)

从版本 2019-02-02 开始,可以在请求中指定以下标头,以加密使用客户提供的密钥加密的 blob。 使用客户提供的密钥(和相应的标头集)进行加密是可选的。

请求标头 DESCRIPTION
x-ms-encryption-key 必填。 Base64 编码的 AES-256 加密密钥。
x-ms-encryption-key-sha256 必填。 加密密钥的 Base64 编码 SHA256 哈希。
x-ms-encryption-algorithm: AES256 必填。 指定要用于加密的算法。 此标头的值必须为 AES256

请求主体

请求正文包含页面的内容。

示例请求

  
Request Syntax:  
PUT https://myaccount.blob.core.windows.net/mycontainer/myblob?comp=page HTTP/1.1  
  
Request Headers:   
x-ms-date: Fri, 16 Sep 2011 22:15:50 GMT  
x-ms-version: 2018-11-09  
x-ms-range: bytes=0-65535  
x-ms-copy-source: https://myaccount.blob.core.windows.net/mycontainer/myblob
x-ms-source-range: bytes=0-65535
Authorization: SharedKey myaccount:4KdWDiTdA9HmIF9+WF/8WfYOpUrFhieGIT7f0av+GEI=  
Content-Length: 0  
  

响应

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

状态代码

成功的操作返回状态代码 201(已创建)。

有关状态代码的详细信息,请参阅 状态和错误代码

响应标头

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

语法 DESCRIPTION
ETag blob 的 ETag。 如果请求版本为 2011-08-18 及以上,则 ETag 值用引号括起来。 ETag 可用于通过为 If-Match or If-None-Match 请求标头指定其值来执行条件Put Page From URL作。
Last-Modified 上次修改 blob 的日期和时间。 日期格式遵循 RFC 1123。 有关详细信息,请参阅 表示标头中的日期/时间值。

对 blob 执行的任何写入作(包括对 blob 元数据或属性的更新)都会更改 blob 的上次修改时间。
Content-MD5 返回以便客户端可以检查消息内容完整性。 此标头的值由 Blob 服务计算。 它不一定与请求标头中指定的值相同。 对于版本 2019-02-02 或更高版本,仅当请求具有此标头时,才会返回此标头。
x-ms-content-crc64 适用于版本 2019-02-02 或更高版本。 返回以便客户端可以检查消息内容完整性。 此标头的值由 Blob 服务计算。 它不一定与请求标头中指定的值相同。

当请求中不存在 header 时 x-ms-source-content-md5 ,将返回此 header。
x-ms-blob-sequence-number 页 Blob 的当前序列号。
x-ms-request-id 唯一标识已发出的请求,并可用于对请求进行故障排除。 有关详细信息,请参阅 API 操作疑难解答
x-ms-version 指示用于执行请求的 Blob 服务版本。 对于针对版本 2009-09-19 及更高版本发出的请求,将返回此标头。
Date 由服务生成的 UTC 日期/时间值,该值指示启动响应的时间。
x-ms-request-server-encrypted: true/false 版本 2015-12-11 及更高版本。 此标头的值设置为 true 是否使用指定的算法成功加密了请求的内容,否则 false
x-ms-encryption-key-sha256 版本 2019-02-02 及更高版本。 如果请求使用客户提供的密钥进行加密,则返回此密钥,以便客户端可以确保使用提供的密钥成功加密请求的内容。
x-ms-encryption-scope 版本 2019-02-02 及更高版本。 如果请求使用了加密范围,则返回 Token,因此客户端可以确保使用加密范围成功加密请求的内容。
x-ms-client-request-id 可用于对请求和相应的响应进行故障排除。 如果此标头存在于请求中,则此标头的值等于 x-ms-client-request-id 标头的值,并且该值包含不超过 1,024 个可见 ASCII 字符。 如果请求中不存在 x-ms-client-request-id 标头,则响应中不会显示该标头。

响应体

没有。

示例响应

Response Status:  
HTTP/1.1 201 Created  
  
Response Headers:  
Transfer-Encoding: chunked  
x-ms-content-crc64: 77uWZTolTHU  
Date: Sun, 25 Sep 2011 22:33:35 GMT  
ETag: "0x8CB171BA9E94B0B"  
Last-Modified: Sun, 25 Sep 2011 12:13:31 GMT  
x-ms-version: 2011-08-18  
x-ms-blob-sequence-number: 0  
Content-Length: 0  
Server: Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0  
  

授权

在 Azure 存储中调用任何数据访问操作时,需要授权。 可以按如下所述授权 Put Page From URL 操作。

重要

Microsoft建议将 Microsoft Entra ID 与托管标识配合使用来授权对 Azure 存储的请求。 与共享密钥授权相比,Microsoft Entra ID 提供更高的安全性和易用性。

Azure 存储支持使用 Microsoft Entra ID 来授权请求 Blob 数据。 使用 Microsoft Entra ID,可以使用 Azure 基于角色的访问控制(Azure RBAC)向安全主体授予权限。 安全主体可以是用户、组、应用程序服务主体或 Azure 托管标识。 安全主体由 Microsoft Entra ID 进行身份验证,以返回 OAuth 2.0 令牌。 然后可以使用令牌来授权对 Blob 服务发出请求。

若要详细了解如何使用 Microsoft Entra ID 进行授权,请参阅 使用 Microsoft Entra ID授予对 blob 的访问权限。

权限

下面列出了Microsoft Entra 用户、组、托管标识或服务主体调用 Put Page From URL 操作所需的 RBAC 操作,以及包含此操作的最小特权内置 Azure RBAC 角色:

若要详细了解如何使用 Azure RBAC 分配角色,请参阅 分配 Azure 角色以访问 blob 数据

注解

Put Page From URL 作将一系列页写入页 blob。 只能在现有页 blob 上调用此作。 不能调用它来创建新的页 blob,也不能在块 blob 上调用它。 使用当前不存在的 blob 名称进行调用 Put Page From URL 将返回 BlobNotFound 错误(HTTP 状态代码 404 – 未找到)。

在版本 2020-10-02 及更高版本中,复制作的源支持Microsoft Entra 授权。

若要创建新的页 blob,请调用 Put Blob 并指定要创建为页 blob 的 blob 类型。 页 blob 的大小最大为 8 TiB。

如果 blob 具有活动租约,则客户端必须在请求上指定有效的租约 ID 才能写入页面。

页面更新作

调用 (Calling Put Page From URL ) 对指定的页 blob 执行就地写入作。 指定页面中的任何内容都将被更新覆盖。

重要

如果服务器超时或您的连接在 期间 Put Page From URL关闭,则页面可能已更新,也可能未更新。 因此,您应该继续重试更新,直到收到指示成功的响应。

为更新作提交的 Put Page From URL 每个页面范围的大小最大为 4 MiB。 页面的开始和结束范围必须与 512 字节边界对齐。 如果您尝试上传大于 4 MiB 的页面范围,则服务将返回状态代码 413(请求实体太大)。

管理并发问题

Blob 服务按顺序处理对重叠页的并发写入。 也就是说,服务处理的最后一页将确定 blob 的内容。 因此,为了确保 blob 内容的完整性,客户端应使用以下一种或多种方法处理对重叠页面的写入:

  • 您可以检查每次成功调用 的Put Page From URL响应Last-Modified标头的值。 从 Blob 服务返回的响应顺序不一定与服务执行响应的顺序相对应。 但值 Last-Modified always 指示服务处理请求的顺序。

  • 您可以使用乐观并发根据 blob 的 ETag 或上次修改时间有条件地执行更新。 如果并发写入的数量相对较低,则此方法效果很好。 为此,请使用条件请求标头 If-MatchIf-None-MatchIf-Modified-SinceIf-Unmodified-Since

  • 可以调用 Lease Blob 以将 blob 锁定一分钟,以防止其他写入,如果续订租约,则锁定 blob 的时间更长。

  • 您可以使用 blob 的序列号来确保重试没有响应的请求不会导致并发更新。 此方法可能最适合需要高吞吐量进行页面写入的客户端。 下一节将详细介绍它。

使用页 blob 序列号重试请求

当对 的 Put Page From URL 调用超时或未返回响应时,无法确定请求是否成功。 因此,您需要重试该请求,但由于 Azure 存储服务的分布式特性,因此在重试请求成功后,可能会处理原始请求。 延迟的原始请求可能会覆盖其他更新并产生意外结果。 以下序列说明了这是如何发生的:

  1. Put Page From URL将值 “X” 写入页面 0 的请求超时或未返回响应。

  2. 将值 “X” 写入页面 0 的重试请求成功。

  3. 将值 “Y” 写入第 0 页的请求成功。

  4. 原始请求成功,将值 “X” 写入第 0 页。

  5. 读取第 0 页返回值 “X”,而客户端此时期望值 “Y”。

当原始请求未返回介于 100-499 或 503 (Server Busy) 之间的状态代码时,可能会发生此类冲突。 如果返回这些状态代码之一,则可以确定请求是成功还是失败。 但是,如果服务返回的状态代码超出此范围,则无法知道原始请求的状态。

为了防止此类冲突,可以使用页 blob 的序列号来确保在重试请求时,原始请求随后不会成功。 为此,您应该在重试原始请求之前递增序列号。 然后,您可以使用条件序列号标头来确保如果请求的序列号与预期的序列号不匹配,则请求将失败。 以下序列说明了此方法:

  1. 客户端使用 Put Blob 创建页 blob,并将其序列号设置为 0。

  2. Put Page From URL将值 “X” 写入页面 0 的请求,if-sequence-number-lt并将标头设置为1超时或不返回响应。

  3. 客户端调用 Set Blob Properties 将序列号更新为 1。

  4. 将值 “X” 写入页面 0 并 if-sequence-number-lt 设置为 2 succeed 的重试请求。

  5. 将值 “Y” 写入第 0 页并 if-sequence-number-lt 设置为 2 succeed 的请求。

  6. 原始请求最终得到处理,但失败,因为它指定了序列号必须小于 1 的条件(即, if-sequence-num-lt 标头设置为 1)。 错误为 SequenceNumberConditionNotMet(HTTP 状态代码 412 – 前提条件失败)。

  7. 读取第 0 页将返回预期值 “Y”。

另请参阅

授权对 Azure 存储 的请求
状态和错误代码
设置 Blob 服务作的超时