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 požadavku. Další informace o generování platného autorizačního tokenu najdete v tématu Access Control o prostředcích Cosmos DB.
Typ obsahu Povinné (na PUT, PATCH a POST) Řetězec V případě operací s dotazem POST musí být application/query+json.

V případě operací PATCH musí být aplikace/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í jenom 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 spustila pouze v případě, že se prostředek změnil. Hodnota by měla být značkou prostředku.
If-Modified-Since Volitelné (platí jenom pro GET) Datum Vrátí značku prostředku změněného po zadaném datu ve formátu RFC 1123. Ignorováno při zadání parametru If-None-Match
User-Agent 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 API .NET SDK SQL nastaví řetězec User-Agent na Microsoft.Document.Client/1.0.0.0. Vlastní uživatel-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 ozval v odpovědi serveru. Doporučená hodnota je jedinečný identifikátor.
x-ms-consistency-level Volitelné Řetězec Přepsání úrovně 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 s informačním kanálem pro čtení, pokud se mají čí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 požadavku na formát data RFC 1123 vyjádřený ve formátu koordinovaného univerzálního času, například Pá, 08. dubna 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. Lze 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. V současné době rozhraní API SQL podporuje jeden klíč oddílu, 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 pokud váš dotaz nemá klíč oddílu, Azure Cosmos DB dotaz v různých oddílech vytáčí. Ventilátor se provádí vydává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 číst všechny výsledky, pokračujte iterací dat, dokud nebude hodnota ContinuationToken null.
x-ms-session-token Povinné (pouze pro konzistenci relace) Řetězec Token řetězce používaný s konzistencí na úrovni relace. Další informace najdete v tématu
Použití úrovní konzistence v databázi Cosmos
x-ms-version Vyžadováno Řetězec Verze služby REST služby Cosmos DB
Seznam podporovaných verzí rozhraní API najdete v referenčních informacích k rozhraní REST API služby Azure Cosmos DB.
Rychlé zprávy Volitelné Řetězec Označuje žádost o kanál změn . Musí být nastavená na "Přírůstkový informační kanál", nebo je vynechat jinak.
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 true pro účty Azure Cosmos nakonfigurovaných 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 v oblasti povoleny".

Viz také