Получение диапазонов ключей секции

  • Статья

При выполнении GET для дочернего ресурса определенной коллекции pkranges извлекается список диапазонов ключей секций для коллекции.

Примечание

В этих справочных статьях по API показано, как создавать ресурсы с помощью API плоскости данных Azure Cosmos DB. С помощью API плоскости данных можно настроить основные параметры, такие как политика индексирования, ключи секций, так же, как в пакетах SDK для Cosmos DB. Если требуется полная поддержка функций для всех ресурсов 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, см. в статье Общие заголовки запросов REST Azure Cosmos DB .

Текст

Нет.

Ответ

Возвращает список диапазонов ключей секций для коллекции.

Заголовки

Заголовки, возвращаемые всеми ответами Cosmos DB, см. в статье Общие заголовки ответов REST Azure Cosmos DB .

Коды состояния

В таблице ниже указаны стандартные коды состояния, возвращаемые этой операцией. Полный список кодов состояния см. в разделе Коды состояния HTTP.

Код состояния HTTP Описание
200 (ОК) Операция выполнена успешно.
404 — не найдено Коллекция не найдена.

Текст

Свойство Описание
id Это уникальное имя, идентифицирующее коллекцию.
_rid Это системное свойство. Идентификатор ресурса (_rid) — это уникальный идентификатор, который также является иерархическим для стека ресурсов в модели ресурсов. Он используется системой для размещения и перемещения по ресурсам разрешения.
_ts Это системное свойство. Оно представляет метку времени последнего обновления ресурса. Значение — метка времени.
_self Это системное свойство. Это уникальный адресуемый URI для ресурса.
_etag Это созданное системой свойство, представляющее ресурс etag , необходимый для управления оптимистическим параллелизмом.
PartitionKeyRanges Это список диапазонов ключей секций для коллекции. Его можно использовать для добавочного канала чтения с заголовком x-ms-documentdb-partitionkeyrangeid .

Свойства PartitionKeyRanges

Свойство Описание
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
    }

См. также: