WEB应用防火墙 WAF-查询全部防护域名列表:响应参数

时间:2024-01-26 15:43:52

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

所有防护 域名 的数量

cloud_total

Integer

云模式防护域名的数量

premium_total

Integer

独享模式防护域名的数量

items

Array of CompositeHostResponse objects

详细的防护域名信息

表5 CompositeHostResponse

参数

参数类型

描述

id

String

域名id

hostid

String

域名id

hostname

String

创建的云模式防护域名

policyid

String

策略id

access_code

String

cname前缀

protect_status

Integer

域名防护状态:

  • -1:bypass,该域名的请求直接到达其后端服务器,不再经过WAF

  • 0:暂停防护,WAF只转发该域名的请求,不做攻击检测

  • 1:开启防护,WAF根据您配置的策略进行攻击检测

access_status

Integer

域名接入状态,0表示未接入,1表示已接入

proxy

Boolean

防护域名是否使用代理

  • false:不使用代理

  • true:使用代理

timestamp

Long

创建防护域名的时间

paid_type

String

套餐付费模式,默认值为prePaid。prePaid:包周期款模式;postPaid:按需模式。

flag

Flag object

特殊标识,用于前端使用

waf_type

String

域名所属WAF模式,cloud为云模式,premium为独享模式

web_tag

String

网站名称,对应WAF控制台域名详情中的网站名称

access_progress

Array of Access_progress objects

接入进度,仅用于新版console(前端)使用

premium_waf_instances

Array of Premium_waf_instances objects

租户引擎实例信息列表

description

String

域名描述

exclusive_ip

Boolean

是否使用用户独享的引擎公网ip,该参数为预留参数,用于后续功能扩展,用户可忽略

  • true:使用独享ip

  • false:不使用独享ip

region

String

华为云区域ID,控制台创建的域名会携带此参数,api调用创建的域名此参数为空,可以通过华为云上地区和终端节点文档查询区域ID对应的中文名称

表6 Flag

参数

参数类型

描述

pci_3ds

String

是否开启pci_3ds合规认证

  • true:开启

  • false:不开启

枚举值:

  • true

  • false

pci_dss

String

是否开启pci_dss合规认证

  • true:开启

  • false:不开启

枚举值:

  • true

  • false

cname

String

old:代表域名使用的老的cname,new:代表域名使用新的cname

枚举值:

  • old

  • new

is_dual_az

String

是否支持双AZ模式

  • true:支持

  • false:不支持

枚举值:

  • true

  • false

ipv6

String

域名是否开启ipv6

  • true:支持

  • false:不支持

枚举值:

  • true

  • false

表7 Access_progress

参数

参数类型

描述

step

Integer

步骤

  • 1: 指回源IP加白

  • 2: 指本地验证

  • 3:指修改DNS解析

status

Integer

状态,0:未完成这个步骤;1:已完成这个状态”

表8 Premium_waf_instances

参数

参数类型

描述

id

String

引擎实例id

name

String

引擎实例名

accessed

Boolean

引擎实例是否已接入,false:未接入;true:已接入

状态码: 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 401

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

support.huaweicloud.com/api-waf/ListCompositeHosts.html