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

列出容器

  • 项目

该 List Containers 操作返回指定存储帐户下的容器列表。

请求

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

方法 请求 URI HTTP 版本
GET https://myaccount.blob.core.windows.net/?comp=list HTTP/1.1

请注意，URI 必须始终包含正斜杠 (/)，以将主机名与 URI 的路径和查询部分隔开。 在执行 List Containers 操作时，URI 的路径部分是空的。

模拟存储服务请求

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

方法 请求 URI HTTP 版本
GET http://127.0.0.1:10000/devstoreaccount1?comp=list HTTP/1.1

请注意，模拟存储仅支持最大 2 GiB 的 Blob 大小。

有关详细信息，请参阅 使用 Azurite 模拟器进行本地 Azure 存储开发 以及 存储模拟器与 Azure 存储服务之间的差异。

URI 参数

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

参数 说明
prefix 可选。 筛选结果以仅返回名称以指定前缀开头的容器。
marker 可选。 一个字符串值，该值标识要通过下一个列出操作返回的容器列表部分。 如果列出操作未返回 NextMarker 待在当前页中列出的所有剩余容器，则操作将返回响应正文中的值。 可以在 NextMarker 后续调用中使用 值作为 参数的值 marker ，以请求下一页列表项。

标记值对客户端不透明。
maxresults 可选。 指定要返回的最大容器数。 如果请求未指定 maxresults或指定大于 5000 的值，则服务器将返回最多 5000 项。

请注意，如果列表操作跨越分区边界，则服务将返回一个延续标记，用于检索其余结果。 出于此原因，服务返回的结果可能少于 指定 maxresults的结果或默认值 5000。

如果 参数设置为小于或等于零的值，则服务器将返回状态代码 400 (错误请求) 。
include={metadata,deleted,system} 可选。 指定要包含在响应中的一个或多个数据集：

-metadata：请注意，使用此参数请求的元数据必须按照 2009-09-19 版 Blob 存储所施加的命名限制进行存储。 从此版本开始，所有元数据名称都必须遵循 C# 标识符的命名约定。
-deleted：版本 2019-12-12 及更高版本。 指定响应中应包含软删除的容器。
-system：版本 2020-10-02 及更高版本。 指定是否在响应中包含系统容器。 包括此选项将列出系统容器，例如 $logs 和 $changefeed。 请注意，根据存储帐户上启用的服务功能，返回的特定系统容器会有所不同。
timeout 可选。 timeout 参数以秒表示。 有关详细信息，请参阅 设置 Blob 存储操作的超时。

请求标头

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

请求标头 说明
Authorization 必需。 指定授权方案、帐户名称和签名。 有关详细信息，请参阅授权对 Azure 存储的请求。
Date 或 x-ms-date 必需。 指定请求的协调世界时 (UTC)。 有关详细信息，请参阅授权对 Azure 存储的请求。
x-ms-version 对于所有已授权的请求是必需的。 指定用于此请求的操作的版本。 有关详细信息，请参阅 Azure 存储服务的版本控制。
x-ms-client-request-id 可选。 提供客户端生成的不透明值，其中包含 1-kiB (KiB) 配置日志记录时记录在日志中的字符限制。 强烈建议使用此标头将客户端活动与服务器接收的请求相关联。 有关详细信息，请参阅监视Azure Blob 存储。

请求正文

无。

响应

响应包括 HTTP 状态代码、一组响应标头以及采用 XML 格式的响应正文。

状态代码

此操作成功后返回状态代码 200（正常）。 有关状态代码的信息，请参阅 状态和错误代码。

响应头

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

响应标头 说明
Content-Type 标准 HTTP/1.1 标头。 指定返回的结果所采用的格式。 目前，此值为 application/xml。
x-ms-request-id 此标头唯一标识发出的请求，可用于对请求进行故障排除。 有关详细信息，请参阅 API 操作疑难解答。
x-ms-version 指示用于运行请求的 Blob 存储版本。 针对 2009-09-19 和更高版本发出的请求将返回此标头。
Date 一个 UTC 日期/时间值，该值指示启动响应的时间。 服务生成此值。
x-ms-client-request-id 可以使用此标头对请求和相应的响应进行故障排除。 如果请求中存在此标头的值，则此标头的值等于该标头的值 x-ms-client-request-id 。 该值最多为 1024 个可见 ASCII 字符。 x-ms-client-request-id如果请求中不存在标头，则响应中不会显示此标头。

