文档首页/ Web应用防火墙 WAF/ API参考 (巴黎) / API说明/ 独享模式/ WAF防护域名/ 创建独享模式域名
更新时间：2024-07-25 GMT+08:00
查看PDF
分享

创建独享模式域名

功能介绍

创建独享模式域名

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

用户操作的项目id
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

内容类型

缺省值：application/json;charset=utf8

X-Auth-Token

是

String

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

参数

是否必选

参数类型

描述

certificateid

否

String

证书id，通过查询证书列表接口（ListCertificates）接口获取证书id

  • 对外协议为HTTP时不需要填写

  • 对外协议HTTPS时为必填参数

certificatename

否

String

证书名

  • 对外协议为HTTP时不需要填写

  • 对外协议HTTPS时为必填参数

hostname

是

String

创建的防护域名的名称。例如：www.example.com或者*.example.com

proxy

是

Boolean

是否使用代理。

  • true：表示使用了代理；

  • false：表示没有使用代理

policyid

否

String

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

server

是

Array of PremiumWafServer objects

源站信息列表

access_progress

否

Array of Access_progress objects

冗余参数，仅用于前端使用
表5 PremiumWafServer

参数

是否必选

参数类型

描述

front_protocol

是

String

客户端请求访问源站服务器的协议

枚举值：

  • HTTP

  • HTTPS

back_protocol

是

String

WAF转发客户端请求到源站服务器的协议

枚举值：

  • HTTP

  • HTTPS

address

是

String

客户端访问的源站服务器的公网IP地址或者域名

port

是

Integer

客户端访问的网站服务器的端口号，取值为(0, 65535)，例如：8080

type

是

String

源站地址为ipv4或ipv6

枚举值：

  • ipv4

  • ipv6

vpc_id

是

String

虚拟私有云id，通过以下步骤获取VPC id：

  • 1.找到独享引擎所在的虚拟私有云名称，VPC\子网这一列就是VPC的名称：登录WAF的控制台->单击系统管理->独享引擎->VPC\子网

  • 2.登录虚拟私有云 VPC控制台->虚拟私有云->单击虚拟私有云的名称->基本信息的ID
表6 Access_progress

参数

是否必选

参数类型

描述

step

否

Integer

步骤

status

否

Integer

状态

响应参数

状态码： 200

表7 响应Body参数

参数

参数类型

描述

id

String

创建的防护域名id

policyid

String

防护策略id

hostname

String

创建的防护域名

domainid

String

租户id

projectid

String

用户操作的项目id

protocol

String

http协议

protect_status

Integer

域名防护状态：

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

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

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

access_status

Integer

接入状态。

  • “0”：表示未接入

  • “1”：表示已接入

web_tag

String

网站名称

proxy

Boolean

是否使用代理。

  • true：表示使用了代理

  • false：表示没有使用代理

server

Array of PremiumWafServer objects

源站信息列表

flag

Flag object

特殊标识，用于前端使用

block_page

BlockPage object

告警页面

extend

Map<String,String>

可扩展属性
表8 PremiumWafServer

参数

参数类型

描述

front_protocol

String

客户端请求访问源站服务器的协议

枚举值：

  • HTTP

  • HTTPS

back_protocol

String

WAF转发客户端请求到源站服务器的协议

枚举值：

  • HTTP

  • HTTPS

address

String

客户端访问的源站服务器的公网IP地址或者域名

port

Integer

客户端访问的网站服务器的端口号，取值为(0, 65535)，例如：8080

type

String

源站地址为ipv4或ipv6

枚举值：

  • ipv4

  • ipv6

vpc_id

String

虚拟私有云id，通过以下步骤获取VPC id：

  • 1.找到独享引擎所在的虚拟私有云名称，VPC\子网这一列就是VPC的名称：登录WAF的控制台->单击系统管理->独享引擎->VPC\子网

  • 2.登录虚拟私有云 VPC控制台->虚拟私有云->单击虚拟私有云的名称->基本信息的ID
表9 Flag

参数

参数类型

描述

pci_3ds

String

是否通过pci_3ds标准认证。

  • true：通过pci_3ds标准认证

  • false：未通过pci_3ds标准认证

枚举值：

  • true

  • false

pci_dss

String

是否通过pci_dss标准认证。

  • true：通过pci_dss标准认证

  • false：未通过pci_dss标准认证

枚举值：

  • true

  • false

cname

String

域名使用老的cname还是新的cname

  • old：代表域名使用老的cname

  • new：代表域名使用新的cname

枚举值：

  • old

  • new

is_dual_az

String

WAF是否支持多可用区容灾

  • true：WAF支持多可用区容灾

  • false：WAF不支持多可用区容灾

枚举值：

  • true

  • false
表10 BlockPage

参数

参数类型

描述

template

String

模板名称

custom_page

CustomPage object

自定义告警页面

redirect_url

String

重定向URL
表11 CustomPage

参数

参数类型

描述

status_code

String

返回状态码

content_type

String

页面内容类型

content

String

页面内容

状态码： 400

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 401

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 500

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

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

{
  "hostname" : "www.demo.com",
  "server" : [ {
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP",
    "vpc_id" : "cf6dbace-b36a-4d51-ae04-52a3319ae247",
    "type" : "ipv4",
    "address" : "x.x.x.x",
    "port" : 80
  } ],
  "proxy" : false,
  "description" : ""
}

响应示例

状态码： 200

ok

{
  "id" : "51a5649e52d341a9bb802044950969dc",
  "hostname" : "www.demo.com",
  "protocol" : "HTTP",
  "server" : [ {
    "address" : "x.x.x.x",
    "port" : 80,
    "type" : "ipv4",
    "weight" : 1,
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP",
    "vpc_id" : "cf6dbace-b36a-4d51-ae04-52a3319ae247"
  } ],
  "proxy" : false,
  "locked" : 0,
  "timestamp" : 1650596007113,
  "flag" : {
    "pci_3ds" : "false",
    "pci_dss" : "false"
  },
  "description" : "",
  "policyid" : "1607df035bc847b582ce9c838c083b88",
  "projectid" : "550500b49078408682d0d4f7d923f3e1",
  "domainid" : "d4ecb00b031941ce9171b7bc3386883f",
  "enterprise_project_id" : "0",
  "protect_status" : 1,
  "access_status" : 0,
  "web_tag" : "",
  "access_progress" : [ ]
}

状态码

状态码

描述

200

ok

400

非法请求

401

Token无权限

500

服务器内部错误

错误码

请参见错误码。

父主题： WAF防护域名