更新时间:2022-10-09 GMT+08:00

查询全部防护域名列表

功能介绍

查询全部防护域名列表

URI

GET /v1/{project_id}/composite-waf/host

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

用户的project_id

表2 Query参数

参数

是否必选

参数类型

描述

page

Integer

分页查询时,返回第几页数据。范围0-100000,默认值为1,表示返回第1页数据。

pagesize

Integer

分页查询时,每页包含多少条结果。范围1-100,默认值为10,表示每页包含10条结果。

hostname

String

域名名称

policyname

String

防护策略名称

protect_status

Integer

域名防护状态:

  • -1:bypass,该域名的请求直接到达其后端服务器,不再经过WAF
  • 0:暂停防护,WAF只转发该域名的请求,不做攻击检测
  • 1:开启防护,WAF根据您配置的策略进行攻击检测

waf_type

String

域名所属WAF模式

is_https

Boolean

域名是否使用HTTPS

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

内容类型

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

所有防护域名的数量

cloud_total

Integer

云模式防护域名的数量

premium_total

Integer

独享防护域名的数量

items

Array of CompositeHostResponse objects

详细的防护域名信息

表5 CompositeHostResponse

参数

参数类型

描述

id

String

域名id

hostname

String

创建的云模式防护域名

policyid

String

策略id

access_code

String

cname前缀

protect_status

Integer

域名防护状态:

  • -1:bypass,该域名的请求直接到达其后端服务器,不再经过WAF
  • 0:暂停防护,WAF只转发该域名的请求,不做攻击检测
  • 1:开启防护,WAF根据您配置的策略进行攻击检测

access_status

Integer

接入状态

proxy

Boolean

是否开启了代理

timestamp

Long

创建防护域名的时间

paid_type

String

套餐付费模式,目前只支持prePaid预付款模式

flag

HostFlag object

域名配置

waf_type

String

域名所属WAF模式

表6 HostFlag

参数

参数类型

描述

pci_dss

String

true/false

pci_3ds

String

true/false

cname

String

old/new

is_dual_az

String

true/false

ipv6

String

true/false

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

响应示例

状态码

状态码

描述

200

OK

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码