Získání dokumentu
Azure Cosmos DB je globálně distribuovaná databáze pro více modelů s podporou několika rozhraní API. Tento článek se věnuje rozhraní SQL API pro službu Azure Cosmos DB.
Operace Get Document načte dokument podle klíče oddílu a klíče dokumentu.
Žádost
| Metoda | Identifikátor URI žádosti | Popis |
|---|---|---|
| GET | https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{id_coll}/docs/{doc-id} | Všimněte si, že {databaseaccount} je název účtu služby Azure Cosmos DB vytvořeného v rámci vašeho předplatného. Hodnota {db-id} je uživatelem vygenerované jméno nebo ID databáze, nikoli systémově vygenerované ID (rid). Hodnota {coll-id} je název kolekce. Hodnota {doc-id} je ID dokumentu, který se má načíst. |
Hlavičky
Viz Běžné hlavičky požadavků REST služby Azure Cosmos DB pro hlavičky, které používají všechny požadavky služby Cosmos DB. Důležitá záhlaví odpovědi pro čtení dokumentu jsou následující:
| Hlavička | Požaduje se | Typ | Description |
|---|---|---|---|
| If-None-Match | Volitelné | Řetězec | Hodnota by měla být značka prostředku. Operace je podmíněná, to znamená, že odpověď obsahuje tělo, pouze hodnota v databázi se liší od zadané hodnoty v hlavičce. |
| x-ms-documentdb-partitionkey | Volitelné | Pole | Hodnota klíče oddílu pro dokument, který se má přečíst. Musí být zahrnuta pouze v případě, že je kolekce vytvořena s definicí partitionKey . |
| x-ms-consistency-level | Volitelné | Řetězec | Jedná se o přepsání úrovně konzistence. Platné hodnoty jsou: Silná, Ohraničená, Relace nebo Konečná (v pořadí od nejsilnějších po nejslabší). Přepsání musí být stejné nebo slabší než nakonfigurovaná úroveň konzistence účtu. |
| x-ms-session-token | Volitelné | Řetězec | Token řetězce používaný s konzistencí na úrovni relace. Klienti musí během požadavků na čtení z důvodu konzistence relací opakovat nejnovější hodnotu čtení této hlavičky. |
Text
Žádné
Odpověď
Vrátí obsah požadovaného dokumentu.
Hlavičky
Viz Běžné hlavičky odpovědí REST služby Azure Cosmos DB pro hlavičky, které jsou vráceny všemi odpověďmi služby Azure Cosmos DB. Důležité hlavičky odpovědi pro získání dokumentu jsou následující:
| Hlavička | Typ | Description |
|---|---|---|
| x-ms-request-charge | Číslo | Počet jednotek požadavků spotřebovaných operací. |
Stavové kódy
Následující tabulka uvádí běžné stavové kódy vrácené touto operací. Úplný seznam stavových kódů najdete v tématu Stavové kódy HTTP.
| Stavový kód HTTP | Popis |
|---|---|
| 200 Ok | Operace byla úspěšná. |
| 304 Neupraveno | Požadovaný dokument nebyl změněn, protože zadaná hodnota eTag v hlavičce If-Match. Služba vrátí prázdný text odpovědi. |
| 400 – Chybný požadavek | Přepsání nastavené v hlavičce x-ms-consistency-level je silnější než nastavení nastavené při vytváření účtu. Pokud je například úroveň konzistence Relace, nemůže být přepsání silné nebo ohraničené. |
| 404 Nenalezeno | Dokument už není prostředkem, to znamená, že byl odstraněn. |
Text
| Vlastnost | Popis |
|---|---|
| id | Jedná se o jedinečný název, který se používá k identifikaci dokumentu, to znamená, že žádné dva dokumenty nemohou sdílet stejné ID. ID nesmí být delší než 255 znaků. |
| vlastní | Libovolný soubor JSON definovaný uživatelem. |
| _Zbavit | Jedná se o systém vygenerovanou vlastnost. ID prostředku (_rid) je jedinečný identifikátor, který je také hierarchický podle zásobníku prostředků v modelu prostředků. Používá se interně pro umístění a navigaci v tomto prostředku dokumentu. |
| _Ts | Jedná se o systém vygenerovanou vlastnost. Určuje časové razítko poslední aktualizace prostředku. Hodnota je v unixovém čase. |
| _Vlastní | Jedná se o systém vygenerovanou vlastnost. Jedná se o jedinečný adresovatelný identifikátor URI prostředku. |
| _Etag | Jedná se o systémově vygenerovanou vlastnost, která určuje etag prostředku vyžadovanou pro optimistické řízení souběžnosti. |
| Přílohy | Jedná se o systém vygenerovanou vlastnost, která určuje adresovatelnou cestu pro prostředek příloh. |
{
"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/"
}
Příklad
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/"
}