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

创建云模式防护域名

功能介绍

创建云模式防护域名

URI

POST /v1/{project_id}/waf/instance

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

用户的project_id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

Content-Type

String

内容类型

表3 请求Body参数

参数

是否必选

参数类型

描述

hostname

String

域名(域名只能由字母、数字、-、_和.组成,长度不能超过64个字符,如www.domain.com)

policyid

String

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

server

Array of CloudWafServer objects

源站信息

certificateid

String

证书id,通过查询证书列表接口(ListCertificates)接口获取证书id

  • 对外协议为HTTP时不需要填写
  • 对外协议HTTPS时为必填参数

certificatename

String

证书名

  • 对外协议为HTTP时不需要填写
  • 对外协议HTTPS时为必填参数

proxy

Boolean

是否使用代理

description

String

域名描述

表4 CloudWafServer

参数

是否必选

参数类型

描述

front_protocol

String

对外协议

back_protocol

String

源站协议

address

String

源站地址

port

Integer

源站端口

type

String

源站地址为ipv4

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

id

String

域名id

hostname

String

创建的云模式防护域名

policyid

String

策略id

access_code

String

cname前缀

protect_status

Integer

域名防护状态:

  • -1:bypass,该域名的请求直接到达其后端服务器,不再经过WAF
  • 0:暂停防护,WAF只转发该域名的请求,不做攻击检测
  • 1:开启防护,WAF根据您配置的策略进行攻击检测

access_status

Integer

接入状态

protocol

String

返回的客户端协议类型

certificateid

String

返回的证书id

certificatename

String

证书名称

server

Array of CloudWafServer objects

源站信息

proxy

Boolean

是否开启了代理

timestamp

Long

创建防护域名的时间

表6 CloudWafServer

参数

参数类型

描述

front_protocol

String

对外协议

back_protocol

String

源站协议

address

String

源站地址

port

Integer

源站端口

type

String

源站地址为ipv4

状态码: 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

错误信息

请求示例

响应示例

状态码

状态码

描述

200

OK

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码