获取列表

请求URL

• {{url}}/api/site/list

请求方式

• get

请求参数

Header 请求参数

参数名	参数值	是否必填	参数类型	描述说明
x-api-key	{{x-api-key}}	是	String
x-api-secret	{{x-api-secret}}	是	String

Query 请求参数

参数名	参数值	是否必填	参数类型	描述说明
page	1	否	Integer	页数
limit	10	否	Integer	每页个数
domain	abcd	否	String	域名，可模糊查询
backend_ip		否	String	源ip，可模糊查询
group		否	Integer	所属网站组ID
id		否	Integer	网站ID
user_package		否	Integer	已购套餐ID
https_enable		否	Boolean	是否开启https ， true:是 false:否
enable		否	Boolean	网站是否启用 ，true:是 false:否
state		否	String	网站状态，可选为200、512、513、514。200是正常，512是套餐过期，513是流量超限，514是被锁定

响应示例

{
	"code": 0,
	"data": {
		"count": 23,
		"list": [
			{
				"acl": null,
				"acme_proxy_to_orgin": 0,
				"backend": "[{\"state\": \"up\", \"addr\": \"127.0.0.1\", \"weight\": 1}]",
				"backend_host": "$host",
				"backend_http_port": "80",
				"backend_https_port": "443",
				"backend_port_mapping": 0,
				"backend_protocol": "http",
				"backup_node_group": null,
				"backup_node_group_name": null,
				"balance_way": "rr",
				"black_ip": "",
				"block_proxy": 0,
				"block_region": "",
				"cc_default_rule": 6,
				"cc_switch": "{}",
				"cname_domain": "bb7.site",
				"cname_hostname": "pw5huy3e",
				"cname_hostname2": "111",
				"cname_mode": "package",
				"cname_state": null,
				"cname_task_id": null,
				"cors": "{\"allow_origin\": \"*\", \"allow_methods\": \"GET POST OPTIONS\", \"enable\": 0, \"allow_headers\": \"DNT Keep-Alive User-Agent X-Requested-With If-Modified-Since Cache-Control Content-Type\", \"max_age\": \"1728000\", \"expose_headers\": \"Content-Length Content-Range\", \"allow_credentials\": 1}",
				"create_at": null,
				"create_at2": "2024-11-03 17:55:21",
				"domain": "adc1.com",
				"enable": 1,
				"enable_backup_group": 0,
				"extra_cc_rule": "[]",
				"group_name": null,
				"gzip_enable": 1,
				"gzip_types": "text/plain text/css text/xml text/javascript application/javascript application/x-javascript application/json",
				"health_check": "{\"enable\": false, \"protocol\": \"http\", \"status_code\": \"200 301 302\", \"interval\": 10, \"host\": \"adc1.com\", \"path\": \"/\"}",
				"hotlink": "{\"domain\": \"\", \"enable\": 0, \"allow_empty\": true}",
				"http_listen": "{\"port\": \"80\"}",
				"https_listen": "{}",
				"id": 29,
				"name": "cdnwaf",
				"node_group_id": 1,
				"node_group_name": "test",
				"package_id": 1,
				"package_name": "test1",
				"page_404": "",
				"page_50x": "",
				"post_size_limit": 40,
				"proxy_cache": "[{\"content\": \"gif|jpg|jpeg|png|bmp|swf|js|css\", \"range\": false, \"expire\": \"6\", \"proxy_ignore_headers\": \"\", \"no_cache\": [], \"type\": \"suffix\", \"ignore_arg\": true, \"unit\": \"h\"}]",
				"proxy_http_version": "1.1",
				"proxy_ssl_protocols": "TLSv1 TLSv1.1 TLSv1.2",
				"proxy_timeout": "900",
				"range": 0,
				"record_id": null,
				"region_id": 1,
				"region_name": "默认",
				"req_header": "[]",
				"resp_header": "[]",
				"s.cname_domain": "bb7.site",
				"s.cname_hostname": "pw5huy3e",
				"s.cname_hostname2": "111",
				"s.cname_mode": "package",
				"site_state": "200",
				"spider_allow": "baidu|sogou|sm|bing|google|toutiao|360spider",
				"state": "200",
				"sync_state": "done",
				"task_id": 369438,
				"uid": 2,
				"up_cname_domain": "bb7.site",
				"up_cname_hostname": "as5ydt9n-u",
				"up_cname_hostname2": "111",
				"update_at": null,
				"update_at2": "2024-11-03 17:55:21",
				"ups_keepalive": 0,
				"ups_keepalive_conn": 32,
				"ups_keepalive_timeout": 50,
				"url_rewrite": "[]",
				"user_package": 5,
				"version": 1,
				"websocket_enable": 1,
				"white_ip": ""
			}
		]
	},
	"msg": "ok"
}

成功 (200)

