Bölüm anahtarı aralıklarını alma

  • Makale

Belirli bir koleksiyonun alt kaynağında bir GET gerçekleştirmek, koleksiyon pkranges için bölüm anahtarı aralıklarının listesini alır.

Not

Bu API başvuru makalelerinde Azure Cosmos DB veri düzlemi API'sini kullanarak kaynak oluşturma adımları gösterilmektedir. Veri düzlemi API'siyle dizin oluşturma ilkesi, bölüm anahtarları gibi cosmos DB SDK'ları gibi temel seçenekleri yapılandırabilirsiniz. Tüm Azure Cosmos DB kaynakları için tam özellik desteğine ihtiyacınız varsa Cosmos DB Kaynak Sağlayıcısı'nı kullanmanızı öneririz.

İstek

Yöntem İstek URI'si Açıklama
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/pkranges değerinin {databaseaccount} , aboneliğiniz altında oluşturulan Azure Cosmos DB hesabının adı olduğunu unutmayın. {db-id} Veritabanının kimliği ve {coll-id} değeri koleksiyonun kimliğidir.

Üst Bilgiler

Tüm Cosmos DB istekleri tarafından kullanılan üst bilgiler için bkz. Yaygın Azure Cosmos DB REST isteği üst bilgileri.

Gövde

Yok.

Yanıt

Koleksiyon için bölüm anahtarı aralıklarının listesini döndürür.

Üst Bilgiler

Tüm Cosmos DB yanıtları tarafından döndürülen üst bilgiler için bkz. Genel Azure Cosmos DB REST yanıt üst bilgileri.

Durum kodları

Aşağıdaki tabloda bu işlem tarafından döndürülen genel durum kodları listelenmektedir. Durum kodlarının tam listesi için bkz. HTTP Durum Kodları.

HTTP durum kodu Açıklama
200 Tamam İşlem başarılı oldu.
404 Bulunamadı Koleksiyon bulunamadı.

Gövde

Özellik Açıklama
id Bu, koleksiyonu tanımlayan benzersiz addır.
_rid Bu, sistem tarafından oluşturulan bir özelliktir. Kaynak kimliği (_rid), kaynak modelinde kaynak yığını başına da hiyerarşik olan benzersiz bir tanımlayıcıdır. İzin kaynağının yerleşimi ve gezintisi için dahili olarak kullanılır.
_ts Bu, sistem tarafından oluşturulan bir özelliktir. Kaynağın son güncelleştirilmiş zaman damgasını belirtir. Değer bir zaman damgasıdır.
_self Bu, sistem tarafından oluşturulan bir özelliktir. Kaynak için benzersiz adreslenebilir URI'dir.
_etag Bu, iyimser eşzamanlılık denetimi için gereken kaynağı etag temsil eden sistem tarafından oluşturulan bir özelliktir.
PartitionKeyRanges Bu, koleksiyonun bölüm anahtarı aralıklarının listesidir. Bu, üst bilgiyle x-ms-documentdb-partitionkeyrangeid artımlı okuma akışı için kullanılabilir.

PartitionKeyRanges Özellikleri

Özellik Açıklama
id

Bölüm anahtarı aralığının kimliği. Bu, her koleksiyondaki kararlı ve benzersiz bir kimliktir.

Bölüm anahtarı aralığına göre belgeleri okumak için kullanılabilir.
maxExclusive Bölüm anahtarı aralığı için en yüksek bölüm anahtarı karma değeri. dahili kullanım için.
minInclusive Bölüm anahtarı aralığı için en düşük bölüm anahtarı karma değeri. dahili kullanım için.

Örnek

Bir koleksiyondaki kaynağı isteyerek pkranges Bölüm Anahtarı Aralıklarını alabilirsiniz. Örneğin, aşağıdaki istek koleksiyon için serverlogs bölüm anahtarı aralıklarının listesini alır:

    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

Bu istek, bölüm anahtarı aralıklarıyla ilgili meta verileri içeren aşağıdaki yanıtı döndürür:

    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
    }

Ayrıca Bkz.