Běžné hlavičky požadavků REST služby Azure Cosmos DB
Následující hlavičky požadavků jsou společné pro všechny úlohy, které můžete provádět s rozhraním SQL API:
| Hlavička | Požaduje se | Typ | Description |
|---|---|---|---|
| Autorizace | Vyžadováno | Řetězec | Autorizační token pro požadavek. Další informace o generování platného autorizačního tokenu najdete v tématu Access Control v prostředcích služby Cosmos DB. |
| Typ obsahu | Povinné (na PUT, PATCH a POST) | Řetězec | Pro operace POST pro operace dotazu musí být application/query+json. Pro operace PATCH musí být application/json_patch+json. U příloh musí být nastaven na typ MIME přílohy. Další informace o typech MIME najdete v tématu Vytvoření přílohy. Pro všechny ostatní úlohy musí být application/json. |
| If-Match | Volitelné (platí pouze pro PUT a DELETE) | Řetězec | Používá se k podmínce operace pro optimistickou souběžnost. Hodnota by měla být hodnota značky prostředku. |
| If-None-Match | Volitelné (platí jenom pro GET) | Řetězec | Nastaví operaci tak, aby se spustila jenom v případě, že se prostředek změnil. Hodnota by měla být značka prostředku. |
| Pokud se změnilo od té doby | Volitelné (platí jenom pro GET) | Datum | Vrátí jmenovku prostředku změněného po zadaném datu ve formátu RFC 1123. Ignorováno při zadání if-None-Match |
| User-Agent | Volitelné | Řetězec | Řetězec, který určuje uživatelského agenta klienta provádějícího požadavek. Doporučený formát je {user agent name}/{version}. Například oficiální sada SQL API .NET SDK nastaví řetězec User-Agent na Microsoft.Document.Client/1.0.0.0. Vlastní uživatelský agent může být něco jako ContosoMarketingApp/1.0.0. |
| x-ms-activity-id | Volitelné | Řetězec | Klient zadal identifikátor operace, který se opakuje v odpovědi serveru. Doporučená hodnota je jedinečný identifikátor. |
| x-ms-consistency-level | Volitelné | Řetězec | Úroveň konzistence přepíše možnosti čtení u dokumentů a příloh. 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-continuation | Volitelné | Řetězec | Token řetězce vrácený pro dotazy a operace pro čtení, pokud je potřeba přečíst další výsledky. Klienti můžou načíst další stránku výsledků opětovným odesláním požadavku s hlavičkou požadavku x-ms-continuation nastavenou na tuto hodnotu. |
| x-ms-date | Vyžadováno | Datum | Datum žádosti podle formátu data RFC 1123 vyjádřené v koordinovaném univerzálním čase, například Pá, 08 Apr 2015 03:52:31 GMT. |
| x-ms-max-item-count | Volitelné | Číslo | Celé číslo označující maximální počet položek, které se mají vrátit na stránku. Je možné zadat x-ms-max-item-count -1, aby služba určila optimální počet položek. Toto je doporučená hodnota konfigurace pro x-ms-max-item-count. |
| x-ms-documentdb-partitionkey | Volitelné | Pole | Hodnota klíče oddílu pro požadovanou operaci dokumentu nebo přílohy. Vyžaduje se pro operace s dokumenty a přílohami, pokud definice kolekce obsahuje definici klíče oddílu. Tato hodnota slouží k určení rozsahu dotazu na dokumenty, které odpovídají kritériím klíče oddílu. Záměrně se jedná o dotaz na jeden oddíl. Podporováno ve verzích rozhraní API 2015-12-16 a novějších. Rozhraní SQL API v současné době podporuje klíč s jedním oddílem, takže se jedná o pole obsahující pouze jednu hodnotu. |
| x-ms-documentdb-query-enablecrosspartition | Volitelné | Logická hodnota | Pokud je tato hlavička nastavená na hodnotu true a váš dotaz nemá klíč oddílu, Azure Cosmos DB tento dotaz rozdmýchá napříč oddíly. Vysouvání se provádí vydáváním jednotlivých dotazů na všechny oddíly. Pokud chcete číst výsledky dotazu, klientské aplikace by měly využívat výsledky z FeedResponse a zkontrolovat continuationToken vlastnost. Pokud chcete přečíst všechny výsledky, pokračujte v iteraci dat, dokud hodnota ContinuationToken nebude mít hodnotu null. |
| x-ms-session-token | Povinné (pouze pro konzistenci relací) | Řetězec | Token řetězce používaný s konzistencí na úrovni relace. Další informace najdete v tématu Použití úrovní konzistence ve službě Cosmos DB |
| x-ms-version | Vyžadováno | Řetězec | Verze služby REST Cosmos DB. Seznam podporovaných verzí rozhraní API najdete v tématu Referenční informace k rozhraní REST API služby Azure Cosmos DB. |
| A-im | Volitelné | Řetězec | Označuje žádost o kanál změn . Musí být nastaven na "Přírůstkový informační kanál" nebo jinak vynechaný. |
| x-ms-documentdb-partitionkeyrangeid | Volitelné | Číslo | Používá se v žádostech kanálu změn . ID rozsahu klíčů oddílu pro čtení dat. |
| x-ms-cosmos-allow-tentative-writes | Volitelné | Logická hodnota | Pokud je tato hlavička nastavená na hodnotu true pro účty Služby Azure Cosmos nakonfigurované s více umístěními pro zápis, azure Cosmos DB povolí zápisy do všech umístění. Požadavky na zápis s hodnotou této hlavičky nastavenou na false (nebo pokud hlavička chybí) selžou se stavovým kódem odpovědi 403 s chybovou zprávou "Zápisy nejsou v dané oblasti povoleny". |
Viz také