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

列出 (ReadFeed) 文档

项目
08/05/2023

对特定集合的文档资源（即 docs URI 路径）执行 GET 时，将返回该集合下的文档列表。 ReadFeed 可用于检索所有文档，或仅检索集合中文档的增量更改。

请求

方法	请求 URI	说明
GET	`https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs`	请注意， `{databaseaccount}` 是订阅下创建的 Azure Cosmos DB 帐户的名称。值为 `{db-id}` 数据库的 ID，{coll-id} 值为集合的名称。

标头

有关所有 Cosmos DB 请求使用的标头，请参阅常见的 Azure Cosmos DB REST 请求标头。 ReadFeed 文档的重要响应标头如下：

标头	必需	类型	说明
`x-ms-max-item-count`	可选	Number	一个整数，指示每页返回的最大项数。
`x-ms-continuation`	可选	字符串	如果有更多结果需要读取，则为查询和读取源操作返回的字符串标记。客户端可以通过重新提交将 x-ms-continuation 请求标头设置为此值的请求来检索下一页结果。
`x-ms-consistency-level`	可选	字符串	这是一致性级别覆盖。有效值为： Strong、 Bounded、 Session 或 Eventual (，按最强到最弱) 顺序排列。替代必须与帐户配置的一致性级别相同或更弱。
`x-ms-session-token`	可选	字符串	用于会话级别一致性的字符串令牌。客户端必须在读取请求期间回显此标头的最新读取值，以确保会话一致性。
`A-IM`	可选	字符串	必须设置为 `Incremental feed`，否则将省略。从 REST API 版本 `2016-07-11` 开始可用。
`If-None-Match`	可选	字符串	无标头：返回从一开始（创建集合时）所做的全部更改 "*"：返回最近对集合中数据所做的全部更改 <etag>：如果设置为集合 ETag，则返回自该逻辑时间戳以来所做的所有更改。从 REST API 版本 `2016-07-11` 开始可用。
`x-ms-documentdb-partitionkeyrangeid`	可选	字符串	用于读取数据的分区键范围 ID。从 REST API 版本 `2016-07-11` 开始可用。

正文

无。

响应

返回集合中存储的文档数组。

标头

有关所有 Cosmos DB 响应返回的标头，请参阅常见的 Azure Cosmos DB REST 响应标头。重要的响应标头包括：

标头类型说明

x-ms-continuation 字符串返回一个标记，用于从操作中提取其他结果。客户端可以使用包含此值的标头重新提交请求 x-ms-continuation request 以继续执行。

x-ms-request-charge Number 操作使用的请求单位数。

标头	类型	说明
`x-ms-continuation`	字符串	返回一个标记，用于从操作中提取其他结果。客户端可以使用包含此值的标头重新提交请求 `x-ms-continuation request` 以继续执行。
`x-ms-request-charge`	Number	操作使用的请求单位数。
`etag`	字符串	响应中返回的最后一个文档的逻辑序列号 (LSN)。在 If-None-Match 中重新提交此值可以恢复增量 ReadDocumentFeed。

etag

字符串

响应中返回的最后一个文档的逻辑序列号 (LSN)。

在 If-None-Match 中重新提交此值可以恢复增量 ReadDocumentFeed。

状态代码

下表列出了此操作返回的常见状态代码。有关状态代码的完整列表，请参阅 HTTP 状态代码。

HTTP 状态代码	说明
200 正常	操作成功。
400 错误的请求	x-ms-consistency-level 中设置的覆盖级别比创建帐户时设置的覆盖级别更强。例如，如果一致性级别为 Session，则重写不能为 Strong 或 Bounded。

正文

属性	说明
`_rid`	这是系统为文档所在的集合生成的资源 ID。
`_count`	这是列出操作返回的文档数。
`Documents`	操作返回的文档数组。

文档的属性

属性	说明
`id`	这是标识文档的唯一名称，即没有两个文档可以共享同一 `id`个。 `id`不得超过 255 个字符。
<custom>	任何用户定义的 JSON。
`_rid`	这是系统生成的属性。资源 ID (`_rid`) 是一个唯一标识符，也是根据资源模型上的资源堆栈分层的。它在内部用于文档资源的放置和导航。
`_ts`	这是系统生成的属性。它指定资源的上次更新时间戳。高值是一个时间戳。
`_self`	这是系统生成的属性。它是资源的唯一可寻址 URI。
`_etag`	这是一个系统生成的属性，用于指定乐观并发控制所需的资源 `etag` 。
`_attachments`	这是系统生成的属性，它指定附件资源的可寻址路径。

{  
  "_rid": "d9RzAJRFKgw=",  
  "Documents": [  
    {  
      "id": "SalesOrder1",  
      "ponumber": "PO18009186470",  
      "OrderDate": "2005-07-01T00:00:00",  
      "ShippedDate": "0001-01-01T00:00:00",  
      "AccountNumber": "Account1",  
      "SubTotal": 419.4589,  
      "TaxAmount": 12.5838,  
      "Freight": 472.3108,  
      "TotalDue": 985.018,  
      "Items": [  
        {  
          "OrderQty": 1,  
          "ProductId": 760,  
          "UnitPrice": 419.4589,  
          "LineTotal": 419.4589  
        }  
      ],  
      "_rid": "d9RzAJRFKgwBAAAAAAAAAA==",  
      "_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwBAAAAAAAAAA==/",  
      "_etag": "\"0000d986-0000-0000-0000-56f9e25b0000\"",  
      "_ts": 1459216987,  
      "_attachments": "attachments/"  
    },  
    {  
      "id": "SalesOrder2",  
      "ponumber": "PO15428132599",  
      "OrderDate": "2005-07-01T00:00:00",  
      "DueDate": "2005-07-13T00:00:00",  
      "ShippedDate": "2005-07-08T00:00:00",  
      "AccountNumber": "Account2",  
      "SubTotal": 6107.0820,  
      "TaxAmt": 586.1203,  
      "Freight": 183.1626,  
      "TotalDue": 4893.3929,  
      "DiscountAmt": 1982.872,  
      "Items": [  
        {  
          "OrderQty": 3,  
          "ProductCode": "A-123",  
          "ProductName": "Product 1",  
          "CurrencySymbol": "$",  
          "CurrencyCode": "USD",  
          "UnitPrice": 17.1,  
          "LineTotal": 5.7  
        }  
      ],  
      "_rid": "d9RzAJRFKgwCAAAAAAAAAA==",  
      "_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwCAAAAAAAAAA==/",  
      "_etag": "\"0000da86-0000-0000-0000-56f9e25b0000\"",  
      "_ts": 1459216987,  
      "_attachments": "attachments/"  
    }  
  ],  
  "_count": 2  
}

