Sdílet prostřednictvím

Získání rozsahů klíčů oddílu

  • Článek

Provedením GET příkazu u podřízeného prostředku konkrétní kolekce pkranges se načte seznam rozsahů klíčů oddílů pro kolekci.

Poznámka

Tyto referenční články k rozhraní API ukazují, jak vytvářet prostředky pomocí rozhraní API roviny dat služby Azure Cosmos DB. Pomocí rozhraní API roviny dat můžete nakonfigurovat základní možnosti, jako jsou zásady indexování, klíče oddílů podobně jako u sad SDK služby Cosmos DB. Pokud potřebujete úplnou podporu funkcí pro všechny prostředky Azure Cosmos DB, doporučujeme použít poskytovatele prostředků Cosmos DB.

Žádost

Metoda Identifikátor URI žádosti Popis
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/pkranges Všimněte si, že je {databaseaccount} název účtu Služby Azure Cosmos DB vytvořeného v rámci vašeho předplatného. ID {db-id} databáze a hodnota {coll-id} je ID kolekce.

Hlavičky

Viz Běžné hlavičky požadavků REST služby Azure Cosmos DB pro hlavičky, které používají všechny požadavky služby Cosmos DB.

Text

Žádné

Odpověď

Vrátí seznam rozsahů klíčů oddílů pro kolekci.

Hlavičky

Viz Běžné hlavičky odpovědi REST služby Azure Cosmos DB pro hlavičky, které jsou vráceny všemi odpověďmi služby Cosmos DB.

Stavové kódy

Následující tabulka uvádí běžné stavové kódy vrácené touto operací. Úplný seznam stavových kódů najdete v tématu Stavové kódy HTTP.

Stavový kód HTTP Popis
200 Ok Operace byla úspěšná.
404 Nenalezeno Kolekce nebyla nalezena.

Text

Vlastnost Popis
id Jedná se o jedinečný název, který identifikuje kolekci.
_rid Jedná se o systém vygenerovanou vlastnost. ID prostředku (_rid) je jedinečný identifikátor, který je také hierarchický podle zásobníku prostředků v modelu prostředků. Používá se interně k umístění a navigaci prostředku oprávnění.
_ts Jedná se o systém vygenerovanou vlastnost. Určuje časové razítko poslední aktualizace prostředku. Hodnota je časové razítko.
_self Jedná se o systém vygenerovanou vlastnost. Jedná se o jedinečný adresovatelný identifikátor URI prostředku.
_etag Jedná se o systémově vygenerovanou vlastnost představující prostředek etag vyžadovaný pro řízení optimistické souběžnosti.
PartitionKeyRanges Toto je seznam rozsahů klíčů oddílů pro kolekci. To se dá použít pro přírůstkový kanál pro čtení s hlavičkou x-ms-documentdb-partitionkeyrangeid .

Vlastnosti PartitionKeyRanges

Vlastnost Popis
id

ID rozsahu klíčů oddílu. Toto je stabilní a jedinečné ID v rámci každé kolekce.

Dá se použít ke čtení dokumentů podle rozsahu klíčů oddílu.
maxExclusive Maximální hodnota hash klíče oddílu pro rozsah klíčů oddílu. Pro interní použití.
minInclusive Minimální hodnota hash klíče oddílu pro rozsah klíčů oddílu. Pro interní použití.

Příklad

Rozsahy klíčů oddílů můžete načíst vyžádáním pkranges prostředku v kolekci. Například následující požadavek načte seznam rozsahů klíčů oddílů pro kolekci 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

Tento požadavek vrátí následující odpověď obsahující metadata o rozsahech klíčů oddílů:

    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
    }

Viz také