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

获取阻止列表

项目
05/15/2024

Get Block List操作检索作为块 Blob 的一部分上载的块列表。

为 Blob 维护了两个阻止列表：

提交的块列表：使用放置块列表成功提交到指定 Blob 的块列表。
未提交的块列表：已使用放置块为 Blob 上传但尚未提交的块的列表。这些块与 Blob 关联存储在 Azure 中，但尚未构成 Blob 的一部分。

可以调用 Get Block List 以返回已提交的阻止列表和/或未提交的阻止列表。还可以调用此操作来检索快照的已提交阻止列表。

请求

可以按如下方式构建Get Block List请求。建议使用 HTTPS。将 myaccount 替换为存储帐户的名称：

GET 方法请求 URI	HTTP 版本
`https://myaccount.blob.core.windows.net/mycontainer/myblob?comp=blocklist` `https://myaccount.blob.core.windows.net/mycontainer/myblob?comp=blocklist&snapshot=<DateTime>` `https://myaccount.blob.core.windows.net/mycontainer/myblob?comp=blocklist&versionid=<DateTime>`	HTTP/1.1

模拟存储服务请求

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

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

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

URI 参数

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

URI 参数	说明
`snapshot`	可选。 snapshot 参数是一个不透明的 `DateTime` 值；如果存在，则指定要检索的 Blob 列表。有关使用 Blob 快照的详细信息，请参阅Create blob 的快照。
`versionid`	对于版本 2019-12-12 及更高版本可选。参数 `versionid` 是一个不透明的 `DateTime` 值，如果存在，则指定要检索的 Blob 的版本。
`blocklisttype`	指定是返回已提交的块列表，返回未提交的块列表，还是同时返回这两个列表。有效值为 `committed`、`uncommitted` 或 `all`。如果省略此参数，则`Get Block List`返回已提交的块列表。
`timeout`	可选。 `timeout` 参数以秒表示。有关详细信息，请参阅为 Blob 存储操作设置超时。

请求标头

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

请求标头	说明
`Authorization`	必需。指定授权方案、帐户名称和签名。有关详细信息，请参阅授权对 Azure 存储的请求。
`Date` 或 `x-ms-date`	必需。指定请求的协调世界时 (UTC)。有关详细信息，请参阅授权对 Azure 存储的请求。
`x-ms-version`	对于所有已授权的请求是必需的，对于匿名请求是可选的。指定用于此请求的操作的版本。有关详细信息，请参阅 Azure 存储服务的版本控制。
`x-ms-lease-id:<ID>`	可选。如果指定了此标头，只有在符合下面的两个条件时，才会执行此操作： - Blob 的租约当前处于活动状态。 - 请求中指定的租约 ID 与 Blob 的租约 ID 匹配。如果指定了此标头，并且不符合任一条件，则请求将失败，并且操作失败，状态代码为 412 (先决条件失败) 。
`x-ms-client-request-id`	可选。提供客户端生成的不透明值，其中包含 1-kiB (KiB) 配置日志记录时记录在日志中的字符限制。强烈建议使用此标头将客户端活动与服务器接收的请求相关联。有关详细信息，请参阅监视Azure Blob 存储。

此操作还支持仅当满足指定条件时才使用条件头执行操作。有关详细信息，请参阅为 Blob 存储操作指定条件标头。

请求正文

无。

示例请求

以下示例请求 URI 返回名为 MOV1.avi 的 blob 的已提交阻止列表：

GET http://myaccount.blob.core.windows.net/movies/MOV1.avi?comp=blocklist&blocklisttype=committed HTTP/1.1

以下示例请求 URI 返回已提交和未提交的阻止列表：

GET http://myaccount.blob.core.windows.net/movies/MOV1.avi?comp=blocklist&blocklisttype=all HTTP/1.1

以下示例请求 URI 返回快照的已提交阻止列表。快照仅包含已提交的块，因此没有与之关联的未提交的块。

GET http://myaccount.blob.core.windows.net/mycontainer/myblob?comp=blocklist&snapshot=2009-09-30T20%3a11%3a15.2735974Z

响应

响应包括 HTTP 状态代码、一组响应标头和一个包含块列表的响应正文。

状态代码

此操作成功后返回状态代码 200（正常）。

有关状态代码的信息，请参阅状态和错误代码。

响应头

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

