Header permintaan REST Azure Cosmos DB umum

Header permintaan berikut umum untuk semua tugas yang mungkin Anda lakukan dengan SQL API:

Header Diperlukan Jenis Deskripsi
Otorisasi Diperlukan Tali Token otorisasi untuk permintaan tersebut. Untuk informasi selengkapnya tentang membuat token otorisasi yang valid, lihat Kontrol Akses pada Sumber Daya Cosmos DB
Tipe Konten Diperlukan (di PUT, PATCH, dan POST) Tali Untuk POST pada operasi kueri, harus aplikasi/query+json.

Untuk operasi PATCH, harus aplikasi/json_patch+json.

Untuk lampiran, harus diatur ke jenis Mime lampiran. Untuk informasi selengkapnya tentang jenis Mime, lihat Membuat Lampiran

Untuk semua tugas lainnya, harus aplikasi/json.
If-Match Opsional (hanya berlaku pada PUT dan DELETE) Tali Digunakan untuk membuat operasi bersyukur untuk konkurensi optimis. Nilai harus menjadi nilai etag sumber daya.
If-None-Match Opsional (hanya berlaku di GET) Tali Membuat operasi bersyukur untuk hanya dijalankan jika sumber daya telah berubah. Nilainya harus etag sumber daya.
If-Modified-Since Opsional (hanya berlaku di GET) Tanggal Mengembalikan etag sumber daya yang dimodifikasi setelah tanggal yang ditentukan dalam format RFC 1123. Diabaikan saat If-None-Match ditentukan
Agen Pengguna Fakultatif Tali String yang menentukan agen pengguna klien yang melakukan permintaan. Format yang disarankan adalah {nama agen pengguna}/{versi}. Misalnya, SQL API .NET SDK resmi mengatur string User-Agent ke Microsoft.Document.Client/1.0.0.0. Agen pengguna kustom bisa menjadi sesuatu seperti ContosoMarketingApp/1.0.0.
x-ms-activity-id Fakultatif Tali Pengidentifikasi yang disediakan klien untuk operasi, yang digaungkan dalam respons server. Nilai yang direkomendasikan adalah pengidentifikasi unik.
tingkat konsistensi x-ms Fakultatif Tali Tingkat konsistensi mengesampingkan opsi baca terhadap dokumen dan lampiran. Nilai yang valid adalah: Kuat, Terikat, Sesi, atau Akhir (dalam urutan terkuat hingga terlemah). Penimpaan harus sama atau lebih lemah dari tingkat konsistensi akun yang dikonfigurasi.
kelanjutan x-ms Fakultatif Tali Token string dikembalikan untuk kueri dan operasi umpan baca jika ada lebih banyak hasil yang akan dibaca. Klien dapat mengambil halaman hasil berikutnya dengan mengirimkan ulang permintaan dengan header permintaan x-ms-continuation yang diatur ke nilai ini.
tanggal x-ms Diperlukan Tanggal Tanggal permintaan per format tanggal RFC 1123 yang dinyatakan dalam Waktu Universal Terkoordinasi, misalnya, Jumat, 08 Apr 2015 03:52:31 GMT.
x-ms-max-item-count Fakultatif Angka Bilangan bulat yang menunjukkan jumlah maksimum item yang akan dikembalikan per halaman. Jumlah item x-ms-max--1 dapat ditentukan untuk membiarkan layanan menentukan jumlah item yang optimal. Ini adalah nilai konfigurasi yang direkomendasikan untuk x-ms-max-item-count
x-ms-documentdb-partitionkey Fakultatif Array Nilai kunci partisi untuk dokumen yang diminta atau operasi lampiran. Diperlukan untuk operasi terhadap dokumen dan lampiran saat definisi koleksi menyertakan definisi kunci partisi. Nilai ini digunakan untuk mencakup kueri Anda ke dokumen yang cocok dengan kriteria kunci partisi. Secara desain, ini adalah kueri partisi tunggal. Didukung dalam VERSI API 2015-12-16 dan yang lebih baru. Saat ini, SQL API mendukung satu kunci partisi, jadi ini adalah array yang hanya berisi satu nilai.
x-ms-documentdb-query-enablecrosspartition Fakultatif Boolean Saat header ini diatur ke true dan jika kueri Anda tidak memiliki kunci partisi, Azure Cosmos DB akan mengeluarkan kueri di seluruh partisi. Fan out dilakukan dengan mengeluarkan kueri individual ke semua partisi. Untuk membaca hasil kueri, aplikasi klien harus menggunakan hasil dari FeedResponse dan memeriksa properti ContinuationToken. Untuk membaca semua hasil, terus iterasi pada data hingga ContinuationToken null.
x-ms-session-token Diperlukan (hanya untuk konsistensi sesi) Tali Token string yang digunakan dengan konsistensi tingkat sesi. Untuk informasi selengkapnya, lihat
Menggunakan tingkat konsistensi di Cosmos DB
versi x-ms Diperlukan Tali Versi layanan Cosmos DB REST.
Untuk daftar versi API yang didukung, lihat Referensi REST API Azure Cosmos DB
A-IM Fakultatif Tali Menunjukkan permintaan umpan perubahan. Harus diatur ke "Umpan inkremental", atau dihilangkan sebaliknya.
x-ms-documentdb-partitionkeyrangeid Fakultatif Angka Digunakan dalam permintaan umpan perubahan. ID rentang kunci partisi untuk membaca data.
x-ms-cosmos-allow-tentative-writes Fakultatif Boolean Ketika header ini diatur ke true untuk akun Azure Cosmos yang dikonfigurasi dengan beberapa lokasi tulis, Azure Cosmos DB akan memungkinkan penulisan ke semua lokasi. Permintaan tulis dengan nilai header ini diatur ke false (atau jika header tidak ada) akan gagal dengan kode Status Respons 403 dengan pesan kesalahan "Tulisan tidak diizinkan di wilayah".

Lihat juga

  • Last updated on