取得分割區索引鍵範圍

  • 發行項

在特定 GET 集合的 pkranges 子資源上執行 ，會擷取集合的資料分割索引鍵範圍清單。

注意

這些 API 參考文章示範如何使用 Azure Cosmos DB 資料平面 API 建立資源。 透過資料平面 API，您可以設定基本選項，例如編制索引原則，資料分割索引鍵就像使用 Cosmos DB SDK 一樣。 如果您需要所有 Azure Cosmos DB 資源的完整功能支援，建議您使用 Cosmos DB 資源提供者。

要求

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

標題

如需所有 Cosmos DB 要求所使用的標頭，請參閱常見的 Azure Cosmos DB REST 要求標頭 。

主體

無。

回應

傳回集合的分割區索引鍵範圍清單。

標題

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

狀態碼

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

HTTP 狀態碼 Description
200 確定 作業成功。
404 找不到 找不到集合。

主體

屬性 Description
id 這是識別集合的唯一名稱。
_rid 這是系統產生的屬性。 資源識別碼 () _rid 是資源模型上每個資源堆疊的階層式唯一識別碼。 供內部進行放置和導覽文件資源時使用。
_ts 這是系統產生的屬性。 代表資源的上次更新時間戳記。 值為時間戳記。
_self 這是系統產生的屬性。 代表資源的唯一可定址 URI。
_etag 這是系統產生的屬性，代表開放式並行控制所需的資源 etag 。
PartitionKeyRanges 這是集合的分割區索引鍵範圍清單。 這可用於標頭的 x-ms-documentdb-partitionkeyrangeid 累加式讀取。

PartitionKeyRanges 的屬性

屬性 Description
id

資料分割索引鍵範圍的識別碼。 這是每個集合內穩定且唯的一識別碼。

可用來依分割區索引鍵範圍讀取檔。
maxExclusive 資料分割索引鍵範圍的最大資料分割索引鍵雜湊值。 供內部使用。
minInclusive 資料分割索引鍵範圍的最小資料分割索引鍵雜湊值。 供內部使用。

範例

您可以藉由要求集合內的 pkranges 資源來擷取資料分割索引鍵範圍。 例如，下列要求會擷取 serverlogs 集合的資料分割索引鍵範圍清單：

    GET https://querydemo.documents.azure.com/dbs/bigdb/colls/serverlogs/pkranges HTTP/1.1
    x-ms.date: 04/20/2021
    authorization: type%3dmaster%26ver%3d1.0%26sig%3dEConYmRgDExu6q%2bZ8GjfUGOH0AcOx%2behkancw3LsGQ8%3d
    x-ms-consistency-level: Session
    x-ms-version: 2016-07-11
    Accept: application/json
    Host: querydemo.documents.azure.com

此要求會傳回下列包含資料分割索引鍵範圍相關中繼資料的回應：

    HTTP/1.1 200 Ok
    Content-Type: application/json
    x-ms-item-count: 25
    x-ms-schemaversion: 1.1
    Date: Tue, 15 Nov 2016 07:26:51 GMT

    {
       "_rid":"qYcAAPEvJBQ=",
       "PartitionKeyRanges":[
          {
             "_rid":"qYcAAPEvJBQCAAAAAAAAUA==",
             "id":"0",
             "_etag":"\"00002800-0000-0000-0000-580ac4ea0000\"",
             "minInclusive":"",
             "maxExclusive":"05C1CFFFFFFFF8",
             "_self":"dbs\/qYcAAA==\/colls\/qYcAAPEvJBQ=\/pkranges\/qYcAAPEvJBQCAAAAAAAAUA==\/",
             "_ts":1477100776
          },
          ...
       ],
       "_count": 25
    }

另請參閱