响应正文

响应正文的格式如下所示。

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults ServiceEndpoint="https://myaccount.blob.core.windows.net">  
  <Prefix>string-value</Prefix>  
  <Marker>string-value</Marker>  
  <MaxResults>int-value</MaxResults>  
  <Containers>  
    <Container>  
      <Name>container-name</Name>  
      <Version>container-version</Version>
      <Deleted>true</Deleted>
      <Properties>  
        <Last-Modified>date/time-value</Last-Modified>  
        <Etag>etag</Etag>  
        <LeaseStatus>locked | unlocked</LeaseStatus>  
        <LeaseState>available | leased | expired | breaking | broken</LeaseState>  
        <LeaseDuration>infinite | fixed</LeaseDuration> 
        <PublicAccess>container | blob</PublicAccess>
        <HasImmutabilityPolicy>true | false</HasImmutabilityPolicy>
        <HasLegalHold>true | false</HasLegalHold>
        <DeletedTime>datetime</DeletedTime>
        <RemainingRetentionDays>no-of-days</RemainingRetentionDays>
      </Properties>  
      <Metadata>  
        <metadata-name>value</metadata-name>  
      </Metadata>  
    </Container>  
  </Containers>  
  <NextMarker>marker-value</NextMarker>  
</EnumerationResults>

LeaseStatus、LeaseState 和 LeaseDuration 仅适用于 2012-02-12 和更高版本。

从 2013-08-15 版本开始，AccountName 元素的 EnumerationResults 属性已重命为 ServiceEndpoint。 URL 元素也已从 Container 元素中删除。 对于 2013-08-15 之前的版本，由 URL 字段指定的容器 URL 不包括 restype=container 参数。 如果使用该值针对枚举的容器发出后续请求，请务必附加此参数以指示资源类型为容器。

PrefixMarker仅当在 URI 上指定 、 和 MaxResults 元素时，它们才存在。 NextMarker仅当列表结果不完整时， 元素才具有值。

Metadata仅当在 URI 上指定 参数时，include=metadata元素才存在。 在 Metadata 元素中，将在与每个名称-值对的名称对应的元素中列出该对的值。

如果元数据名称-值对违反了 2009-09-19 版本强制实施的命名限制，则响应正文指示元素中 x-ms-invalid-name 存在问题的名称。 以下 XML 片段演示了这一点：

  
<Metadata>  
  <MyMetadata1>first value</MyMetadata1>  
  <MyMetadata2>second value</MyMetadata2>  
  <x-ms-invalid-name>invalid-metadata-name</x-ms-invalid-name>  
</Metadata>

从 2016-05-31 版本开始，容器公共权限在 属性中 PublicAccess 提供。 它指示容器中的数据是否可以公开访问，以及访问级别。 可能的值包括：

  • container：指示对容器和 Blob 数据的完全公共读取访问权限。 客户端可以通过匿名请求枚举容器中的 Blob，但不能枚举存储帐户中的容器。
  • blob：指示对 Blob 的公共读取访问权限。 可以通过匿名请求读取此容器中的 Blob 数据，但容器数据不可用。 客户端无法通过匿名请求枚举容器中的 Blob。

如果未在 节中 <properties> 指定此属性，则容器对帐户所有者是专用的。

HasImmutabilityPolicy 和 HasLegalHold 仅显示在版本 2017-11-09 及更高版本中。 HasImmutabilityPolicy 如果 true 容器上设置了不可变性策略，则为 ; false 否则为 。 HasLegalHold 如果 true 容器具有一个或多个法定保留，则为 ; false 否则为 。

注意

从版本 2009-09-19 开始，的 List Containers 响应正文在 名为 Last-Modified的元素中返回容器的上次修改时间。 在以前的版本中，将此元素命名为 LastModified。

