Partager via

Obtenir des plages de clés de partition

  • Article

L’exécution d’un GET sur la ressource enfant d’une pkranges collection spécifique récupère la liste des plages de clés de partition pour la collection.

Notes

Ces articles de référence sur les API montrent comment créer des ressources à l’aide de l’API de plan de données Azure Cosmos DB. Avec l’API de plan de données, vous pouvez configurer des options de base telles que la stratégie d’indexation et les clés de partition, comme vous le pouvez avec les SDK Cosmos DB. Si vous avez besoin d’une prise en charge complète des fonctionnalités pour toutes les ressources Azure Cosmos DB, nous vous recommandons d’utiliser le fournisseur de ressources Cosmos DB.

Requête

Méthode URI de demande Description
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/pkranges Notez que le {databaseaccount} est le nom du compte Azure Cosmos DB créé sous votre abonnement. L’ID {db-id} de la base de données et la valeur {coll-id} sont l’ID de la collection.

En-têtes

Consultez En-têtes de requête REST Azure Cosmos DB courants pour les en-têtes utilisés par toutes les requêtes Cosmos DB.

Corps

Aucun.

response

Retourne la liste des plages de clés de partition pour la collection.

En-têtes

Consultez En-têtes de réponse REST Azure Cosmos DB courants pour les en-têtes retournés par toutes les réponses Cosmos DB.

Codes d’état

Le tableau suivant répertorie les codes d'état courants renvoyés par cette opération. Pour obtenir la liste complète des codes status, consultez Codes d’état HTTP.

Code d'état HTTP Description
200 Ok L'opération a réussi.
404 Introuvable La collection est introuvable.

body

Propriété Description
id Il s’agit du nom unique qui identifie la collection.
_rid Cette propriété est générée par le système. L’ID de ressource (_rid) est un identificateur unique qui est également hiérarchique en fonction de la pile de ressources sur le modèle de ressource. Il est utilisé en interne pour le positionnement et la navigation dans la ressource d'autorisation.
_ts Cette propriété est générée par le système. Elle spécifie l'horodateur de la dernière mise à jour de la ressource. La valeur est un horodateur.
_self Cette propriété est générée par le système. Il s'agit de l'URI adressable unique pour la ressource.
_etag Il s’agit d’une propriété générée par le système représentant la ressource etag requise pour le contrôle d’accès concurrentiel optimiste.
PartitionKeyRanges Il s’agit de la liste des plages de clés de partition pour la collection. Cela peut être utilisé pour le flux de lecture incrémentiel avec l’en-tête x-ms-documentdb-partitionkeyrangeid .

Propriétés de PartitionKeyRanges

Propriété Description
id

ID de la plage de clés de partition. Il s’agit d’un ID stable et unique dans chaque collection.

Peut être utilisé pour lire des documents par plage de clés de partition.
maxExclusive Valeur de hachage de la clé de partition maximale pour la plage de clés de partition. À usage interne uniquement.
minInclusive Valeur de hachage de la clé de partition minimale pour la plage de clés de partition. À usage interne uniquement.

Exemple

Vous pouvez récupérer les plages de clés de partition en demandant la ressource pkranges au sein d’une collection. Par exemple, la demande suivante récupère la liste des plages de clés de partition de la collection 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

Cette demande renvoie la réponse suivante contenant les métadonnées des plages de clés de partition :

    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
    }

Voir aussi