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:
| Záhlaví | Požadovaný | Typ | Popis |
|---|---|---|---|
| autorizace | Požadovaný | Řetězec | Autorizační token požadavku. Další informace o generování platného autorizačního tokenu najdete v tématu Řízení přístupu k prostředkům služby Cosmos DB |
| typu obsahu | Povinné (u PUT, PATCH a POST) | Řetězec | V případě operací dotazů POST musí být application/query+json. V případě operací PATCH musí být application/json_patch+json. U příloh musí být nastaven 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íněné operaci pro optimistickou souběžnost. Hodnota by měla být hodnotou značky prostředku. |
| If-None-Match | Volitelné (platí jenom pro GET) | Řetězec | Nastaví operaci tak, aby se spouštěla pouze v případě, že se prostředek změnil. Hodnota by měla být značkou prostředku. |
| změněno od | Volitelné (platí jenom pro GET) | Rande | Vrátí etag prostředku změněného po zadaném datu ve formátu RFC 1123. Ignorováno při zadání If-None-Match |
| uživatelského agenta | Volitelný | Řetězec | Řetězec, který určuje klientský uživatelský agent provádějící 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 ozvěna v odpovědi serveru. Doporučená hodnota je jedinečný identifikátor. |
| na úrovni konzistence x-ms | Volitelný | Řetězec | Přepsání na úrovni konzistence pro možnosti čtení u dokumentů a příloh Platné hodnoty jsou: Strong, Bounded, Session nebo Eventual (v pořadí od nejsilnějšího po nejslabší). Přepsání musí být stejné nebo slabší než nakonfigurovaná úroveň konzistence účtu. |
| x-ms-continuation | Volitelný | Řetězec | Řetězcový token vrácený pro dotazy a operace kanálu pro čtení, pokud se mají přečíst další výsledky. Klienti mohou 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 | Požadovaný | Rande | Datum požadavku na formát data RFC 1123 vyjádřený v koordinovaném univerzálním čase, například Pá, 08 dub 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. Návrhem je 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 jeden klíč oddílu, takže se jedná o pole obsahující jenom jednu hodnotu. |
| x-ms-documentdb-query-enablecrosspartition | Volitelný | Booleovský | Pokud je tato hlavička nastavená na hodnotu true a pokud váš dotaz nemá klíč oddílu, služba Azure Cosmos DB dotaz vydědí napříč oddíly. Ventilátor se provádí vydáním jednotlivých dotazů pro všechny oddíly. Pokud chcete číst výsledky dotazu, klientské aplikace by měly využívat výsledky z FeedResponse a zkontrolovat vlastnost ContinuationToken. Pokud chcete přečíst všechny výsledky, pokračujte iterací u dat, dokud parametr ContinuationToken nemá hodnotu null. |
| x-ms-session-token | Povinné (pouze pro konzistenci relace) | Řetězec | Řetězcový token 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 | Požadovaný | Řetězec | Verze služby REST služby Cosmos DB. Seznam podporovaných verzí rozhraní API najdete v referenčních informací k rozhraní REST API služby Azure Cosmos DB |
| rychlých zpráv | Volitelný | Řetězec | Označuje žádost kanálu změn. Musí být nastavená na přírůstkový informační kanál nebo jinak vynechána. |
| x-ms-documentdb-partitionkeyrangeid | Volitelný | Číslo | Používá se v žádosti o kanálu změn. ID rozsahu klíčů oddílu pro čtení dat. |
| x-ms-cosmos-allow-tentative-writes | Volitelný | Booleovský | Pokud je tato hlavička nastavená na hodnotu True pro účty Azure Cosmos nakonfigurované s více umístěními zápisu, 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 chybí hlavička) selžou se stavovým kódem odpovědi 403 s chybovou zprávou Zápisy nejsou povoleny v oblasti. |
Viz také