清單 (ReadFeed) 文件

發行項
08/05/2023

在特定集合的文件資源上執行 GET (亦即 docs URI 路徑)，會傳回該集合下的文件清單。 ReadFeed 可用來擷取所有檔，或只擷取集合內檔的累加變更。

要求

方法	要求 URI	描述
GET	`https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs`	請注意， `{databaseaccount}` 是您訂用帳戶下建立的 Azure Cosmos DB 帳戶名稱。值為 `{db-id}` 資料庫的識別碼，而 {coll-id} 值是集合的名稱。

標題

如需所有 Cosmos DB 要求所使用的標頭，請參閱常見的 Azure Cosmos DB REST 要求標頭。 ReadFeed Document 的重要回應標頭如下：

標頭	必要	類型	說明
`x-ms-max-item-count`	選用	數字	整數，表示每個頁面要傳回的專案數目上限。
`x-ms-continuation`	選用	String	如果有更多要讀取的結果，則會針對查詢和讀取摘要作業傳回的字串權杖。用戶端可以重新提交要求，並將 x-ms-continuation 要求標頭設定為此值，以擷取下一頁的結果。
`x-ms-consistency-level`	選用	String	這是一致性層級覆寫。有效值為：強式、限定、會話或最終 (，以最強到最弱) 。覆寫必須與帳戶設定的一致性層級相同或較弱。
`x-ms-session-token`	選用	String	與會話層級一致性搭配使用的字串權杖。用戶端必須在會話一致性的讀取要求期間回應此標頭的最新讀取值。
`A-IM`	選用	String	必須設定為 `Incremental feed` ，否則必須省略。從 REST API 版本 `2016-07-11` 開始提供。
`If-None-Match`	選用	String	No header：傳回從一開始 (集合建立) 的所有變更 "*"：傳回集合內資料的所有新變更 <etag > ：如果設定為集合 ETag，則會傳回自該邏輯時間戳記以來所做的所有變更。從 REST API 版本 `2016-07-11` 開始提供。
`x-ms-documentdb-partitionkeyrangeid`	選用	String	用來讀取資料的資料分割索引鍵範圍識別碼。從 REST API 版本 `2016-07-11` 開始提供。

主體

無。

回應

傳回儲存在集合中的檔陣列。

標題

如需所有 Cosmos DB 回應所傳回的標頭，請參閱常見的 Azure Cosmos DB REST 回應標頭。重要的回應標頭如下：

標頭類型描述

x-ms-continuation String 傳回權杖，以從作業擷取其他結果。用戶端可以使用包含此值的標頭重新提交要求 x-ms-continuation request ，以繼續執行。

x-ms-request-charge 數字作業所耗用的要求單位數目。

標頭	類型	描述
`x-ms-continuation`	String	傳回權杖，以從作業擷取其他結果。用戶端可以使用包含此值的標頭重新提交要求 `x-ms-continuation request` ，以繼續執行。
`x-ms-request-charge`	數字	作業所耗用的要求單位數目。
`etag`	String	回應中最後傳回文件的邏輯序號 (LSN)。透過在 If-None-Match 中重新提交此值，可以繼續執行累加式 ReadDocumentFeed。

etag

String

回應中最後傳回文件的邏輯序號 (LSN)。

透過在 If-None-Match 中重新提交此值，可以繼續執行累加式 ReadDocumentFeed。

狀態碼

下表列出此作業所傳回的常見狀態碼。如需狀態碼的完整清單，請參閱 HTTP 狀態碼。

HTTP 狀態碼	Description
200 確定	作業成功。
400 不正確的要求	x-ms-consistency-level 中設定的覆寫比帳戶建立期間設定的覆寫強。例如，如果一致性層級是 Session，則覆寫不得為 Strong 或 Bounded。

主體

屬性	Description
`_rid`	這是系統為文件所在的集合所產生的資源識別碼。
`_count`	這是清單作業所傳回的文件數目。
`Documents`	作業所傳回的文件陣列。

檔的屬性

屬性	Description
`id`	這是識別檔的唯一名稱，也就是兩份檔都不能共用相同的 `id` 。 `id`不得超過 255 個字元。
<custom>	任何使用者定義的 JSON。
`_rid`	這是系統產生的屬性。資源識別碼 () `_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) 文件

要求

標題

主體

回應

標題

狀態碼

主體

範例

另請參閱

其他資源