Share via

Obter intervalos de chaves de partição

  • Artigo

Executar um GET no recurso filho de pkranges uma coleção específica recupera a lista de intervalos de chaves de partição para a coleção.

Observação

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

Solicitação

Método URI da solicitação Descrição
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/pkranges Observe que é {databaseaccount} o nome da conta do Azure Cosmos DB criada em sua assinatura. A {db-id} ID do banco de dados e do valor {coll-id} é a ID da coleção.

Cabeçalhos

Confira Cabeçalhos comuns de solicitação REST do Azure Cosmos DB para cabeçalhos usados por todas as solicitações do Cosmos DB.

Corpo

Nenhum.

Resposta

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

Cabeçalhos

Confira Cabeçalhos comuns de resposta REST do Azure Cosmos DB para cabeçalhos retornados por todas as respostas do Cosmos DB.

Códigos de status

A tabela a seguir lista os códigos de status comuns retornados por esta operação. Para obter uma lista completa de códigos de status, consulte Códigos de status HTTP.

Código de status 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 Esse é o nome exclusivo que identifica a coleção.
_rid Essa é uma propriedade gerada pelo sistema. A ID do recurso (_rid) é um identificador exclusivo que também é hierárquico de acordo com a pilha de recursos no modelo de recurso. É usada internamente para posicionamento e navegação do recurso de permissão.
_ts Essa é uma propriedade gerada pelo sistema. Especifica o último carimbo de data/hora atualizado do recurso. O valor é um carimbo de data/hora.
_self Essa é uma propriedade gerada pelo sistema. É o URI endereçável exclusivo do recurso.
_etag Essa é uma propriedade gerada pelo sistema que representa o recurso etag necessário para o controle de simultaneidade otimista.
PartitionKeyRanges Esta é a lista de intervalos de chaves de partição para a coleção. Isso pode ser usado para read feed incremental com o x-ms-documentdb-partitionkeyrangeid cabeçalho .

Propriedades de PartitionKeyRanges

Propriedade Descrição
id

A ID para o intervalo de chaves de partição. É uma ID estável e exclusiva dentro de cada coleção.

Pode ser usado para ler documentos por intervalo de chaves de partição.
maxExclusive O valor de hash de chave de partição máxima para o intervalo de chaves de partição. Para uso interno.
minInclusive O valor de hash da chave de partição mínimo para o intervalo de chaves de partição. Para uso interno.

Exemplo

Você pode recuperar os Intervalos de Chaves de Partição solicitando o recurso pkranges em uma coleção. Por exemplo, a solicitação a seguir recupera a lista de intervalos de chaves de partição para a coleção 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

Essa solicitação retorna a seguinte resposta com 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