查看独享模式域名配置
功能介绍
查看独享模式域名配置
URI
GET /v1/{project_id}/premium-waf/host/{host_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,对应控制台用户名->我的凭证->项目列表->项目ID |
host_id |
是 |
String |
独享模式域名ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
内容类型 缺省值:application/json;charset=utf8 |
X-Auth-Token |
是 |
String |
用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
域名id |
hostname |
String |
创建的独享模式防护域名 |
protocol |
String |
对外协议,客户端(例如浏览器)请求访问网站的协议类型 |
server |
Array of PremiumWafServer objects |
防护域名的源站服务器配置信息 |
proxy |
Boolean |
防护域名是否使用代理
|
locked |
Integer |
预留参数,用于后期设计冻结域名,解锁域名功能,目前暂不支持 缺省值:0 |
timestamp |
Long |
创建防护域名的时间 |
tls |
String |
配置的最低TLS版本(TLS v1.0/TLS v1.1/TLS v1.2),默认为TLS v1.0版本,对外协议为https时才有tls参数 枚举值:
|
cipher |
String |
对外协议为https时才有cipher参数,加密套件(cipher_1,cipher_2,cipher_3,cipher_4,cipher_default):
枚举值:
|
extend |
Map<String,String> |
扩展字段,用于保存防护域名的一些配置信息。 |
flag |
Flag object |
特殊标识,用于前端使用 |
description |
String |
域名描述 |
policyid |
String |
防护域名初始绑定的策略ID,可以通过策略名称调用查询防护策略列表(ListPolicy)接口查询到对应的策略id |
domainid |
String |
账号ID,对应控制台用户名->我的凭证->账号ID |
projectid |
String |
项目ID,对应控制台用户名->我的凭证->项目列表->项目ID |
enterprise_project_id |
String |
企业项目ID,对应控制台用户名->企业->项目管理->点击项目名称->ID |
certificateid |
String |
https证书id |
certificatename |
String |
证书名称 |
protect_status |
Integer |
域名防护状态:
|
access_status |
Integer |
域名接入状态,0表示未接入,1表示已接入 |
web_tag |
String |
网站名称,对应WAF控制台域名详情中的网站名称 |
block_page |
BlockPage object |
告警页面配置 |
traffic_mark |
TrafficMark object |
流量标识 |
timeout_config |
TimeoutConfig object |
超时配置 |
参数 |
参数类型 |
描述 |
---|---|---|
front_protocol |
String |
客户端请求访问防护域名源站服务器的协议 枚举值:
|
back_protocol |
String |
WAF转发客户端请求到防护域名源站服务器的协议 枚举值:
|
weight |
Integer |
源站权重,负载均衡算法将按该权重将请求分配给源站,默认值是1,云模式的冗余字段 |
address |
String |
客户端访问的源站服务器的IP地址 |
port |
Integer |
WAF转发客户端请求到源站服务的业务端口 |
type |
String |
源站地址为ipv4或ipv6 枚举值:
|
vpc_id |
String |
VPC id,通过以下步骤获取VPC id:
|
参数 |
参数类型 |
描述 |
---|---|---|
pci_3ds |
String |
是否开启pci_3ds合规认证
枚举值:
|
pci_dss |
String |
是否开启pci_dss合规认证
枚举值:
|
cname |
String |
old:代表域名使用的老的cname,new:代表域名使用新的cname 枚举值:
|
is_dual_az |
String |
是否支持双AZ模式
枚举值:
|
ipv6 |
String |
域名是否开启ipv6
枚举值:
|
参数 |
参数类型 |
描述 |
---|---|---|
template |
String |
模板名称 |
custom_page |
CustomPage object |
自定义告警页面 |
redirect_url |
String |
“重定向”页面URL |
参数 |
参数类型 |
描述 |
---|---|---|
status_code |
String |
返回状态码 |
content_type |
String |
“自定义”告警页面内容类型,可选择text/html、text/xml和application/json三种类型 |
content |
String |
根据选择的“页面类型”配置对应的页面内容,具体示例可以参考“Web应用防火墙 WAF”用户手册 |
参数 |
参数类型 |
描述 |
---|---|---|
sip |
Array of strings |
IP标记,客户端最原始的IP地址的HTTP请求头字段。 |
cookie |
String |
Session标记,用于Cookie恶意请求的攻击惩罚功能。在选择Cookie拦截的攻击惩罚功能前,必须配置该标识 |
params |
String |
User标记,用于Params恶意请求的攻击惩罚功能。在选择Params拦截的攻击惩罚功能前,必须配置该标识。 |
参数 |
参数类型 |
描述 |
---|---|---|
connect_timeout |
Integer |
WAF连接源站超时配置 |
send_timeout |
Integer |
WAF发送请求到源站超时配置 |
read_timeout |
Integer |
WAF接收源站响应超时配置 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
请求示例
GET https://{Endpoint}/v1/{project_id}/premium-waf/host/{host_id}?enterprise_project_id=0
响应示例
状态码: 200
OK
{ "id" : "ee896796e1a84f3f85865ae0853d8974", "hostname" : "www.demo.com", "protocol" : "HTTPS", "server" : [ { "address" : "1.2.3.4", "port" : 443, "type" : "ipv4", "weight" : 1, "front_protocol" : "HTTPS", "back_protocol" : "HTTPS", "vpc_id" : "ebfc553a-386d-4746-b0c2-18ff3f0e903d" } ], "proxy" : false, "locked" : 0, "timestamp" : 1650593801380, "tls" : "TLS v1.0", "cipher" : "cipher_1", "flag" : { "pci_3ds" : "false", "pci_dss" : "false" }, "description" : "", "policyid" : "df15d0eb84194950a8fdc615b6c012dc", "domainid" : "0ee78615ca08419f81f539d97c9ee353", "projectid" : "550500b49078408682d0d4f7d923f3e1", "protect_status" : 1, "access_status" : 0, "certificateid" : "360f992501a64de0a65c50a64d1ca7b3", "certificatename" : "certificatename75315" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
非法请求 |
401 |
Token无权限 |
500 |
服务器内部错误 |
错误码
请参见错误码。