文档首页/ Web应用防火墙 WAF/ API参考 (巴黎) / API说明/ 独享模式/ WAF防护域名/ 查询独享模式域名列表
更新时间：2024-07-25 GMT+08:00
查看PDF
分享

查询独享模式域名列表

功能介绍

查询独享模式域名列表

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

用户操作的项目id
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目id

page

否

String

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

缺省值：1

pagesize

否

String

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

缺省值：10

hostname

否

String

防护域名

policyname

否

String

策略名称

protect_status

否

Integer

域名防护状态：

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

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

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

内容类型

缺省值：application/json;charset=utf8

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

接入状态。

  • “0”：表示未接入

  • “1”：表示已接入

flag

Map<String,String>

特殊标识，用于前端使用

mode

String

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

block_page

BlockPage object

告警页面

traffic_mark

TrafficMark object

流量标识

extend

Map<String,String>

可扩展字段

circuit_breaker

CircuitBreaker object

熔断配置

timeout_config

TimeoutConfig object

超时配置

access_progress

Array of Access_progress objects

冗余参数，仅用于前端使用
表6 BlockPage

参数

参数类型

描述

template

String

模板名称

custom_page

CustomPage object

自定义告警页面

redirect_url

String

重定向URL
表7 CustomPage

参数

参数类型

描述

status_code

String

返回状态码

content_type

String

页面内容类型

content

String

页面内容
表8 TrafficMark

参数

参数类型

描述

sip

Array of strings

惩罚ip

cookie

String

cookie

params

String

参数
表9 CircuitBreaker

参数

参数类型

描述

switch

Boolean

熔断开关

dead_num

Integer

源站不可达数量阈值

dead_ratio

Number

源站不可达比例阈值

block_time

Integer

源站不可达熔断时间

superposition_num

Integer

熔断阈值叠加次数

suspend_num

Integer

连接数占用阈值

sus_block_time

Integer

连接数占用熔断时间
表10 TimeoutConfig

参数

参数类型

描述

connect_timeout

Integer

WAF连接源站超时配置

send_timeout

Integer

WAF发送请求到源站超时配置

read_timeout

Integer

WAF接收源站响应超时配置
表11 Access_progress

参数

参数类型

描述

step

Integer

步骤

status

Integer

状态

状态码： 400

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 401

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 500

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

GET https://{Endpoint}/v1/{project_id}/premium-waf/host?enterprise_project_id=0

响应示例

状态码： 200

ok

{
  "total" : 1,
  "items" : [ {
    "id" : "ee896796e1a84f3f85865ae0853d8974",
    "hostname" : "www.demo.com",
    "extend" : { },
    "region" : "xx-xx-1",
    "flag" : {
      "pci_3ds" : "false",
      "pci_dss" : "false"
    },
    "description" : "",
    "policyid" : "df15d0eb84194950a8fdc615b6c012dc",
    "protect_status" : 1,
    "access_status" : 0,
    "hostid" : "ee896796e1a84f3f85865ae0853d8974"
  } ]
}

状态码

状态码

描述

200

ok

400

非法请求

401

Token无权限

500

服务器内部错误

错误码

请参见错误码。

父主题： WAF防护域名