文档首页/ Web应用防火墙 WAF/ API参考（吉隆坡区域）/ API/ 独享模式防护网站管理/ 独享模式域名列表
更新时间：2022-10-09 GMT+08:00
查看PDF
分享

独享模式域名列表

功能介绍

独享模式域名列表

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

用户的project_id
表2 Query参数

参数

是否必选

参数类型

描述

page

否

String

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

pagesize

否

String

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

hostname

否

String

域名

policyname

否

String

策略名称

protect_status

否

Integer

域名防护状态：

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

全部防护域名的数量

items

Array of SimplePremiumWafHost objects

详细的防护域名信息
表5 SimplePremiumWafHost

参数

参数类型

描述

id

String

域名id

hostname

String

域名

policyid

String

策略id

protect_status

Integer

域名防护状态：

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

access_status

Integer

接入状态

flag

Map<String,String>

特殊标识

mode

String

特殊模式独享引擎的标识（如elb）

pool_ids

Array of strings

特殊模式域名所属独享引擎组

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

无

响应示例

无

状态码

状态码

描述

200

OK

400

非法请求

401

Token无权限

500

服务器内部错误

错误码

请参见错误码。