响应标头	说明
`Last-Modified`	上次修改 blob 的日期/时间。日期格式遵循 RFC 1123。有关详细信息，请参阅在标头中表示日期/时间值。仅当 Blob 具有提交块时返回。修改 Blob 的任何操作将会更改 Blob 的上次修改时间，包括更新 Blob 的元数据或属性。
`ETag`	Blob 的 ETag。仅当 Blob 具有提交块时返回。
`Content-Type`	Blob 的 MIME 内容类型。默认值为 `application/xml`。
`x-ms-blob-content-length`	Blob 大小，以字节为单位。
`x-ms-request-id`	此标头唯一标识发出的请求，并可用于对请求进行故障排除。有关详细信息，请参阅 API 操作疑难解答。
`x-ms-version`	指示用于执行请求的服务版本。针对 2009-09-19 和更高版本发出的请求将返回此标头。如果使用 Blob 存储版本 2009-09-19 将容器标记为公共访问，则对于没有指定版本的匿名请求，也会返回此标头。注意：只能通过匿名请求返回已提交的阻止列表。
`Date`	由服务生成的 UTC 日期/时间值，指示启动响应的时间。
`x-ms-client-request-id`	可用于对请求和相应响应进行故障排除。如果请求中存在此标头的值，并且该值包含不超过 1,024 个可见 ASCII 字符，则此标头的值等于该标头的值 `x-ms-client-request-id` 。 `x-ms-client-request-id`如果请求中不存在标头，则响应中不存在该标头。

仅当满足指定条件时，此操作还支持使用条件标头来获取阻止列表。有关详细信息，请参阅为 Blob 存储操作指定条件标头。

响应正文

仅返回已提交的块的请求响应正文格式如下所示：

<?xml version="1.0" encoding="utf-8"?>
<BlockList>
  <CommittedBlocks>
    <Block>
      <Name>base64-encoded-block-id</Name>
      <Size>size-in-bytes</Size>
    </Block>
  <CommittedBlocks>
</BlockList>

返回已提交和未提交的块的请求响应正文格式如下所示：


<?xml version="1.0" encoding="utf-8"?>
<BlockList>
  <CommittedBlocks>
     <Block>
        <Name>base64-encoded-block-id</Name>
        <Size>size-in-bytes</Size>
     </Block>
  </CommittedBlocks>
  <UncommittedBlocks>
    <Block>
      <Name>base64-encoded-block-id</Name>
      <Size>size-in-bytes</Size>
    </Block>
  </UncommittedBlocks>
 </BlockList>

示例响应

在以下示例中，blocklisttype 参数设置为 committed，因此，仅在响应中返回 Blob 的已提交的块。

HTTP/1.1 200 OK
Transfer-Encoding: chunked
Content-Type: application/xml
Server: Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0
x-ms-request-id: 42da571d-34f4-4d3e-b53e-59a66cb36f23
Date: Sun, 25 Sep 2011 00:33:19 GMT

<?xml version="1.0" encoding="utf-8"?>
<BlockList>
  <CommittedBlocks>
    <Block>
      <Name>BlockId001</Name>
      <Size>4194304</Size>
    </Block>
    <Block>
      <Name>BlockId002</Name>
      <Size>4194304</Size>
    </Block>
  </CommittedBlocks>
</BlockList>

在此示例中，blocklisttype 参数设置为 all，因此，在响应中返回 Blob 的已提交的块和未提交的块。

HTTP/1.1 200 OK
Transfer-Encoding: chunked
Content-Type: application/xml
Server: Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0
x-ms-request-id: 42da571d-34f4-4d3e-b53e-59a66cb36f23
Date: Sun, 25 Sep 2011 00:35:56 GMT

<?xml version="1.0" encoding="utf-8"?>
<BlockList>
  <CommittedBlocks>
    <Block>
      <Name>BlockId001</Name>
      <Size>4194304</Size>
    </Block>
    <Block>
      <Name>BlockId002</Name>
      <Size>4194304</Size>
    </Block>
  </CommittedBlocks>
  <UncommittedBlocks>
    <Block>
      <Name>BlockId003</Name>
      <Size>4194304</Size>
    </Block>
    <Block>
      <Name>BlockId004</Name>
      <Size>1024000</Size>
    </Block>
  </UncommittedBlocks>
</BlockList>

在下一个示例中， blocklisttype 参数设置为 all，但 blob 尚未提交，因此 CommittedBlocks 元素为空。

HTTP/1.1 200 OK
Transfer-Encoding: chunked
Content-Type: application/xml
Server: Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0
x-ms-request-id: 42da571d-34f4-4d3e-b53e-59a66cb36f23
Date: Wed, 14 Sep 2011 00:40:22 GMT

<?xml version="1.0" encoding="utf-8"?>
<BlockList>
  <CommittedBlocks />
  <UncommittedBlocks>
    <Block>
      <Name>BlockId001</Name>
      <Size>1024</Size>
    </Block>
    <Block>
      <Name>BlockId002</Name>
      <Size>1024</Size>
    </Block>
    <Block>
      <Name>BlockId003</Name>
      <Size>1024</Size>
    </Block>
    <Block>
      <Name>BlockId004</Name>
      <Size>1024</Size>
    </Block>
  </UncommittedBlocks>
