文档首页/ Web应用防火墙 WAF/ API参考（阿布扎比区域）/ API/ 租户域名查询/ 查询全部防护域名列表
更新时间：2023-01-16 GMT+08:00
查看PDF
分享

查询全部防护域名列表

功能介绍

查询全部防护域名列表，包括云模式和独享模式

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

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

page

否

Integer

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

缺省值：1

pagesize

否

Integer

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

缺省值：10

hostname

否

String

域名名称

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

Content-Type

是

String

内容类型

缺省值：application/json;charset=utf8

响应参数

状态码： 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

protect_status

Integer

域名防护状态：

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

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

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

flag

Flag object

特殊标识，用于前端使用

waf_type

String

域名所属WAF模式, premium为独享模式
表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}/composite-waf/host?enterprise_project_id=0

响应示例

状态码： 200

OK

{
  "items" : [ {
    "id" : "31af669f567246c289771694f2112289",
    "hostid" : "31af669f567246c289771694f2112289",
    "proxy" : false,
    "flag" : {
      "pci_3ds" : "false",
      "pci_dss" : "false"
    },
    "hostname" : "www.demo.com",
    "access_code" : "1b18879b9d064f8bbcbf8abce7294cac",
    "policyid" : "41cba8aee2e94bcdbf57460874205494",
    "timestamp" : 1650527546454,
    "protect_status" : 0,
    "waf_type" : "premium"
  } ],
  "total" : 1,
  "cloud_total" : 0,
  "premium_total" : 1
}

状态码

状态码

描述

200

OK

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码。

父主题： 租户域名查询