Mendapatkan rentang kunci Partisi

  • Artikel

Melakukan GET pada sumber daya anak koleksi pkranges tertentu mengambil daftar rentang kunci partisi untuk koleksi.

Catatan

Artikel referensi API ini menunjukkan cara membuat sumber daya menggunakan API sarana data Azure Cosmos DB. Dengan API sarana data, Anda dapat mengonfigurasi opsi dasar seperti kebijakan pengindeksan, kunci partisi seperti yang Anda dapat dengan Cosmos DB SDK. Jika Anda memerlukan dukungan fitur lengkap untuk semua sumber daya Azure Cosmos DB, sebaiknya gunakan Penyedia Sumber Daya Cosmos DB.

Minta

Metode Meminta URI Deskripsi
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/pkranges Perhatikan bahwa {databaseaccount} adalah nama akun Azure Cosmos DB yang dibuat di bawah langganan Anda. {db-id} Id database dan nilai {coll-id} adalah id koleksi.

Header

Lihat Header permintaan Rest Azure Cosmos DB umum untuk header yang digunakan oleh semua permintaan Cosmos DB.

Isi

Tidak ada.

Respons

Mengembalikan daftar rentang kunci partisi untuk koleksi.

Header

Lihat Header respons Rest Azure Cosmos DB umum untuk header yang dikembalikan oleh semua respons Cosmos DB.

Kode status

Tabel berikut mencantumkan kode status umum yang dikembalikan oleh operasi ini. Untuk daftar lengkap kode status, lihat Kode Status HTTP.

Kode status HTTP Deskripsi
200 Ok Operasi berhasil.
404 Tidak Ditemukan Koleksi tidak ditemukan.

Isi

Properti Deskripsi
id Ini adalah nama unik yang mengidentifikasi koleksi.
_rid Ini adalah properti yang dihasilkan sistem. ID sumber daya (_rid) adalah pengidentifikasi unik yang juga hierarkis per tumpukan sumber daya pada model sumber daya. Ini digunakan secara internal untuk penempatan dan navigasi sumber daya izin.
_ts Ini adalah properti yang dihasilkan sistem. Ini menentukan tanda waktu terakhir yang diperbarui dari sumber daya. Nilainya adalah tanda waktu.
_self Ini adalah properti yang dihasilkan sistem. Ini adalah URI unik yang dapat diatasi untuk sumber daya.
_etag Ini adalah properti yang dihasilkan sistem yang mewakili sumber daya etag yang diperlukan untuk kontrol konkurensi optimis.
PartitionKeyRanges Ini adalah daftar rentang kunci partisi untuk koleksi. Ini dapat digunakan untuk readfeed inkremental dengan x-ms-documentdb-partitionkeyrangeid header .

Properti PartitionKeyRanges

Properti Deskripsi
id

ID untuk rentang kunci partisi. Ini adalah ID yang stabil dan unik dalam setiap koleksi.

Dapat digunakan untuk membaca dokumen berdasarkan rentang kunci partisi.
maxExclusive Nilai hash kunci partisi maksimum untuk rentang kunci partisi. Untuk penggunaan internal.
minInclusive Nilai hash kunci partisi minimum untuk rentang kunci partisi. Untuk penggunaan internal.

Contoh

Anda dapat mengambil Rentang Kunci Partisi dengan meminta pkranges sumber daya dalam koleksi. Misalnya permintaan berikut mengambil daftar rentang kunci partisi untuk serverlogs koleksi:

    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

Permintaan ini mengembalikan respons berikut yang berisi metadata tentang rentang kunci partisi:

    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
    }

Lihat juga