パーティション キーの範囲を取得する

  • [アーティクル]

特定の GET コレクションの pkranges 子リソースに対して を実行すると、コレクションのパーティション キー範囲の一覧が取得されます。

注意

これらの API リファレンス記事では、Azure Cosmos DB データ プレーン API を使用してリソースを作成する方法について説明します。 データ プレーン API を使用すると、Cosmos DB SDK と同様に、インデックス作成ポリシー、パーティション キーなどの基本的なオプションを構成できます。 すべての Azure Cosmos DB リソースの完全な機能サポートが必要な場合は、 Cosmos DB リソース プロバイダーを使用することをお勧めします。

Request

Method 要求 URI 説明
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/pkranges は、サブスクリプションで作成された Azure Cosmos DB アカウントの名前であることに {databaseaccount} 注意してください。 {db-id}データベースの ID と {coll-id} 値はコレクションの ID です。

ヘッダー

すべての Cosmos DB 要求 で使用されるヘッダーについては、「共通の Azure Cosmos DB REST 要求ヘッダー」を参照してください。

本文

なし。

[応答]

コレクションのパーティション キー範囲の一覧を返します。

ヘッダー

すべての Cosmos DB 応答によって返されるヘッダーについては、「 共通の Azure Cosmos DB REST 応答ヘッダー 」を参照してください。

状態コード

次の表に、この操作で返される一般的なステータス コードを示します。 状態コードの完全な一覧については、「 HTTP 状態コード」を参照してください。

HTTP 状態コード 説明
200 Ok 操作に成功しました。
404 見つかりません コレクションが見つかりません。

Body

プロパティ 説明
id これは、コレクションを識別する一意の名前です。
_rid これは、システムによって生成されるプロパティです。 リソース ID (_rid) は、リソース モデル上のリソース スタックごとに階層化される一意識別子です。 アクセス許可リソースの配置およびナビゲーションのために内部的に使用されます。
_ts これは、システムによって生成されるプロパティです。 リソースの最終更新タイムスタンプを示します。 値は、タイムスタンプです。
_self これは、システムによって生成されるプロパティです。 リソースの一意のアドレス指定が可能な URI です。
_etag これは、オプティミスティック コンカレンシー制御に必要なリソース etag を表すシステム生成プロパティです。
PartitionKeyRanges これは、コレクションのパーティション キー範囲の一覧です。 これは、 ヘッダーを使用して増分読み取りを行う場合に x-ms-documentdb-partitionkeyrangeid 使用できます。

PartitionKeyRanges のプロパティ

プロパティ 説明
id

パーティション キー範囲の ID です。 これは、各コレクション内で一意の固定 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
    }

参照