参数名	参数值	是否必填	参数类型	描述说明
code	0	是	Integer
data		是	Object
data.count	23	是	Integer	条数
data.list		是	Array
data.list.acl	null	是	Null	指定ACL ID
data.list.acme_proxy_to_orgin	0	是	Integer	当为1时，/.well-known/acme-challenge/的请求回源。
data.list.backend	[{"state": "up", "addr": "127.0.0.1", "weight": 1}]	是	String	指定源IP，格式为数组
data.list.backend_host	$host	是	String	回源的Host值，可选$host、$host:$server_port和自定义
data.list.backend_http_port	80	是	String	当回源协议为http时，回源使用的端口
data.list.backend_https_port	443	是	String	当回源协议为https时，回源使用的端口
data.list.backend_port_mapping	0	是	Integer	回源端口映射，表示回源的协议和端口与访问的协议的端口一致。
data.list.backend_protocol	http	是	String	回源协议，可选值为follow、http、https。
data.list.backup_node_group	null	是	Null
data.list.backup_node_group_name	null	是	Null
data.list.balance_way	rr	是	String	源服务器负载均衡方式，可选值为ip_hash、rr、url_hash、least_conn、random。ip_hash为根据客户端IP定源，rr是轮循，url_hash是根据url定源，least_conn是取最少连接的源，random是随机分配
data.list.black_ip		是	String	黑名单IP，一行一个，支持子掩码/8 /16 /24，如192.168.0.0/8、192.168.0.0/16、192.168.0.0/24.
data.list.block_proxy	0	是	Integer
data.list.block_region		是	String	屏蔽区域，可选值两字母的国家代码
data.list.cc_default_rule	6	是	Integer	默认的防御规则组
data.list.cc_switch	{}	是	String
data.list.cname_domain	bb7.site	是	String
data.list.cname_hostname	pw5huy3e	是	String
data.list.cname_hostname2	111	是	String
data.list.cname_mode	package	是	String
data.list.cname_state	null	是	Null
data.list.cname_task_id	null	是	Null
data.list.cors	{"allow_origin": "*", "allow_methods": "GET POST OPTIONS", "enable": 0, "allow_headers": "DNT Keep-Alive User-Agent X-Requested-With If-Modified-Since Cache-Control Content-Type", "max_age": "1728000", "expose_headers": "Content-Length Content-Range", "allow_credentials": 1}	是	String	设置跨站支持
data.list.create_at	null	是	Null
data.list.create_at2	2024-11-03 17:55:21	是	String
data.list.domain	adc1.com	是	String	源IP，模糊搜索
data.list.enable	1	是	Integer	网站是否启用
data.list.enable_backup_group	0	是	Integer
data.list.extra_cc_rule	[]	是	String
data.list.group_name	null	是	Null
data.list.gzip_enable	1	是	Integer	gzip开启
data.list.gzip_types	text/plain text/css text/xml text/javascript application/javascript application/x-javascript application/json	是	String	gzip的content type，如text/plain text/css text/xml text/javascript application/javascript application/x-javascript application/json
data.list.health_check	{"enable": false, "protocol": "http", "status_code": "200 301 302", "interval": 10, "host": "adc1.com", "path": "/"}	是	String	源站健康检查
data.list.hotlink	{"domain": "", "enable": 0, "allow_empty": true}	是	String
data.list.http_listen	{"port": "80"}	是	String	http监听端口，格式为json,如{"port":"80 88"}，表示监听http的80和88端口
data.list.https_listen	{}	是	String	HTTPS设置
data.list.id	29	是	Integer	网站id,多个以英文逗号隔开
data.list.name	cdnwaf	是	String
data.list.node_group_id	1	是	Integer
data.list.node_group_name	test	是	String
data.list.package_id	1	是	Integer
data.list.package_name	test1	是	String
data.list.page_404		是	String	自定义404错误页面
data.list.page_50x		是	String	自定义50x错误页面，包括500 502 503 504
data.list.post_size_limit	40	是	Integer	上传文件最大大小，单位为MB
data.list.proxy_cache	[{"content": "gif|jpg|jpeg|png|bmp|swf|js|css", "range": false, "expire": "6", "proxy_ignore_headers": "", "no_cache": [], "type": "suffix", "ignore_arg": true, "unit": "h"}]	是	String	缓存设置，数据格式为数组
data.list.proxy_http_version	1.1	是	String	回源的http协议版本，可选1.1,1.0
data.list.proxy_ssl_protocols	TLSv1 TLSv1.1 TLSv1.2	是	String	回源SSL协议，可选TLSv1 TLSv1.1 TLSv1.2
data.list.proxy_timeout	900	是	String	回源超时时间
data.list.range	0	是	Integer	分断取源，一次取1MB
data.list.record_id	null	是	Null
data.list.region_id	1	是	Integer
data.list.region_name	默认	是	String
data.list.req_header	[]	是	String	设置请求头
data.list.resp_header	[]	是	String	设置响应头
data.list.s.cname_domain	bb7.site	是	String
data.list.s.cname_hostname	pw5huy3e	是	String
data.list.s.cname_hostname2	111	是	String
data.list.s.cname_mode	package	是	String
data.list.site_state	200	是	String
data.list.spider_allow	baidu|sogou|sm|bing|google|toutiao|360spider	是	String
data.list.state	200	是	String	网站状态，可选为200、512、513、514。200是正常，512是套餐过期，513是流量超限，514是被锁定
data.list.sync_state	done	是	String
data.list.task_id	369438	是	Integer
data.list.uid	2	是	Integer
data.list.up_cname_domain	bb7.site	是	String
data.list.up_cname_hostname	as5ydt9n-u	是	String
data.list.up_cname_hostname2	111	是	String
data.list.update_at	null	是	Null
data.list.update_at2	2024-11-03 17:55:21	是	String
data.list.ups_keepalive	0	是	Integer	回源keepalive
data.list.ups_keepalive_conn	32	是	Integer	keepalive的连接数
data.list.ups_keepalive_timeout	50	是	Integer	keepalive超时时间
data.list.url_rewrite	[]	是	String	url重定向
data.list.user_package	5	是	Integer	已购套餐ID
data.list.version	1	是	Integer
data.list.websocket_enable	1	是	Integer	websocket开启
data.list.white_ip		是	String	白名单IP，一行一个，支持子掩码/8 /16 /24，如192.168.0.0/8、192.168.0.0/16、192.168.0.0/24.
msg	ok	是	String

失败 (404)