Delen via

Partitiesleutelbereiken ophalen

Als u een GET uitvoert op de onderliggende resource van een specifieke verzameling pkranges , wordt de lijst met partitiesleutelbereiken voor de verzameling opgehaald.

Notitie

Deze API-referentieartikelen laten zien hoe u resources maakt met behulp van de Azure Cosmos DB-gegevensvlak-API. Met de gegevensvlak-API kunt u basisopties configureren, zoals indexeringsbeleid en partitiesleutels, net als met Cosmos DB SDK's. Als u volledige functieondersteuning nodig hebt voor alle Azure Cosmos DB-resources, raden we u aan de Cosmos DB-resourceprovider te gebruiken.

Aanvraag

Methode Aanvraag-URI Beschrijving
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/pkranges Houd er rekening mee dat de {databaseaccount} naam is van het Azure Cosmos DB-account dat is gemaakt onder uw abonnement. De {db-id} id van de database en {coll-id}-waarde is de id van de verzameling.

Kopteksten

Zie Algemene Azure Cosmos DB REST-aanvraagheaders voor headers die worden gebruikt door alle Cosmos DB-aanvragen.

Hoofdtekst

Geen.

Antwoord

Retourneert de lijst met partitiesleutelbereiken voor de verzameling.

Kopteksten

Zie Algemene Azure Cosmos DB REST-antwoordheaders voor headers die worden geretourneerd door alle Cosmos DB-antwoorden.

Statuscodes

De volgende tabel bevat algemene statuscodes die door deze bewerking worden geretourneerd. Zie HTTP-statuscodes voor een volledige lijst met statuscodes.

HTTP-statuscode Beschrijving
200 Ok De bewerking is geslaagd.
404 Niet gevonden De verzameling is niet gevonden.

Hoofdtekst

Eigenschap Beschrijving
id Dit is de unieke naam die de verzameling identificeert.
_rid Dit is een door het systeem gegenereerde eigenschap. De resource-id (_rid) is een unieke id die ook hiërarchisch is volgens de resourcestack in het resourcemodel. Deze wordt intern gebruikt voor de plaatsing en navigatie van de machtigingsresource.
_ts Dit is een door het systeem gegenereerde eigenschap. Hiermee geeft u de laatst bijgewerkte tijdstempel van de resource op. De waarde is een tijdstempel.
_self Dit is een door het systeem gegenereerde eigenschap. Dit is de unieke adresseerbare URI voor de resource.
_etag Dit is een door het systeem gegenereerde eigenschap die de resource etag vertegenwoordigt die is vereist voor optimistisch gelijktijdigheidsbeheer.
PartitionKeyRanges Dit is de lijst met partitiesleutelbereiken voor de verzameling. Dit kan worden gebruikt voor incrementele leesfeed met de x-ms-documentdb-partitionkeyrangeid header.

Eigenschappen van PartitionKeyRanges

Eigenschap Beschrijving
id

De id voor het partitiesleutelbereik. Dit is een stabiele en unieke id binnen elke verzameling.

Kan worden gebruikt om documenten te lezen per partitiesleutelbereik.
maxExclusive De maximale hash-waarde voor partitiesleutels voor het bereik van de partitiesleutel. Voor intern gebruik.
minInclusive De minimale hash-waarde voor de partitiesleutel voor het partitiesleutelbereik. Voor intern gebruik.

Voorbeeld

U kunt de partitiesleutelbereiken ophalen door de pkranges resource binnen een verzameling aan te vragen. Met de volgende aanvraag wordt bijvoorbeeld de lijst met partitiesleutelbereiken voor de serverlogs verzameling opgehaald:

    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

Deze aanvraag retourneert het volgende antwoord met metagegevens over de partitiesleutelbereiken:

    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
    }

Zie ook