Dapatkan Dokumen
Azure Cosmos DB adalah database multi-model yang didistribusikan secara global dengan dukungan untuk beberapa API. Artikel ini membahas SQL API untuk Azure Cosmos DB.
Operasi mengambil Get Document dokumen dengan kunci partisi dan kunci dokumennya.
Minta
| Metode | Meminta URI | Deskripsi |
|---|---|---|
| GET | https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs/{doc-id} | Perhatikan bahwa {databaseaccount} adalah nama akun Azure Cosmos DB yang dibuat di bawah langganan Anda. Nilai {db-id} adalah nama/ID database yang dihasilkan pengguna, bukan ID yang dihasilkan sistem (rid). Nilai {coll-id} adalah nama koleksi. Nilai {doc-id} adalah ID dokumen yang akan diambil. |
Header
Lihat Header permintaan Rest Azure Cosmos DB umum untuk header yang digunakan oleh semua permintaan Cosmos DB. Header respons penting untuk Baca Dokumen adalah sebagai berikut:
| Header | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|
| If-None-Match | Opsional | String | Nilainya harus etag sumber daya. Membuat operasi bersyar, yaitu, respons menyertakan isi hanya nilai dalam database yang berbeda dari nilai yang ditentukan di header. |
| x-ms-documentdb-partitionkey | Opsional | Array | Nilai kunci partisi untuk dokumen yang akan dibaca. Harus disertakan jika dan hanya jika koleksi dibuat dengan definisi partitionKey . |
| tingkat konsistensi x-ms | Opsional | String | Ini adalah penimpaan tingkat konsistensi. Nilai yang valid adalah: Kuat, Terikat, Sesi, atau Akhirnya (dalam urutan terkuat hingga terlemah). Penimpaan harus sama atau lebih lemah dari tingkat konsistensi akun yang dikonfigurasi. |
| x-ms-session-token | Opsional | String | Token string yang digunakan dengan konsistensi tingkat sesi. Klien harus menggemakan nilai baca terbaru header ini selama permintaan baca untuk konsistensi sesi. |
Isi
Tidak ada.
Respons
Mengembalikan konten dokumen yang diminta.
Header
Lihat Header respons Rest Azure Cosmos DB umum untuk header yang dikembalikan oleh semua respons Azure Cosmos DB. Header respons penting untuk Dapatkan Dokumen adalah sebagai berikut:
| Header | Jenis | Deskripsi |
|---|---|---|
| x-ms-request-charge | Telepon | Jumlah unit permintaan yang digunakan oleh operasi. |
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. |
| 304 Tidak Diubah | Dokumen yang diminta tidak diubah sejak nilai eTag yang ditentukan di header If-Match. Layanan menampilkan isi respons kosong. |
| 400 Permintaan Buruk | Penimpaan yang diatur dalam header tingkat konsistensi x-ms lebih kuat dari yang ditetapkan selama pembuatan akun. Misalnya, jika tingkat konsistensi adalah Sesi, penimpaan tidak boleh Kuat atau Terikat. |
| 404 Tidak Ditemukan | Dokumen tidak lagi menjadi sumber daya, yaitu dokumen telah dihapus. |
Isi
| Properti | Deskripsi |
|---|---|
| id | Ini adalah nama unik yang digunakan untuk mengidentifikasi dokumen, yaitu, tidak ada dua dokumen yang dapat berbagi id yang sama. Id tidak boleh melebihi 255 karakter. |
| custom | JSON yang ditentukan pengguna apa pun. |
| _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 dokumen. |
| _Ts | Ini adalah properti yang dihasilkan sistem. Ini menentukan tanda waktu terakhir yang diperbarui dari sumber daya. Nilainya dalam waktu Unix. |
| _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 menentukan etag sumber daya yang diperlukan untuk kontrol konkurensi optimis. |
| Lampiran | Ini adalah properti yang dihasilkan sistem yang menentukan jalur yang dapat diatasi untuk sumber daya lampiran. |
{
"id": "SalesOrder1",
"ponumber": "PO18009186470",
"OrderDate": "2005-07-01T00:00:00",
"ShippedDate": "0001-01-01T00:00:00",
"AccountNumber": "Account1",
"SubTotal": 419.4589,
"TaxAmount": 12.5838,
"Freight": 472.3108,
"TotalDue": 985.018,
"Items": [
{
"OrderQty": 1,
"ProductId": 760,
"UnitPrice": 419.4589,
"LineTotal": 419.4589
}
],
"_rid": "d9RzAJRFKgwBAAAAAAAAAA==",
"_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwBAAAAAAAAAA==/",
"_etag": "\"0000d986-0000-0000-0000-56f9e25b0000\"",
"_ts": 1459216987,
"_attachments": "attachments/"
}
Contoh
GET https://querydemo.documents.azure.com/dbs/testdb/colls/testcoll/docs/SalesOrder1 HTTP/1.1
x-ms-documentdb-partitionkey: ["Account1"]
x-ms-date: Tue, 29 Mar 2016 02:03:06 GMT
authorization: type%3dmaster%26ver%3d1.0%26sig%3dyhmbeaUDy6NCOyWr0t7Cxx4aMT4Yx%2bJnRAs%2br8Theyw%3d
Cache-Control: no-cache
User-Agent: Microsoft.Azure.Documents.Client/1.6.0.0
x-ms-version: 2015-12-16
Accept: application/json
Host: querydemo.documents.azure.com
Cookie: x-ms-session-token#0=772; x-ms-session-token=772
HTTP/1.1 200 Ok
Cache-Control: no-store, no-cache
Pragma: no-cache
Transfer-Encoding: chunked
Content-Type: application/json
Content-Location: https://querydemo.documents.azure.com/dbs/testdb/colls/testcoll/docs/SalesOrder1
Server: Microsoft-HTTPAPI/2.0
Strict-Transport-Security: max-age=31536000
x-ms-last-state-change-utc: Mon, 28 Mar 2016 14:47:03.949 GMT
etag: "0000d986-0000-0000-0000-56f9e25b0000"
x-ms-resource-quota: documentSize=10240;documentsSize=10485760;collectionSize=10485760;
x-ms-resource-usage: documentSize=0;documentsSize=2;collectionSize=2;
x-ms-schemaversion: 1.1
x-ms-alt-content-path: dbs/testdb/colls/testcoll
x-ms-content-path: d9RzAJRFKgw=
x-ms-request-charge: 1
x-ms-serviceversion: version=1.6.52.5
x-ms-activity-id: c22bc349-2c02-4b80-81b9-a2d758c92902
x-ms-session-token: 0:772
Set-Cookie: x-ms-session-token#0=772; Domain=querydemo.documents.azure.com; Path=/dbs/testdb/colls/testcoll
Set-Cookie: x-ms-session-token=772; Domain=querydemo.documents.azure.com; Path=/dbs/testdb/colls/testcoll
x-ms-gatewayversion: version=1.6.52.5
Date: Tue, 29 Mar 2016 02:03:06 GMT
{
"id": "SalesOrder1",
"ponumber": "PO18009186470",
"OrderDate": "2005-07-01T00:00:00",
"ShippedDate": "0001-01-01T00:00:00",
"AccountNumber": "Account1",
"SubTotal": 419.4589,
"TaxAmount": 12.5838,
"Freight": 472.3108,
"TotalDue": 985.018,
"Items": [
{
"OrderQty": 1,
"ProductId": 760,
"UnitPrice": 419.4589,
"LineTotal": 419.4589
}
],
"_rid": "d9RzAJRFKgwBAAAAAAAAAA==",
"_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwBAAAAAAAAAA==/",
"_etag": "\"0000d986-0000-0000-0000-56f9e25b0000\"",
"_ts": 1459216987,
"_attachments": "attachments/"
}