INTEGRITY Dokumentace

Parametry vlastních chyb

Vlastní pravidla chyb

Vlastní pravidla chyb určují, kdy se vyvolá vlastní chyba a jaký obsah se návštěvníkům zobrazí. Parametry pravidla jsou následující:

Typ odpovědi

Název API: N/A (zpracováno prostřednictvím asset_name a content_type parametry)

Typ obsahu vložené odpovědi odeslané návštěvníkovi webu (JSON, HTML, Text nebo XML), nebo Vlastní chybové aktivum pokud odesíláte obsah objektu vlastní chybové stránky.

Při použití API musíte nastavit buď asset_name nebo nastavte obě content_type a content parametry. Viz JSON response / HTML response / Text response / XML response.

Kód odpovědi

Název API: status_code Integer Volitelné

Stavový kód HTTP odpovědi. Pokud je zadán, tato hodnota přepíše aktuální stavový kód odpovědi.

Stavový kód musí být v rozsahu 400 a 999.

Prostředek

Název API: asset_name String Volitelné

Název vlastní chybové aktivum který jste dříve nahráli (v dashboardu můžete prostředek vytvořit při vytváření pravidla). Prostředek může obsahovat chybové tokeny které budou před odesláním chybové odpovědi návštěvníkovi nahrazeny skutečnými hodnotami.

Vlastní chybové pravidlo může odkazovat pouze na zdroj definovaný ve stejném rozsahu jako pravidlo, tedy ve stejné zóně nebo účtu.

V dashboardu je tento parametr k dispozici pouze v případě, že vyberete Custom error asset v Typ odpovědi.

Při použití API musíte zadat buď asset_name nebo content .

JSON response / HTML response / Text response / XML response

Názvy API: content String Volitelné a content_type String Povinné

Tělo odpovědi, které se má vrátit. Může obsahovat chybové tokeny které budou před odesláním chybové odpovědi návštěvníkovi nahrazeny skutečnými hodnotami.

Musíte zadat buď asset_name nebo content .

Maximální velikost obsahu je 10 KB.

Při použití API musíte také nastavit content_type parametr, který určuje typ obsahu vrácené odpovědi. Hodnota musí být jedna z následujících:

Vlastní chybová aktiva

vlastní chybové aktivum odpovídá webovému prostředku, jako je HTML stránka (včetně všech odkazovaných obrázků, CSS a kódu JavaScript), kterou Cloudflare načte a uloží na základě zadané adresy URL, aby ji poté zobrazil návštěvníkům jako chybovou stránku.

Vlastní chybová aktiva mají následující parametry:

Název prostředku

Název API: name String Povinné

Název vlastního chybového assetu. Příklad hodnoty: "500_error_template".

Název assetu může obsahovat následující znaky:

Maximální délka je 200 znaků.

Popis

Název API: description String Volitelné

Řetězec popisující vlastní chybový zdroj. Příklad hodnoty: "Standard 5xx error template page".

Adresa prostředku

Název API: url String Povinné

URL stránky, kterou má Cloudflare načíst a uložit, aby ji později zobrazoval návštěvníkům jako chybovou stránku podle nakonfigurovaného vlastní chybová pravidla. Příklad hodnoty: "https://example.com/errors/500.html".

Když vytváříte nebo aktualizujete asset a zadáte URL adresu, Cloudflare shromáždí všechny obrázky, CSS a JavaScript kód použitý na stránce, minifikuje obsah a uloží ho interně.

Obsah stránky na zadané URL může obsahovat chybové tokeny které budou před odesláním chybové odpovědi návštěvníkovi nahrazeny skutečnými hodnotami.

Při použití dashboardu můžete později spustit další načtení, abyste získali nejnovější verzi stránky i s jejími zdroji, a uložit ji interně.

Pokud při použití API aktualizujete asset a zadáte stejnou URL adresu, Cloudflare tuto URL adresu znovu načte i s jejími zdroji a uloží ji interně.

Maximální velikost assetu je 1.5 MB.