Share via

Abrufen von Partitionsschlüsselbereichen

  • Artikel

Durch Ausführen einer GET für die untergeordnete Ressource einer bestimmten Auflistung pkranges wird die Liste der Partitionsschlüsselbereiche für die Auflistung abgerufen.

Hinweis

In diesen API-Referenzartikeln erfahren Sie, wie Sie Ressourcen mithilfe der Azure Cosmos DB-Datenebenen-API erstellen. Mit der Datenebenen-API können Sie grundlegende Optionen wie Indizierungsrichtlinie und Partitionsschlüssel ähnlich wie bei Cosmos DB SDKs konfigurieren. Wenn Sie vollständige Featureunterstützung für alle Azure Cosmos DB-Ressourcen benötigen, empfehlen wir die Verwendung des Cosmos DB-Ressourcenanbieters.

Anforderung

Methode Anforderungs-URI BESCHREIBUNG
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/pkranges Beachten Sie, dass der {databaseaccount} Name des Azure Cosmos DB-Kontos ist, das unter Ihrem Abonnement erstellt wurde. Die {db-id} ID der Datenbank und der Wert {coll-id} ist die ID der Auflistung.

Header

Informationen zu Headern, die von allen Cosmos DB-Anforderungen verwendet werden, finden Sie unter Allgemeine Azure Cosmos DB-REST-Anforderungsheader .

Text

Keine.

Antwort

Gibt die Liste der Partitionsschlüsselbereiche für die Auflistung zurück.

Header

Informationen zu Headern, die von allen Cosmos DB-Antworten zurückgegeben werden, finden Sie unter Allgemeine Azure Cosmos DB-REST-Antwortheader .

Statuscodes

In der folgenden Tabelle sind die allgemeinen Statuscodes aufgeführt, die von diesem Vorgang zurückgegeben werden. Eine vollständige Liste der status Codes finden Sie unter HTTP-Statuscodes.

HTTP-Statuscode BESCHREIBUNG
200 Ok Der Vorgang wurde durchgeführt.
404 – Nicht gefunden Die Auflistung wurde nicht gefunden.

Body

Eigenschaft BESCHREIBUNG
id Dies ist der eindeutige Name, der die Sammlung identifiziert.
_rid Dies ist eine vom System generierte Eigenschaft. Die Ressourcen-ID (_rid) ist ein eindeutiger Bezeichner, der auch für den Ressourcenstapel im Ressourcenmodell hierarchisch ist. Sie wird intern für die Platzierung und Navigation der Berechtigungsressource verwendet.
_ts Dies ist eine vom System generierte Eigenschaft. Sie gibt den zuletzt aktualisierten Zeitstempel der Ressource an. Der Wert ist ein Zeitstempel.
_self Dies ist eine vom System generierte Eigenschaft. Es handelt sich um den eindeutigen, adressierbaren URI für die Ressource.
_etag Dies ist eine vom System generierte Eigenschaft, die die Ressource etag darstellt, die für die Steuerung der optimistischen Parallelität erforderlich ist.
PartitionKeyRanges Dies ist die Liste der Partitionsschlüsselbereiche für die Auflistung. Dies kann für den inkrementellen Lesevorschub mit dem x-ms-documentdb-partitionkeyrangeid Header verwendet werden.

Eigenschaften von PartitionKeyRanges

Eigenschaft BESCHREIBUNG
id

Die ID des Partitionsschlüsselbereichs. Dies ist eine beständige und eindeutige ID innerhalb jeder Sammlung.

Kann verwendet werden, um Dokumente nach Partitionsschlüsselbereich zu lesen.
maxExclusive Der maximale Partitionsschlüssel-Hashwert für den Partitionsschlüsselbereich. Für die interne Verwendung.
minInclusive Der minimale Partitionsschlüssel-Hashwert für den Partitionsschlüsselbereich. Für die interne Verwendung.

Beispiel

Sie können die Partitionsschlüsselbereiche abrufen, indem Sie die pkranges-Ressource innerhalb einer Sammlung anfordern. Die folgende Anforderung ruft z.B. die Liste der Partitionsschlüsselbereiche für die serverlogs-Sammlung ab:

    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

Diese Anforderung gibt die folgende Antwort mit Metadaten über die Partitionsschlüsselbereiche zurück:

    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
    }

Weitere Informationen