← Cloudflare DDoS Protection / ddos-protection / advanced-ddos-systems / api / programmable-flow-protection

Objekty JSON

Tato stránka obsahuje příklady objektů JSON používaných v rozhraní API Programmable Flow Protection.

Program

{
  "id": "31c70c65-9f81-4669-94ed-1e1e041e7b06",
  "name": "rate-limiter",
  "status": "success",
  "created_on": "2024-01-01T13:06:04.721954+01:00",
  "modified_on": "2024-01-01T13:06:04.721954+01:00"
}

Pole	Popis
`id`	Jedinečný identifikátor programu.
`name`	Název programu odvozený z názvu nahraného souboru.
`status`	Stav kompilace a ověření. Jedna z hodnot `success` nebo `failed`. Programy se stavem `failed` stavu se po 30 dnech nečinnosti automaticky odstraní.
`created_on`	Časové razítko vytvoření programu.
`modified_on`	Časové razítko poslední změny programu.

Pravidlo

{
  "id": "20b99eb6-8b48-48dd-a5b9-a995a0843b57",
  "program_id": "31c70c65-9f81-4669-94ed-1e1e041e7b06",
  "scope": "region",
  "name": "WEUR",
  "mode": "enabled",
  "expression": "ip.dst in { 192.0.2.0/24 }",
  "created_on": "2024-01-01T13:10:38.762503+01:00",
  "modified_on": "2024-01-01T13:10:38.762503+01:00"
}

Pole	Popis
`id`	Jedinečný identifikátor pravidla.
`program_id`	Identifikátor programu, který toto pravidlo spouští.
`scope`	Rozsah pravidla. Musí být jedna z hodnot `global`, `region`, nebo `datacenter`.
`name`	Pro `global` rozsahu použijte `global`. Pro `region` nebo `datacenter` rozsahu zadejte kód regionu nebo kód datového centra.
`mode`	Režim pravidla. Musí být jedna z hodnot `enabled`, `disabled`, nebo `monitoring`.
`expression`	Výraz v jazyce Rules k filtrování paketů, na které se pravidlo vztahuje. Volitelné.
`created_on`	Časové razítko vytvoření pravidla.
`modified_on`	Časové razítko poslední změny pravidla.

Rozsah

scope určuje, kde se pravidlo spustí:

global znamená, že se pravidlo vykonává ve všech lokalitách Cloudflare. Na jeden účet můžete vytvořit pouze jedno globální pravidlo.
region znamená, že se pravidlo vykonává ve všech lokalitách Cloudflare v zadaném regionu.
datacenter znamená, že se pravidlo vykonává pouze v zadaném datovém centru Cloudflare.

Když paketu odpovídá více pravidel, provede se to s nejužším rozsahem. Pravidlo s rozsahem datového centra má přednost před pravidlem s rozsahem regionu a to má přednost před globálním pravidlem.

Režim

mode určuje chování pravidla:

enabled znamená, že program běží a jeho verdikt (pass nebo drop) se uplatní na pakety.
disabled znamená, že pravidlo je neaktivní a program se nespouští.
monitoring znamená, že program běží, ale pakety se nikdy nezahazují bez ohledu na jeho verdikt. Tento režim slouží k otestování programu před jeho zapnutím.

Výraz

expression je Výraz v jazyce Rules o délce až 8,192 znaků. Výraz filtruje, na které pakety se pravidlo vztahuje. Program zpracuje pouze pakety, které výrazu odpovídají.

Podporovaná pole:

ip.src
ip.dst
udp.srcport
udp.dstport

Pokud je výraz prázdný nebo chybí, pravidlo se vztahuje na všechny pakety UDP v jeho rozsahu.

Další informace o nastavení pravidel najdete v tématu Nastavení pravidla.