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

创建防护域名

功能介绍

创建防护域名。

URI

  • URI格式

    POST /v1/{project_id}/waf/instance

  • 参数说明
    表1 Path参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    是

    String

    用户操作的项目ID。

请求消息

请求参数
表2 请求参数说明

名称

是否必选

参数类型

说明

hostname

是

String

创建的防护域名的名称。

例如：www.example.com或者*.example.com

certificate_id

否

String

证书ID， 当“client_protocol”为“HTTPS”时，需要设置该参数。

server

是

Array

源站信息列表，包含“client_protocol”、“server_protocol”、“address”、“port”四个字段。

  • “client_protocol”：客户端协议类型。包括HTTP、HTTPS两种协议类型，例如：HTTPS。
  • “server_protocol”：服务器协议类型，WAF转发客户端请求的协议。包括HTTP、HTTPS两种协议类型，例如：HTTP。
  • “address”：客户端访问的网站服务器的公网IP地址或者域名。
  • “port”：客户端访问的网站服务器的端口号，取值为(0, 65535)，例如：8080。

proxy

是

Boolean

是否使用代理。

  • true：表示使用了代理。
  • false：表示没有使用代理。

sip_header_name

否

String

获取真实源IP的http请求头的类别。当“proxy”为“true”时，才需要传该字段。

取值范围为：“default”，“cloudflare”，“akamai”，“custom”。

sip_header_list

否

Array

获取真实源IP的http请求头。当“proxy”为“true”时，才需要传该字段。

  • 当“sip_header_name”为“default”时，“sip_header_list”为["X-Forwarded-For"]；
  • 当“sip_header_name”为“cloudflare”时，“sip_header_list”为["CF-Connecting-IP", "X-Forwarded-For"]；
  • 当“sip_header_name”为“akamai”时，“sip_header_list”为["True-Client-IP"]；
  • 当“sip_header_name”为“custom”时，用户可以自定义。

响应消息

响应参数
表3 响应参数说明

名称

参数类型

说明

id

String

实例ID。

hostname

String

创建的防护域名。

cname

String

CNAME的值。例如：efec1196267b41c399f2980ea4048517.waf.cloud.com。

txt_code

String

TXT记录。当“proxy”为“true”时，才会返回“txt_code”。

sub_domain

String

子域名。当“proxy”为“true”时，才返回“sub_domain”。

policy_id

String

policy的ID。

protect_status

Integer

防护状态。

  • “-1”：表示bypass。
  • “0”：表示关闭。
  • “1”：表示开启。

access_status

Integer

接入状态。

  • “0”：表示未接。
  • “1”：表示已接入。

proxy

Boolean

是否使用代理。

  • true：表示使用了代理。
  • false：表示没有使用代理。

protocol

String

返回的客户端协议类型，包含“HTTP”、“HTTPS”和“HTTP,HTTPS”。

certificate_id

String

证书ID， 当“client_protocol”为“HTTPS”时，需要设置该参数。

server

Array

源站信息列表，包含“client_protocol”、“server_protocol”、“address”、“port”四个字段。

sip_header_name

String

获取真实源IP的http请求头的类别。当“proxy”为“true”时，才会返回该值。

取值范围为：“default”，“cloudflare”，“akamai”，“custom”。

sip_header_list

Array

获取真实源IP的http请求头。当“proxy”为“true”时，才会返回该值。

  • 当“sip_header_name”为“default”时，“sip_header_list”为["X-Forwarded-For"]；
  • 当“sip_header_name”为“cloudflare”时，“sip_header_list”为["CF-Connecting-IP", "X-Forwarded-For"]；
  • 当“sip_header_name”为“akamai”时，“sip_header_list”为["True-Client-IP"]；
  • 当“sip_header_name”为“custom”时，用户可以自定义。

timestamp

Long

创建防护域名的时间。

示例

如下以创建域名www.b.com为例。

  • 请求样例 
    {
  "hostname": "www.b.com",
  "certificate_id": "07fb6809a89241fca86ac6f69e34963d",
  "server": [
      {"client_protocol": "HTTPS", "server_protocol": "HTTP", "address": "X.X.X.X", "port": "8080"},
      {"client_protocol": "HTTP", "server_protocol": "HTTP", "address": "X.X.X.X", "port": "80"}
   ],
  "proxy": true,
  "sip_header_name": "default",
  "sip_header_list": ["X-Forwarded-For"]
}
  • 响应样例 
    {
          "id": "388a7789d55b41d1918b3088a8f1e7f3",
          "hostname": "www.b.com",
          "cname": "3249d21e5eb34d21be12fdc817fcb67d.waf.cloud.com",
          "txt_code": "3249d21e5eb34d21be12fdc817fcb67d",
          "sub_domain": "3249d21e5eb34d21be12fdc817fcb67d.www.b.com",
          "policy_id": "xxxxxxxxxxxxxx",
          "certificate_id": "xxxxxxxxxxxxxxxxxxx",
          "protect_status": 0,
          "access_status": 0,
          "protocol": "HTTP,HTTPS",
          "server": [
             {"client_protocol": "HTTPS", "server_protocol":"HTTP", "address":"X.X.X.X", "port":443},
             {"client_protocol": "HTTP", "server_protocol":"HTTP", "address":"X.X.X.X", "port":80}
          ],
         "proxy": true,
         "sip_header_name": "default",
         "sip_header_list": ["X-Forwarded-For"],
         "timestamp": 1499817600
         
         
}

状态码

表4描述的是API返回的正常状态码。
表4 状态码

状态码

编码

状态说明

200

OK

客户端请求已处理成功。

异常状态码，请参见状态码。

父主题： WAF防护域名