← Dokumentace WAF / tools / lists / lists-api

JSON objekt seznamu

Struktura a vlastnosti objektu seznamu

JSON odpověď pro Lists API má tuto strukturu:

{
	"id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
	"name": "my_list_name",
	"description": "List description.",
	"kind": "(ip|hostname|asn|redirect)",
	"num_items": 10,
	"num_referencing_filters": 2,
	"created_on": "2021-01-01T08:00:00Z",
	"modified_on": "2021-01-10T14:00:00Z"
}

Tato tabulka shrnuje vlastnosti objektu:

Vlastnost	Popis	Omezení
`id` `String`	Identifikátor UUIDv4 vygenerovaný Cloudflarem.	Unikátní, pouze pro čtení. Délka: 32 znaků.
`name` `String`	Informativní název seznamu.	Maximální délka: 50 znaků. Pouze alfanumerické znaky a podtržítko (`_`) znaky jsou platné. Platný název odpovídá tomuto regulárnímu výrazu: `^[a-zA-Z0-9_]+$`.
`description` `String`	Informativní shrnutí seznamu.	Maximální délka: 500 znaků.
`kind` `String`	Typ dat v seznamu.	Platné hodnoty: `ip`, `hostname`, `asn`, `redirect`.
`num_items` `Number`	Počet položek v seznamu.	Pouze pro čtení.
`num_referencing_filters` `Number`	Počet filtrů, které na tento seznam odkazují.	Pouze pro čtení.
`created_on` `String`	The RFC 3339 časové razítko vytvoření seznamu.	Pouze pro čtení.
`modified_on` `String`	The RFC 3339 časové razítko poslední úpravy seznamu.	Pouze pro čtení.

Struktura a vlastnosti objektu položky seznamu

Každý typ seznamu (IP adresa, hostname, ASN, přesměrování) může obsahovat pouze položky stejného typu.

IP adresa

Plně vyplněný JSON objekt položky seznamu IP adres má následující strukturu:

{
	"id": "7c5dae5552338874e5053f2534d2767a",
	"ip": "10.0.0.1/32",
	"comment": "CF DNS server",
	"created_on": "2021-10-01T05:20:00.12345Z",
	"modified_on": "2021-10-01T05:20:00.12345Z"
}

Hostname

Plně vyplněný JSON objekt položky seznamu hostnames má následující strukturu:

{
	"id": "7c5dae5552338874e5053f2534d2767a",
	"hostname": {
		"url_hostname": "*.example.com"
	},
	"created_on": "2021-10-11T12:39:02Z",
	"modified_on": "2021-10-11T12:39:02Z"
}

ASN

Plně vyplněný JSON objekt položky seznamu ASN má následující strukturu:

{
	"id": "7c5dae5552338874e5053f2534d2767a",
	"asn": 13335,
	"comment": "My provider's ASN",
	"created_on": "2021-10-11T12:39:02Z",
	"modified_on": "2021-10-11T12:39:02Z"
}

URL přesměrování

Plně vyplněný JSON objekt položky Bulk Redirect Listu má následující strukturu:

{
	"id": "7c5dae5552338874e5053f2534d2767a",
	"redirect": {
		"source_url": "https://example.com/blog",
		"target_url": "https://example.com/blog/latest",
		"status_code": 301,
		"include_subdomains": false,
		"subpath_matching": false,
		"preserve_query_string": false,
		"preserve_path_suffix": true
	},
	"created_on": "2021-10-11T12:39:02Z",
	"modified_on": "2021-10-11T12:39:02Z"
}

Referenční přehled vlastností

Vlastnosti JSON objektu položky seznamu jsou definovány takto:

Vlastnost	Popis	Omezení
`id` `String`	Identifikátor UUIDv4 vygenerovaný Cloudflarem.	Unikátní, pouze pro čtení. Délka: 32 znaků.
`ip` `String`	IP adresa nebo rozsah CIDR.	Platí pouze pro vlastní seznamy s IP adresami (IP seznamy). Kterýkoli z těchto formátů může existovat ve stejném vlastním seznamu s IP adresami: IPv4 adresa Adresa IPv6 IPv4 rozsahy jako `/8` až `/32` CIDR Rozsahy IPv6 jako `/12` až `/128` CIDR
`comment` `String`	Informativní shrnutí položky.	Maximální délka: 500 znaků.
`redirect` `Object`	Objekt obsahující definici URL přesměrování. Viz Parametry přesměrování URL s podrobnostmi.	Platí pouze pro Bulk Redirect Lists.
`hostname` `Object`	Objekt obsahující `url_hostname` s hodnotou hostname. Viz Seznamy s hostnames s podrobnostmi o podporovaných hodnotách hostitelů.	Platí pouze pro vlastní seznamy s názvy hostitelů (hostnames).
`asn` `Integer`	Hodnota ASN.	Platí pouze pro vlastní seznamy s ASN.
`created_on` `String`	The RFC 3339 časové razítko vytvoření seznamu.	Pouze pro čtení.
`modified_on` `String`	The RFC 3339 časové razítko poslední úpravy položky.	Pouze pro čtení.

Podrobnou specifikaci najdete v Lists API dokumentaci.