Obtención de intervalos de claves de partición

  • Artículo

La realización de un GET objeto en el recurso secundario de pkranges una colección específica recupera la lista de intervalos de claves de partición de la colección.

Nota:

En estos artículos de referencia de API se muestra cómo crear recursos mediante la API del plano de datos de Azure Cosmos DB. Con la API del plano de datos, puede configurar opciones básicas, como la directiva de indexación, las claves de partición del mismo modo que puede usar los SDK de Cosmos DB. Si necesita compatibilidad completa con características para todos los recursos de Azure Cosmos DB, se recomienda usar el proveedor de recursos de Cosmos DB.

Solicitud

Método URI de solicitud Descripción
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/pkranges Tenga en cuenta que {databaseaccount} es el nombre de la cuenta de Azure Cosmos DB creada en la suscripción. El {db-id} identificador de la base de datos y el valor {coll-id} es el identificador de la colección.

encabezados

Consulte Encabezados de solicitud REST comunes de Azure Cosmos DB para los encabezados que usan todas las solicitudes de Cosmos DB.

Cuerpo

Ninguno.

Response

Devuelve la lista de intervalos de claves de partición de la colección.

encabezados

Consulte Encabezados de respuesta REST comunes de Azure Cosmos DB para ver los encabezados devueltos por todas las respuestas de Cosmos DB.

Códigos de estado

La tabla siguiente muestra los códigos de estado comunes que devuelve esta operación. Para obtener una lista completa de los códigos de estado, consulte Códigos de estado HTTP.

Código de estado HTTP Descripción
200 Ok La operación se realizó correctamente.
404 No encontrado No se encuentra la colección.

Body

Propiedad Descripción
id Este es el nombre único que identifica la colección.
_rid Se trata de una propiedad generada por el sistema. El identificador de recurso (_rid) es un identificador único que también es jerárquico por la pila de recursos en el modelo de recursos. Se usa internamente para la colocación y la navegación del recurso de permiso.
_ts Se trata de una propiedad generada por el sistema. Especifica la última marca de tiempo actualizada del recurso. El valor es una marca de tiempo.
_self Se trata de una propiedad generada por el sistema. Es el URI direccionable único para el recurso.
_etag Se trata de una propiedad generada por el sistema que representa el recurso etag necesario para el control de simultaneidad optimista.
PartitionKeyRanges Esta es la lista de intervalos de claves de partición de la colección. Esto se puede usar para el suministro de lectura incremental con el x-ms-documentdb-partitionkeyrangeid encabezado .

Propiedades de PartitionKeyRanges

Propiedad Descripción
id

El identificador del intervalo de claves de partición. Se trata de un identificador estable y único dentro de cada colección.

Se puede usar para leer documentos por intervalo de claves de partición.
maxExclusive El valor de hash de la clave de partición máxima para el intervalo de claves de partición. Para uso interno.
minInclusive El valor de hash de clave de partición mínimo para el intervalo de claves de partición. Para uso interno.

Ejemplo

Puede recuperar los intervalos de claves de partición solicitando el recurso pkranges dentro de una colección. Por ejemplo, la siguiente solicitud recupera la lista de intervalos de claves de partición para la colección 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

Esta solicitud devuelve la siguiente respuesta que contiene metadatos sobre los intervalos de claves de partición:

    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
    }

Consulte también