文档首页/ Web应用防火墙 WAF/ API参考（阿布扎比区域）/ API/ 独享模式防护网站管理/ 独享模式域名列表
更新时间：2023-01-16 GMT+08:00
查看PDF
分享

独享模式域名列表

功能介绍

独享模式域名列表

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，对应控制台用户名->我的凭证->项目列表->项目ID
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

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

page

否

String

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

缺省值：1

pagesize

否

String

分页查询时，每页包含多少条结果。默认值为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

域名

flag

Flag object

特殊标识，用于前端使用

policyid

String

防护域名初始绑定的防护策略ID,可以通过策略名称调用查询防护策略列表（ListPolicy）接口查询到对应的策略id

protect_status

Integer

域名防护状态：

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

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

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

access_status

Integer

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

hostid

String

域名id，和id的值是一样的，属于冗余字段

vpc_ids

Array of strings

vpc id列表
表6 Flag

参数

参数类型

描述

pci_3ds

String

是否开启pci_3ds合规认证

  • true：开启

  • false：不开启

枚举值：

  • true

  • false

pci_dss

String

是否开启pci_dss合规认证

  • true：开启

  • false：不开启

枚举值：

  • 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

错误信息

请求示例

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

响应示例

状态码： 200

OK

{
  "total" : 1,
  "items" : [ {
    "id" : "ee896796e1a84f3f85865ae0853d8974",
    "hostname" : "www.demo.com",
    "flag" : {
      "pci_3ds" : "false",
      "pci_dss" : "false"
    },
    "policyid" : "df15d0eb84194950a8fdc615b6c012dc",
    "protect_status" : 1,
    "access_status" : 0,
    "hostid" : "ee896796e1a84f3f85865ae0853d8974",
    "vpc_ids" : [ "02952d5c-9324-476d-a419-9c67ccxxxx" ]
  } ]
}

状态码

状态码

描述

200

OK

400

非法请求

401

Token无权限

500

服务器内部错误

错误码

请参见错误码。