更新时间:2022-09-08 GMT+08:00
分享

查询云模式防护域名列表

功能介绍

查询云模式防护域名列表

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/waf/instance

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,对应华为云控制台用户名->我的凭证->项目列表->项目ID

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

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

page

Integer

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

缺省值:1

pagesize

Integer

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

缺省值:10

hostname

String

要查询的防护域名,用于查询指定防护域名信息;可不传,查询用户云模式下所有防护域名

policyname

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

云模式防护域名的数量

items

Array of CloudWafHostItem objects

详细的云模式防护域名列表信息

表5 CloudWafHostItem

参数

参数类型

描述

id

String

域名id

hostid

String

域名id

region

String

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

description

String

域名描述信息,可选参数。

type

Integer

WAF部署模式,默认是1,目前仅支持反代模式,冗余参数

proxy

Boolean

防护域名是否使用代理

  • false:不使用代理

  • true:使用代理

hostname

String

创建的云模式防护域名

access_code

String

cname前缀

policyid

String

防护策略id

timestamp

Long

创建防护域名的时间

protect_status

Integer

域名防护状态:

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

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

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

access_status

Integer

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

exclusive_ip

Boolean

是否使用独享ip

  • true:使用独享ip

  • false:不实用独享ip

paid_type

String

付费模式,目前只支持prePaid预付款模式

枚举值:

  • prePaid

web_tag

String

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

flag

Flag object

特殊标识,用于前端使用

表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

域名是否开启ipv6

  • true:支持

  • false:不支持

枚举值:

  • true

  • false

ipv6

String

域名是否开启ipv6

  • 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}/waf/instance?enterprise_project_id=0

响应示例

状态码: 200

OK

{
  "total" : 1,
  "items" : [ {
    "id" : "d0a4bc2f74e3407388a50243af700305",
    "hostid" : "d0a4bc2f74e3407388a50243af700305",
    "description" : "e",
    "type" : 1,
    "proxy" : false,
    "flag" : {
      "pci_3ds" : "false",
      "pci_dss" : "false",
      "ipv6" : "false",
      "cname" : "new",
      "is_dual_az" : "true"
    },
    "region" : "cn-north-4",
    "hostname" : "www.demo.com",
    "access_code" : "7d06456ffaexxxxxxxxxxx281bc13b",
    "policyid" : "bb2124fabe6f42ff9fe4770eeccb2670",
    "timestamp" : 1642648030687,
    "protect_status" : 1,
    "access_status" : 0,
    "exclusive_ip" : false,
    "web_tag" : "iii",
    "paid_type" : "prePaid"
  } ]
}

状态码

状态码

描述

200

OK

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码

分享:

    相关文档

    相关产品

close