List JSON 对象

List 对象结构与属性

Lists API 的 JSON 响应具有如下结构：

{
	"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"
}

下表汇总对象属性：

属性	描述	约束
`id` `String`	由 Cloudflare 生成的 UUIDv4 标识符。	唯一，只读。长度：32 个字符。
`name` `String`	列表的说明性名称。	最大长度：50 个字符。仅允许字母数字和下划线（`_`）字符。有效名称满足此正则表达式：`^[a-zA-Z0-9_]+$`。
`description` `String`	列表的说明性摘要。	最大长度：500 个字符。
`kind` `String`	列表中的数据类型。	有效值：`ip`、`hostname`、`asn`、`redirect`。
`num_items` `Number`	列表中的项目数。	只读。
`num_referencing_filters` `Number`	引用此列表的筛选器数量。	只读。
`created_on` `String`	创建列表时的 RFC 3339 时间戳。	只读。
`modified_on` `String`	列表上次修改时的 RFC 3339 时间戳。	只读。

List 项目对象结构与属性

每种列表类型（IP 地址、主机名、ASN、重定向）只能包含相同类型的项目。

IP 地址

IP 地址列表项目的完整 JSON 对象具有如下结构：

{
	"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"
}

主机名

主机名列表项目的完整 JSON 对象具有如下结构：

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

ASN

ASN 列表项目的完整 JSON 对象具有如下结构：

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

URL 重定向

Bulk Redirect List 项目的完整 JSON 对象具有如下结构：

{
	"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"
}

属性参考

列表项目的 JSON 对象属性定义如下：

属性	描述	约束
`id` `String`	由 Cloudflare 生成的 UUIDv4 标识符。	唯一，只读。长度：32 个字符。
`ip` `String`	IP 地址或 CIDR 范围。	仅适用于包含 IP 地址的自定义列表（IP 列表）。同一包含 IP 地址的自定义列表中可以存在以下任一格式： IPv4 地址 IPv6 地址作为 `/8` 至 `/32` CIDR 的 IPv4 范围作为 `/12` 至 `/128` CIDR 的 IPv6 范围
`comment` `String`	项目的说明性摘要。	最大长度：500 个字符。
`redirect` `Object`	包含 URL 重定向定义的对象。详情请参阅 URL 重定向参数。	仅适用于 Bulk Redirect Lists。
`hostname` `Object`	包含具有主机名值的 `url_hostname` 属性的对象。有关支持的主机名值，请参阅包含主机名的列表。	仅适用于包含主机名的自定义列表。
`asn` `Integer`	ASN 值。	仅适用于包含 ASN 的自定义列表。
`created_on` `String`	创建列表时的 RFC 3339 时间戳。	只读。
`modified_on` `String`	项目上次修改时的 RFC 3339 时间戳。	只读。

有关详细规范，请参阅 Lists API 文档。