Hlavičky
Tento článek obsahuje odkazy na referenční stránky pro hlavičky používané s rozhraním REST API Azure App Configuration.
Hlavičky požadavku
Následující tabulka popisuje běžné hlavičky požadavků používané v Azure App Configuration.
Hlavička | Popis | Příklad |
---|---|---|
Autorizace | Slouží k ověření požadavku na službu. Viz bod 14.8. | Authorization: HMAC-SHA256 Credential=<Credential>&SignedHeaders=Host;x-ms-date;x-ms-content-sha256&Signature=<Signature> |
Přijetí | Informuje server, jaký typ média klient přijme v odpovědi HTTP. Viz bod 14.1. | Accept: application/vnd.microsoft.appconfig.kv+json; |
Accept-Datetime | Požádá server, aby vrátil svůj obsah jako reprezentaci předchozího stavu. Hodnota této hlavičky je požadované datum a čas daného stavu. Viz RFC 7089. | Accept-Datetime: Sat, 12 May 2018 02:10:00 GMT |
Typ obsahu | Obsahuje typ média obsahu v textu požadavku HTTP. Viz bod 14.17. | Content-Type: application/vnd.microsoft.appconfig.kv+json; charset=utf-8; |
Date (Datum) | Datum a čas vystavení požadavku HTTP. Tato hlavička se používá při ověřování HMAC. Viz bod 14.18. | Date: Fri, 11 May 2018 18:48:36 GMT |
Hostitel | Určuje tenanta, pro kterého byla žádost vystavena. Tato hlavička se používá při ověřování HMAC. Viz bod 14.23. | Host: contoso.azconfig.io |
If-Match | Slouží k podmíněnému nastavení požadavku HTTP. Tento požadavek by měl být úspěšný pouze v případě, že značka ETag cílového prostředku odpovídá hodnotě této hlavičky. Hodnota *se shoduje s libovolnou značkou ETag. Viz bod 14.24. | If-Match: "4f6dd610dd5e4deebc7fbaef685fb903" |
If-None-Match | Slouží k podmíněnému nastavení požadavku HTTP. Tento požadavek by měl být úspěšný pouze v případě, že značka ETag cílového prostředku neodpovídá hodnotě této hlavičky. Hodnota *se shoduje s libovolnou značkou ETag. Viz bod 14.26. | If-None-Match: "4f6dd610dd5e4deebc7fbaef685fb903" |
Synchronizační token | Slouží k zajištění konzistence v reálném čase během posloupnosti požadavků. | Sync-Token: jtqGc1I4=MDoyOA==;sn=28 |
x-ms-client-request-id | Jedinečné ID poskytnuté klientem, který slouží ke sledování doby odezvy žádosti. | x-ms-client-request-id: 00000000-0000-0000-0000-000000000000 |
x-ms-content-sha256 | Algoritmus hash sha256 textu požadavku HTTP. Tato hlavička se používá při ověřování HMAC. | x-ms-content-sha256: 47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU= |
x-ms-date | Tato hlavička může být nastavena a použita místo Date záhlaví, pokud k záhlaví data není možné získat přístup. Tato hlavička se používá při ověřování HMAC. |
x-ms-date: Fri, 11 May 2018 18:48:36 GMT |
x-ms-return-client-request-id | Používá se ve spojení se záhlavím x-ms-client-request-id . Pokud je hodnota této hlavičky true, bude server požádán, aby vrátil hodnotu hlavičky x-ms-client-request-id požadavku. |
x-ms-return-client-request-id: true |
Hlavičky odpovědi
Server může do svých odpovědí obsahovat následující hlavičky HTTP.
Hlavička | Popis | Příklad |
---|---|---|
Typ obsahu | Obsahuje typ média obsahu v textu odpovědi HTTP. Viz bod 14.17. | Content-Type: application/vnd.microsoft.appconfig.kv+json; charset=utf-8; |
Etag | Neprůsvný token představující stav daného prostředku. Lze použít v podmíněných operacích. Viz bod 14.19. | ETag: "4f6dd610dd5e4deebc7fbaef685fb903" |
Naposledy změněno | Popisuje, kdy byl požadovaný prostředek naposledy změněn. Formátovaný jako HTTP-Date. Viz bod 14.29. | Last-Modified: Tue, 05 Dec 2017 02:41:26 GMT |
Odkaz | Poskytuje odkazy na prostředky, které souvisejí s odpovědí. Toto záhlaví se používá k stránkování pomocí dalšího odkazu. Viz RFC 5988. | Link: </kv?after={token}>; rel="next" |
Memento-Datetime | Označuje, že obsah obsažený v odpovědi představuje předchozí stav. Hodnota této hlavičky je datetime daného stavu. Viz RFC 7089. | Memento-Datetime: Sat, 12 May 2018 02:10:00 GMT |
retry-after-ms | Poskytuje doporučenou dobu (v milisekundách), po které může klient čekat před opakováním neúspěšného požadavku. | retry-after-ms: 10 |
x-ms-request-id | Jedinečné ID vygenerované serverem, které se používá ke sledování požadavku v rámci služby. | x-ms-request-id: 00000000-0000-0000-0000-000000000000 |
Www–Authenticate | Používá se k výzvě klientům k ověření a k poskytnutí důvodu, proč pokus o ověření selhal. Viz bod 14.47. | WWW-Authenticate: HMAC-SHA256 error="invalid_token" error_description="Invalid Signature" |