Hämta partitionsnyckelintervall

  • Artikel

Om du utför en GET på en specifik samlings pkranges underordnade resurs hämtas listan över partitionsnyckelintervall för samlingen.

Anteckning

Dessa API-referensartiklar visar hur du skapar resurser med azure Cosmos DB-dataplanets API. Med dataplanets API kan du konfigurera grundläggande alternativ, till exempel indexeringsprincip, partitionsnycklar ungefär som du kan med Cosmos DB SDK:er. Om du behöver fullständigt funktionsstöd för alla Azure Cosmos DB-resurser rekommenderar vi att du använder Cosmos DB-resursprovidern.

Förfrågan

Metod URI för förfrågan Beskrivning
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/pkranges Observera att är namnet på det Azure Cosmos DB-konto som {databaseaccount} skapats under din prenumeration. ID {db-id} :t för databasen och värdet {coll-id} är ID:t för samlingen.

Sidhuvuden

Se Vanliga REST-begärandehuvuden för Azure Cosmos DB för rubriker som används av alla Cosmos DB-begäranden.

Brödtext

Inga.

Svarsåtgärder

Returnerar listan över partitionsnyckelintervall för samlingen.

Sidhuvuden

Se Vanliga AZURE Cosmos DB REST-svarshuvuden för rubriker som returneras av alla Cosmos DB-svar.

Statuskoder

I följande tabell visas vanliga statuskoder som returneras av den här åtgärden. En fullständig lista över statuskoder finns i HTTP-statuskoder.

HTTP-statuskod Beskrivning
200 Ok Åtgärden lyckades.
404 – Hittades inte Det går inte att hitta samlingen.

Brödtext

Egenskap Beskrivning
id Det här är det unika namnet som identifierar samlingen.
_rid Det här är en systemgenererad egenskap. Resurs-ID :t (_rid) är en unik identifierare som också är hierarkisk per resursstacken i resursmodellen. Den används internt för placering och navigering av behörighetsresursen.
_ts Det här är en systemgenererad egenskap. Den anger resursens senast uppdaterade tidsstämpel. Värdet är en tidsstämpel.
_self Det här är en systemgenererad egenskap. Det är den unika adresserbara URI:n för resursen.
_etag Det här är en systemgenererad egenskap som representerar den resurs etag som krävs för optimistisk samtidighetskontroll.
PartitionKeyRanges Det här är listan över partitionsnyckelintervall för samlingen. Detta kan användas för inkrementell läsfeed med x-ms-documentdb-partitionkeyrangeid huvudet.

Egenskaper för PartitionKeyRanges

Egenskap Beskrivning
id

ID för partitionsnyckelintervallet. Detta är ett stabilt och unikt ID i varje samling.

Kan användas för att läsa dokument efter partitionsnyckelintervall.
maxExclusive Det maximala hashvärdet för partitionsnyckeln för partitionsnyckelintervallet. För internt bruk.
minInclusive Det minsta hashvärdet för partitionsnyckeln för partitionsnyckelintervallet. För internt bruk.

Exempel

Du kan hämta partitionsnyckelintervallen genom att begära resursen pkranges i en samling. Följande begäran hämtar till exempel listan över partitionsnyckelintervall för serverlogs samlingen:

    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

Den här begäran returnerar följande svar som innehåller metadata om partitionsnyckelintervallen:

    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
    }

Se även