Partilhar via

Obter intervalos de chaves de partição

  • Artigo

Executar um GET num recurso subordinado de pkranges uma coleção específica obtém a lista de intervalos de chaves de partição para a coleção.

Nota

Estes artigos de referência da API mostram como criar recursos com a API do plano de dados do Azure Cosmos DB. Com a API do plano de dados, pode configurar opções básicas, como a política de indexação, chaves de partição da mesma forma que pode com os SDKs do Cosmos DB. Se precisar de suporte completo de funcionalidades para todos os recursos do Azure Cosmos DB, recomendamos que utilize o Fornecedor de Recursos do Cosmos DB.

Pedir

Método URI do pedido Descrição
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/pkranges Tenha em atenção que é {databaseaccount} o nome da conta do Azure Cosmos DB criada na sua subscrição. O {db-id} ID da base de dados e o valor {coll-id} é o ID da coleção.

Cabeçalhos

Veja Common Azure Cosmos DB REST request headers for headers that are used by all Cosmos DB requests (Cabeçalhos de pedido REST do Azure Cosmos DB comuns para cabeçalhos que são utilizados por todos os pedidos do Cosmos DB).

Corpo

Nenhum.

Resposta

Devolve a lista de intervalos de chaves de partição para a coleção.

Cabeçalhos

Veja Common Azure Cosmos DB REST response headers for headers that are returned by all Cosmos DB responses (Cabeçalhos de resposta REST do Azure Cosmos DB comuns para cabeçalhos devolvidos por todas as respostas do Cosmos DB).

Códigos de estado

A tabela seguinte lista os códigos de estado comuns devolvidos por esta operação. Para obter uma lista completa dos códigos de estado, consulte Códigos de Estado HTTP.

Código de estado de HTTP Descrição
200 Ok A operação foi bem-sucedida.
404 Não Encontrado A coleção não foi encontrada.

Corpo

Propriedade Descrição
id Este é o nome exclusivo que identifica a coleção.
_rid Esta é uma propriedade gerada pelo sistema. O ID do recurso (_rid) é um identificador exclusivo que também é hierárquico de acordo com a pilha de recursos no modelo de recursos. É utilizado internamente para colocação e navegação do recurso de permissão.
_ts Esta é uma propriedade gerada pelo sistema. Especifica o último carimbo de data/hora atualizado do recurso. O valor é um carimbo de data/hora.
_self Esta é uma propriedade gerada pelo sistema. É o URI endereçável exclusivo para o recurso.
_etag Esta é uma propriedade gerada pelo sistema que representa o recurso etag necessário para o controlo de simultaneidade otimista.
PartitionKeyRanges Esta é a lista de intervalos de chaves de partição para a coleção. Isto pode ser utilizado para o readfeed incremental com o x-ms-documentdb-partitionkeyrangeid cabeçalho.

Propriedades de PartitionKeyRanges

Propriedade Descrição
id

O ID do intervalo de chaves de partição. Trata-se de um ID estável e exclusivo em cada coleção.

Pode ser utilizado para ler documentos por intervalo de chaves de partição.
maxExclusive O valor hash de chave de partição máximo para o intervalo de chaves de partição. Para utilização interna.
minInclusive O valor hash da chave de partição mínima para o intervalo de chaves de partição. Para utilização interna.

Exemplo

Pode obter os Intervalos de Chaves de Partição ao pedir o pkranges recurso numa coleção. Por exemplo, o seguinte pedido obtém a lista de intervalos de chaves de partição para a serverlogs coleção:

    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

Este pedido devolve a seguinte resposta que contém metadados sobre os intervalos de chaves de partição:

    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 também