示例

GET https://querydemo.documents.azure.com/dbs/testdb/colls/testcoll/docs HTTP/1.1  
x-ms-max-item-count: 10  
x-ms-documentdb-query-enablecrosspartition: False  
x-ms-date: Tue, 29 Mar 2016 02:03:06 GMT  
authorization: type%3dmaster%26ver%3d1.0%26sig%3dlmte5%2bJR8gIvDubFWZ0W2cgec22LcFAkZgDZxqOBsOI%3d  
Cache-Control: no-cache  
User-Agent: Microsoft.Azure.Documents.Client/1.6.0.0  
x-ms-version: 2015-12-16  
Accept: application/json  
Host: querydemo.documents.azure.com  
Cookie: x-ms-session-token#0=772; x-ms-session-token=772

HTTP/1.1 200 Ok  
Cache-Control: no-store, no-cache  
Pragma: no-cache  
Transfer-Encoding: chunked  
Content-Type: application/json  
Content-Location: https://querydemo.documents.azure.com/dbs/testdb/colls/testcoll/docs  
Server: Microsoft-HTTPAPI/2.0  
Strict-Transport-Security: max-age=31536000  
x-ms-last-state-change-utc: Sun, 27 Mar 2016 22:39:13.369 GMT  
x-ms-resource-quota: documentSize=10240;documentsSize=10485760;collectionSize=10485760;  
x-ms-resource-usage: documentSize=0;documentsSize=2;collectionSize=2;  
x-ms-item-count: 2  
x-ms-schemaversion: 1.1  
x-ms-alt-content-path: dbs/testdb/colls/testcoll  
x-ms-content-path: d9RzAJRFKgw=  
x-ms-request-charge: 1  
x-ms-serviceversion: version=1.6.52.5  
x-ms-activity-id: 46e2e9a5-4917-4ff6-9be5-6f206c38bb6b  
x-ms-session-token: 0:772  
Set-Cookie: x-ms-session-token#0=772; Domain=querydemo.documents.azure.com; Path=/dbs/testdb/colls/testcoll  
Set-Cookie: x-ms-session-token=772; Domain=querydemo.documents.azure.com; Path=/dbs/testdb/colls/testcoll  
x-ms-gatewayversion: version=1.6.52.5  
Date: Tue, 29 Mar 2016 02:03:07 GMT  
  
{  
  "_rid": "d9RzAJRFKgw=",  
  "Documents": [  
    {  
      "id": "SalesOrder1",  
      "ponumber": "PO18009186470",  
      "OrderDate": "2005-07-01T00:00:00",  
      "ShippedDate": "0001-01-01T00:00:00",  
      "AccountNumber": "Account1",  
      "SubTotal": 419.4589,  
      "TaxAmount": 12.5838,  
      "Freight": 472.3108,  
      "TotalDue": 985.018,  
      "Items": [  
        {  
          "OrderQty": 1,  
          "ProductId": 760,  
          "UnitPrice": 419.4589,  
          "LineTotal": 419.4589  
        }  
      ],  
      "_rid": "d9RzAJRFKgwBAAAAAAAAAA==",  
      "_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwBAAAAAAAAAA==/",  
      "_etag": "\"0000d986-0000-0000-0000-56f9e25b0000\"",  
      "_ts": 1459216987,  
      "_attachments": "attachments/"  
    },  
    {  
      "id": "SalesOrder2",  
      "ponumber": "PO15428132599",  
      "OrderDate": "2005-07-01T00:00:00",  
      "DueDate": "2005-07-13T00:00:00",  
      "ShippedDate": "2005-07-08T00:00:00",  
      "AccountNumber": "Account2",  
      "SubTotal": 6107.0820,  
      "TaxAmt": 586.1203,  
      "Freight": 183.1626,  
      "TotalDue": 4893.3929,  
      "DiscountAmt": 1982.872,  
      "Items": [  
        {  
          "OrderQty": 3,  
          "ProductCode": "A-123",  
          "ProductName": "Product 1",  
          "CurrencySymbol": "$",  
          "CurrencyCode": "USD",  
          "UnitPrice": 17.1,  
          "LineTotal": 5.7  
        }  
      ],  
      "_rid": "d9RzAJRFKgwCAAAAAAAAAA==",  
      "_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwCAAAAAAAAAA==/",  
      "_etag": "\"0000da86-0000-0000-0000-56f9e25b0000\"",  
      "_ts": 1459216987,  
      "_attachments": "attachments/"  
    }  
  ],  
  "_count": 2  
}

通过

列出 (ReadFeed) 文档

请求

标头

正文

响应

标头

状态代码

正文

示例

另请参阅

其他资源