文档首页/ Web应用防火墙 WAF/ API参考（安卡拉区域）/ API/ 租户域名查询/ 根据Id查询防护域名
更新时间：2024-04-15 GMT+08:00
在线调试
CLI示例
查看PDF
分享

根据Id查询防护域名

功能介绍

根据Id查询防护域名

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

host_id

是

String

域名id，通过查询云模式防护域名列表（ListHost）获取域名id或者通过独享模式域名列表（ListPremiumHost）获取域名id
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

Content-Type

是

String

内容类型

缺省值：application/json;charset=utf8

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

id

String

域名id

hostid

String

域名id

hostname

String

创建的云模式防护域名

policyid

String

策略id

access_code

String

cname前缀

protect_status

Integer

域名防护状态：

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

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

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

access_status

Integer

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

proxy

Boolean

防护域名是否使用代理

  • false：不使用代理

  • true：使用代理

timestamp

Long

创建防护域名的时间

paid_type

String

套餐付费模式，目前只支持prePaid预付款模式

flag

Flag object

特殊标识，用于前端使用

waf_type

String

域名所属WAF模式,cloud为云模式，premium为独享模式

web_tag

String

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

premium_waf_instances

Array of Premium_waf_instances objects

租户引擎实例信息列表

description

String

域名描述

exclusive_ip

Boolean

是否使用用户独享的引擎公网ip，该参数为预留参数，用于后续功能扩展，用户可忽略

  • true：使用独享ip

  • false：不使用独享ip

region

String

区域ID，控制台创建的域名会携带此参数，api调用创建的域名此参数为空，可以通过上地区和终端节点文档查询区域ID对应的中文名称
表5 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

是否支持双AZ模式

  • true：支持

  • false：不支持

枚举值：

  • true

  • false

ipv6

String

域名是否开启ipv6

  • true：支持

  • false：不支持

枚举值：

  • true

  • false
表6 Premium_waf_instances

参数

参数类型

描述

id

String

引擎实例id

name

String

引擎实例名

accessed

Boolean

引擎实例是否已接入，false：未接入；true：已接入

状态码： 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/{host_id}?enterprise_project_id=0

响应示例

状态码： 200

OK

{
  "id" : "31af669f567246c289771694f2112289",
  "hostid" : "31af669f567246c289771694f2112289",
  "description" : "",
  "proxy" : false,
  "flag" : {
    "pci_3ds" : "false",
    "pci_dss" : "false",
    "ipv6" : "false",
    "cname" : "new",
    "is_dual_az" : "true"
  },
  "region" : "xx-xxxx-x",
  "hostname" : "www.demo.com",
  "access_code" : "1b18879b9d064f8bbcbf8abce7294cac",
  "policyid" : "41cba8aee2e94bcdbf57460874205494",
  "timestamp" : 1650527546454,
  "protect_status" : 0,
  "access_status" : 0,
  "exclusive_ip" : false,
  "web_tag" : "",
  "paid_type" : "prePaid",
  "waf_type" : "cloud"
}

状态码

状态码

描述

200

OK

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码。

父主题： 租户域名查询