创建云模式防护域名
功能介绍
创建云模式防护域名
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/waf/instance
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,对应控制台用户名->我的凭证->项目列表->项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
是 |
String |
内容类型 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
hostname |
是 |
String |
域名(域名只能由字母、数字、-、_和.组成,长度不能超过64个字符,如www.domain.com) |
policyid |
否 |
String |
防护域名初始绑定的策略ID,可以通过策略名称调用查询防护策略列表(ListPolicy)接口查询到对应的策略id |
server |
是 |
Array of CloudWafServer objects |
防护域名的源站服务器配置信息 |
certificateid |
否 |
String |
证书id,通过查询证书列表接口(ListCertificates)接口获取证书id
|
certificatename |
否 |
String |
证书名
|
web_tag |
否 |
String |
网站名称,对应WAF控制台域名详情中的网站名称 |
exclusive_ip |
否 |
Boolean |
是否使用用户独享的引擎公网ip,该参数为预留参数,用于后续功能扩展,用户可忽略
|
paid_type |
否 |
String |
套餐付费模式,默认值为prePaid。prePaid:包周期款模式;postPaid:按需模式。 |
proxy |
是 |
Boolean |
防护域名是否使用代理
|
lb_algorithm |
否 |
String |
LB负载均衡,仅专业版(原企业版)和铂金版(原旗舰版)支持配置负载均衡算法
|
description |
否 |
String |
域名描述 |
forward_header_map |
否 |
Map<String,String> |
字段转发配置,WAF会将添加的字段插到header中,转给源站;Key不能跟nginx原生字段重复。Value支持的值包括:
|
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
域名id |
hostname |
String |
创建的云模式防护域名 |
policyid |
String |
策略id |
access_code |
String |
cname前缀,cname后缀为.vip1.huaweicloudwaf.com |
protect_status |
Integer |
域名防护状态:
|
access_status |
Integer |
域名接入状态,0表示未接入,1表示已接入 |
lb_algorithm |
String |
LB负载均衡,仅专业版(原企业版)和铂金版(原旗舰版)支持配置负载均衡算法
|
protocol |
String |
返回的客户端协议类型 |
certificateid |
String |
返回的证书id |
certificatename |
String |
证书名称 |
server |
Array of CloudWafServer objects |
防护域名的源站服务器配置信息 |
proxy |
Boolean |
防护域名是否使用代理
|
timestamp |
Long |
创建防护域名的时间 |
exclusive_ip |
Boolean |
是否使用用户独享的引擎公网ip,该参数为预留参数,用于后续功能扩展,用户可忽略
|
web_tag |
String |
网站名称,对应WAF控制台域名详情中的网站名称 |
http2_enable |
Boolean |
是否支持http2
|
block_page |
BlockPage object |
告警页面配置 |
flag |
Flag object |
特殊标识,用于前端使用 |
extend |
Map<String,String> |
扩展字段,用于保存防护域名的一些配置信息。 |
forward_header_map |
Map<String,String> |
字段转发配置,WAF会将添加的字段插到header中,转给源站;Key不能跟nginx原生字段重复。Value支持的值包括:
|
参数 |
参数类型 |
描述 |
---|---|---|
front_protocol |
String |
客户端请求访问防护域名源站服务器的协议 |
back_protocol |
String |
WAF转发客户端请求到防护域名源站服务器的协议 |
weight |
Integer |
源站权重,负载均衡算法将按该权重将请求分配给源站,默认值是1,云模式的冗余字段 |
address |
String |
客户端访问的源站服务器的IP地址 |
port |
Integer |
WAF转发客户端请求到源站服务的业务端口 |
type |
String |
源站地址为ipv4或ipv6 |
参数 |
参数类型 |
描述 |
---|---|---|
template |
String |
模板名称,默认页面请输入default,自定义告警页面时请输入custom,重定向请输入redirect |
custom_page |
CustomPage object |
自定义告警页面 |
redirect_url |
String |
“重定向”页面URL |
参数 |
参数类型 |
描述 |
---|---|---|
status_code |
String |
返回状态码 |
content_type |
String |
“自定义”告警页面内容类型,可选择text/html、text/xml和application/json三种类型 |
content |
String |
根据选择的“页面类型”配置对应的页面内容,具体示例可以参考“Web应用防火墙 WAF”用户手册 |
参数 |
参数类型 |
描述 |
---|---|---|
pci_3ds |
String |
是否开启pci_3ds合规认证
|
pci_dss |
String |
是否开启pci_dss合规认证
|
cname |
String |
old:代表域名使用的老的cname,new:代表域名使用新的cname |
is_dual_az |
String |
是否支持双AZ模式
|
ipv6 |
String |
域名是否开启ipv6
|
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
请求示例
在项目id为project_id的项目下,创建域名是“www.demo.com”的云模式防护域名,该域名的客户端请求访问防护域名源站服务器的协议是“HTTPS”,WAF转发客户端请求到防护域名源站服务器的协议是“HTTP”,源站地址是“ipv4”,源站服务器的IP地址是“x.x.x.x”,WAF转发客户端请求到源站服务的业务端口是"7443",该域名不使用代理和独享ip,套餐付费模式是包周期款模式,域名描述是“dome”,对应WAF控制台域名详情中的网站名称是“dome”,对外协议的证书名称是“test6”,证书id是“3ac1402300374a63a05be68c641e92c8”。
POST https://{Endpoint}/v1/{project_id}/waf/instance?enterprise_project_id=0 { "hostname" : "www.demo.com", "server" : [ { "front_protocol" : "HTTPS", "back_protocol" : "HTTP", "type" : "ipv4", "address" : "x.x.x.x", "port" : "7443" } ], "proxy" : false, "paid_type" : "prePaid", "description" : "demo", "web_tag" : "demo", "certificateid" : "3ac1402300374a63a05be68c641e92c8", "certificatename" : "test6", "exclusive_ip" : false }
响应示例
状态码: 200
OK
{ "id" : "31af669f567246c289771694f2112289", "hostname" : "www.demo.com", "protocol" : "HTTP", "server" : [ { "address" : "x.x.x.x", "port" : 80, "type" : "ipv4", "weight" : 1, "front_protocol" : "HTTP", "back_protocol" : "HTTP" } ], "proxy" : false, "timestamp" : 1650527546420, "flag" : { "pci_3ds" : "false", "pci_dss" : "false", "ipv6" : "false", "cname" : "new", "is_dual_az" : "true" }, "policyid" : "41cba8aee2e94bcdbf57460874205494", "protect_status" : 1, "access_status" : 0, "access_code" : "1b18879b9d064f8bbcbf8abce7294cac", "block_page" : { "template" : "default" }, "web_tag" : "", "exclusive_ip" : false, "http2_enable" : false }
SDK代码示例
SDK代码示例如下。
在项目id为project_id的项目下,创建域名是“www.demo.com”的云模式防护域名,该域名的客户端请求访问防护域名源站服务器的协议是“HTTPS”,WAF转发客户端请求到防护域名源站服务器的协议是“HTTP”,源站地址是“ipv4”,源站服务器的IP地址是“x.x.x.x”,WAF转发客户端请求到源站服务的业务端口是"7443",该域名不使用代理和独享ip,套餐付费模式是包周期款模式,域名描述是“dome”,对应WAF控制台域名详情中的网站名称是“dome”,对外协议的证书名称是“test6”,证书id是“3ac1402300374a63a05be68c641e92c8”。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.waf.v1.region.WafRegion; import com.huaweicloud.sdk.waf.v1.*; import com.huaweicloud.sdk.waf.v1.model.*; import java.util.List; import java.util.ArrayList; public class CreateHostSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); WafClient client = WafClient.newBuilder() .withCredential(auth) .withRegion(WafRegion.valueOf("<YOUR REGION>")) .build(); CreateHostRequest request = new CreateHostRequest(); CreateHostRequestBody body = new CreateHostRequestBody(); List<CloudWafServer> listbodyServer = new ArrayList<>(); listbodyServer.add( new CloudWafServer() .withFrontProtocol(CloudWafServer.FrontProtocolEnum.fromValue("HTTPS")) .withBackProtocol(CloudWafServer.BackProtocolEnum.fromValue("HTTP")) .withAddress("x.x.x.x") .withPort(7443) .withType(CloudWafServer.TypeEnum.fromValue("ipv4")) ); body.withDescription("demo"); body.withProxy(false); body.withPaidType("prePaid"); body.withExclusiveIp(false); body.withWebTag("demo"); body.withCertificatename("test6"); body.withCertificateid("3ac1402300374a63a05be68c641e92c8"); body.withServer(listbodyServer); body.withHostname("www.demo.com"); request.withBody(body); try { CreateHostResponse response = client.createHost(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
在项目id为project_id的项目下,创建域名是“www.demo.com”的云模式防护域名,该域名的客户端请求访问防护域名源站服务器的协议是“HTTPS”,WAF转发客户端请求到防护域名源站服务器的协议是“HTTP”,源站地址是“ipv4”,源站服务器的IP地址是“x.x.x.x”,WAF转发客户端请求到源站服务的业务端口是"7443",该域名不使用代理和独享ip,套餐付费模式是包周期款模式,域名描述是“dome”,对应WAF控制台域名详情中的网站名称是“dome”,对外协议的证书名称是“test6”,证书id是“3ac1402300374a63a05be68c641e92c8”。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkwaf.v1.region.waf_region import WafRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkwaf.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = WafClient.new_builder() \ .with_credentials(credentials) \ .with_region(WafRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateHostRequest() listServerbody = [ CloudWafServer( front_protocol="HTTPS", back_protocol="HTTP", address="x.x.x.x", port=7443, type="ipv4" ) ] request.body = CreateHostRequestBody( description="demo", proxy=False, paid_type="prePaid", exclusive_ip=False, web_tag="demo", certificatename="test6", certificateid="3ac1402300374a63a05be68c641e92c8", server=listServerbody, hostname="www.demo.com" ) response = client.create_host(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
在项目id为project_id的项目下,创建域名是“www.demo.com”的云模式防护域名,该域名的客户端请求访问防护域名源站服务器的协议是“HTTPS”,WAF转发客户端请求到防护域名源站服务器的协议是“HTTP”,源站地址是“ipv4”,源站服务器的IP地址是“x.x.x.x”,WAF转发客户端请求到源站服务的业务端口是"7443",该域名不使用代理和独享ip,套餐付费模式是包周期款模式,域名描述是“dome”,对应WAF控制台域名详情中的网站名称是“dome”,对外协议的证书名称是“test6”,证书id是“3ac1402300374a63a05be68c641e92c8”。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := waf.NewWafClient( waf.WafClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateHostRequest{} var listServerbody = []model.CloudWafServer{ { FrontProtocol: model.GetCloudWafServerFrontProtocolEnum().HTTPS, BackProtocol: model.GetCloudWafServerBackProtocolEnum().HTTP, Address: "x.x.x.x", Port: int32(7443), Type: model.GetCloudWafServerTypeEnum().IPV4, }, } descriptionCreateHostRequestBody:= "demo" paidTypeCreateHostRequestBody:= "prePaid" exclusiveIpCreateHostRequestBody:= false webTagCreateHostRequestBody:= "demo" certificatenameCreateHostRequestBody:= "test6" certificateidCreateHostRequestBody:= "3ac1402300374a63a05be68c641e92c8" request.Body = &model.CreateHostRequestBody{ Description: &descriptionCreateHostRequestBody, Proxy: false, PaidType: &paidTypeCreateHostRequestBody, ExclusiveIp: &exclusiveIpCreateHostRequestBody, WebTag: &webTagCreateHostRequestBody, Certificatename: &certificatenameCreateHostRequestBody, Certificateid: &certificateidCreateHostRequestBody, Server: listServerbody, Hostname: "www.demo.com", } response, err := client.CreateHost(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
请求失败 |
401 |
token权限不足 |
500 |
服务器内部错误 |
错误码
请参见错误码。