VersionDeleted、、 DeletedTime和 RemainingRetentiondays 元素仅在版本 2019-12-12 及更高版本中显示，前提是为查询参数 include指定deleted值。 仅当容器已软删除且符合还原条件时，才会显示这些元素。 VersionDeleted如果为include查询参数指定了已删除的值，并且容器已软删除并有资格还原，则 、、 DeletedTime和 RemainingRetentiondays 元素仅在版本 2019-12-12 及更高版本中显示。

授权

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

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

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

注解

如果为 maxresults 参数指定值，并且要返回的容器数超过此值，或超过 的默认值 maxresults，则响应正文将包含 元素 NextMarker 。 (这也称为 延续标记) 。

NextMarker 指示在后续请求中返回的下一个容器。 若要返回下一组项，请为marker后续请求的 URI 上的 参数指定 值NextMarker。 请注意，NextMarker 值应视为不透明。

如果列表操作跨越分区边界，则服务将返回 元素的值 NextMarker ，用于从下一个分区检索其余结果。 如果列表操作跨越多个分区，则返回的项集比 指定 maxresults或默认值 5000 少。 执行列表操作时，应用程序应始终检查元素的存在NextMarker，并相应地处理它。

容器将按字母顺序在响应正文中列出。

List Containers 操作将在 30 秒后超时。

计费

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

操作 存储帐户类型 计费类别
列出容器 高级块 blob
标准常规用途 v2
标准常规用途 v1		 列出和创建容器操作

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

示例请求和响应

以下示例 URI 请求帐户的容器列表，并将初始操作返回的最大结果设置为 3。

GET https://myaccount.blob.core.windows.net/?comp=list&maxresults=3 HTTP/1.1

请求与以下标头一起发送：

x-ms-version: 2016-05-31  
x-ms-date: Wed, 26 Oct 2016 22:08:44 GMT  
Authorization: SharedKey myaccount:CY1OP3O3jGFpYFbTCBimLn0Xov0vt0khH/D5Gy0fXvg=

状态代码和响应标头按如下方式返回：

HTTP/1.1 200 OK  
Transfer-Encoding: chunked  
Content-Type: application/xml  
Date: Wed, 26 Oct 2016 22:08:54 GMT  
x-ms-version: 2016-05-31  
Server: Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0

此请求的响应 XML 如下所示。 请注意， NextMarker 元素遵循容器集，并包含要返回的下一个容器的名称。

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults ServiceEndpoint="https://myaccount.blob.core.windows.net/">  
  <MaxResults>3</MaxResults>  
  <Containers>  
    <Container>  
      <Name>audio</Name>  
      <Properties>  
        <Last-Modified>Wed, 26 Oct 2016 20:39:39 GMT</Last-Modified>  
        <Etag>0x8CACB9BD7C6B1B2</Etag> 
        <PublicAccess>container</PublicAccess> 
      </Properties>  
    </Container>  
    <Container>  
      <Name>images</Name>  
      <Properties>  
        <Last-Modified>Wed, 26 Oct 2016 20:39:39 GMT</Last-Modified>  
        <Etag>0x8CACB9BD7C1EEEC</Etag>  
      </Properties>  
    </Container>  
    <Container>  
      <Name>textfiles</Name>  
      <Properties>  
        <Last-Modified>Wed, 26 Oct 2016 20:39:39 GMT</Last-Modified>  
        <Etag>0x8CACB9BD7BACAC3</Etag>  
      </Properties>  
    </Container>  
  </Containers>  
  <NextMarker>video</NextMarker>  
</EnumerationResults>

后续列表操作在请求 URI 上指定标记，如下所示。 从标记指定的容器开始，将返回下一组结果。

https://myaccount.blob.core.windows.net/?comp=list&maxresults=3&marker=video

另请参阅

授权对 Azure 存储的请求
状态和错误代码
Blob 存储错误代码
枚举 Blob 资源
使用 Azure 存储模拟器进行开发和测试
为 Blob 存储操作设置超时