Pobieranie zakresów kluczy partycji
GET Wykonanie elementu w zasobie podrzędnym określonej kolekcji pkranges pobiera listę zakresów kluczy partycji dla kolekcji.
Uwaga
Te artykuły referencyjne dotyczące interfejsu API pokazują, jak tworzyć zasoby przy użyciu interfejsu API płaszczyzny danych usługi Azure Cosmos DB. Za pomocą interfejsu API płaszczyzny danych można skonfigurować podstawowe opcje, takie jak zasady indeksowania, klucze partycji, podobnie jak w przypadku zestawów SDK usługi Cosmos DB. Jeśli potrzebujesz pełnej obsługi funkcji dla wszystkich zasobów usługi Azure Cosmos DB, zalecamy użycie dostawcy zasobów usługi Cosmos DB.
Żądanie
| Metoda | Identyfikator URI żądania | Opis |
|---|---|---|
| GET | https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/pkranges |
Pamiętaj, że {databaseaccount} jest to nazwa konta usługi Azure Cosmos DB utworzonego w ramach subskrypcji. Identyfikator {db-id} bazy danych i {coll-id} to identyfikator kolekcji. |
Nagłówki
Zobacz Typowe nagłówki żądań REST usługi Azure Cosmos DB dla nagłówków , które są używane przez wszystkie żądania usługi Cosmos DB.
Treść
Brak.
Reakcja
Zwraca listę zakresów kluczy partycji dla kolekcji.
Nagłówki
Zobacz Typowe nagłówki odpowiedzi REST usługi Azure Cosmos DB dla nagłówków zwracanych przez wszystkie odpowiedzi usługi Cosmos DB.
Kody stanu
Poniższa tabela zawiera listę typowych kodów stanu zwracanych przez tę operację. Aby uzyskać pełną listę kodów stanu, zobacz Kody stanu HTTP.
| Kod stanu HTTP | Opis |
|---|---|
| 200 OK | Operacja zakończyła się pomyślnie. |
| 404 — Nie znaleziono | Nie można odnaleźć kolekcji. |
Treść
| Właściwość | Opis |
|---|---|
id |
Jest to unikatowa nazwa, która identyfikuje kolekcję. |
_rid |
Jest to właściwość wygenerowana przez system. Identyfikator zasobu (_rid) to unikatowy identyfikator, który jest również hierarchiczny dla stosu zasobów w modelu zasobów. Jest on używany wewnętrznie do umieszczania i nawigacji zasobu uprawnień. |
_ts |
Jest to właściwość wygenerowana przez system. Określa ostatni zaktualizowany znacznik czasu zasobu. Wartość jest znacznikiem czasu. |
_self |
Jest to właściwość wygenerowana przez system. Jest to unikatowy adresowy identyfikator URI zasobu. |
_etag |
Jest to właściwość wygenerowana przez system reprezentująca zasób etag wymagany do optymistycznej kontroli współbieżności. |
PartitionKeyRanges |
Jest to lista zakresów kluczy partycji dla kolekcji. Może to być używane do przyrostowego kanału odczytu z nagłówkiem x-ms-documentdb-partitionkeyrangeid . |
Właściwości partitionKeyRanges
| Właściwość | Opis |
|---|---|
id |
Identyfikator zakresu kluczy partycji. Jest to stabilny i unikatowy identyfikator w każdej kolekcji. Może służyć do odczytywania dokumentów według zakresu kluczy partycji. |
maxExclusive |
Maksymalna wartość skrótu klucza partycji dla zakresu kluczy partycji. Do użytku wewnętrznego. |
minInclusive |
Minimalna wartość skrótu klucza partycji dla zakresu kluczy partycji. Do użytku wewnętrznego. |
Przykład
Zakresy kluczy partycji można pobrać, żądając pkranges zasobu w kolekcji. Na przykład następujące żądanie pobiera listę zakresów kluczy partycji dla serverlogs kolekcji:
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
To żądanie zwraca następującą odpowiedź zawierającą metadane dotyczące zakresów kluczy partycji:
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
}