</BlockList>

授权

在 Azure 存储中调用任何数据访问操作时，都需要授权。可以授权操作， Get Block List 如下所述。

重要

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用户、组、托管标识或服务主体调用操作Get Block List所需的 RBAC 操作，以及包含此操作的最低特权内置 Azure RBAC 角色：

Azure RBAC 操作：Microsoft.Storage/storageAccounts/blobServices/containers/blobs/read
最低特权内置角色：存储 Blob 数据读取者

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

共享访问签名 (SAS) 提供对存储帐户中资源的安全委派访问。使用 SAS，可以精细控制客户端访问数据的方式。可以指定客户端可以访问的资源、它们对这些资源拥有的权限，以及 SAS 的有效期。

该 Get Block List 操作支持三种类型的共享访问签名：用户委派 SAS、服务 SAS 和帐户 SAS。

作为安全最佳做法，我们建议使用Microsoft Entra凭据而不是存储帐户密钥，这可能会更容易泄露。如果应用程序设计需要共享访问签名，请尽可能使用Microsoft Entra凭据创建用户委托 SAS。

如果存储帐户不允许共享密钥访问，则对 Blob 存储的请求不允许使用服务 SAS 令牌或帐户 SAS 令牌。若要了解详细信息，请参阅了解不允许共享密钥如何影响 SAS 令牌。

用户委托 SAS

用户委托 SAS 使用Microsoft Entra凭据以及为 SAS 指定的权限进行保护。

Get Block List使用委托给容器或 Blob 资源的 SAS 令牌调用操作需要读取 (r) 权限作为用户委派 SAS 令牌的一部分。

若要详细了解用户委托 SAS，请参阅Create用户委托 SAS。

服务 SAS

使用存储帐户密钥保护的服务 SAS。服务 SAS 委托对单个 Azure 存储服务（例如 Blob 存储）中的资源的访问权限。

Get Block List使用委托给容器或 Blob 资源的 SAS 令牌调用操作需要作为服务 SAS 令牌的一部分的读取 (r) 权限。

若要详细了解服务 SAS，请参阅Create服务 SAS。

帐户 SAS

帐户 SAS 使用存储帐户密钥进行保护。帐户 SAS 可委派对一个或多个存储服务中的资源的访问权限。通过服务或用户委托 SAS 提供的所有操作也可以通过帐户 SAS 提供。

下表指示在委派访问权限时要指定的已签名资源类型和已签名权限：

操作	已签名服务	已签名的资源类型	已签名的权限
获取阻止列表	Blob (b)	对象 (o)	读取 (r)

若要详细了解帐户 SAS，请参阅Create帐户 SAS。

注解

调用 Get Block List 以返回已提交到块 Blob 的块列表、尚未提交的块列表或两者列表。请使用 blocklisttype 参数指定要返回的块列表。已提交块列表的返回顺序与放置块列表操作提交的顺序相同。

在调用 Put Block 或 Put Block List 失败的情况下，可以使用未提交的阻止列表来确定 Blob 中缺少哪些块。未提交的块列表按字母顺序返回。如果多次上载某个块 ID，则在列表中仅显示最近上载的块。

注意

当 Blob 尚未提交时，使用 blocklisttype=all 调用 Get Block List 将返回未提交的块，并且 CommittedBlocks 元素为空。

Get Block List 读取未提交的块列表时不支持并发。对 Get Block List 的调用，其中 blocklisttype=uncommitted 或 blocklisttype=all 的最大请求速率低于其他读取操作。有关读取操作的目标吞吐量的详细信息，请参阅 Azure 存储可伸缩性和性能目标。

从版本 2019-12-12 开始，块 blob 可以包含最多 4000 mb 的块， (MiB) 。若要保护使用带符号 32 位整数表示块大小的应用程序，请在包含大于 100 MiB 的块的块 blob 上调用 Get Block List ，其 REST 版本早于 2019-12-12 会导致状态代码 409 (冲突) 。

Get Block List 仅适用于块 Blob。在页 Blob 上调用Get Block List将导致返回状态代码 400（错误的请求）。

Get Block List 存档块 Blob 将失败。

计费

定价请求可能源自使用 Blob 存储 API 的客户端，可以直接通过 Blob 存储 REST API 或 Azure 存储客户端库。这些请求按事务产生费用。事务类型会影响帐户的收费方式。例如，读取事务累算到与写入事务不同的计费类别。下表显示了基于存储帐户类型的请求的计费类别 Get Block List ：

操作	存储帐户类型	计费类别
获取阻止列表	高级块 blob 标准常规用途 v2	其他操作
获取阻止列表	标准常规用途 v1	读取操作

若要了解指定计费类别的定价，请参阅Azure Blob 存储定价。

另请参阅

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

通过