文档首页/ Web应用防火墙 WAF/ API参考/ API/ 独享模式防护网站管理/ 创建独享模式域名

更新时间：2024-11-08 GMT+08:00

在线调试

CLI示例

查看PDF

创建独享模式域名

功能介绍

创建独享模式域名

调用方法

请参见如何调用API。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，对应控制台用户名->我的凭证->项目列表->项目ID

表2 Query参数
参数	是否必选	参数类型	描述
enterprise_project_id	否	String	您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目id

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	是	String	内容类型
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	防护域名或IP（可带端口）
proxy	是	Boolean	防护域名是否使用代理 false：不使用代理 true：使用代理
policyid	否	String	防护域名初始绑定的防护策略ID,可以通过策略名称调用查询防护策略列表（ListPolicy）接口查询到对应的策略id
server	是	Array of PremiumWafServer objects	防护域名的源站服务器配置信息
block_page	否	BlockPage object	告警页面配置，该参数为非必填参数。当需要配置自定义页面时，该参数的子字段都为必填参数
forward_header_map	否	Map<String,String>	字段转发配置，WAF会将添加的字段插到header中，转给源站；Key不能跟nginx原生字段重复。Value支持的值包括: $time_local $request_id $connection_requests $tenant_id $project_id $remote_addr $remote_port $scheme $request_method $http_host -$origin_uri $request_length $ssl_server_name $ssl_protocol $ssl_curves $ssl_session_reused
mode	否	String	添加云模式elb接入域名时，请输入elb-shared，否则不输入
loadbalancer_id	否	String	负载均衡器（ELB）id,可以在ELB侧查询其id，添加云模式elb接入域名时，此为必须输入的值
listener_id	否	String	监听器id，可在ELB侧监听器页签下查询其id；不输入时，负载均衡器（ELB）下的所有监听器都将接入WAF防护，包括该ELB下未来新增的符合条件的监听器，添加云模式elb接入域名时，可考虑输入此项id
protocol_port	否	Integer	业务端口，添加云模式elb接入域名时，此为必须输入的值（0 - 65535）
description	否	String	防护域名备注

表5 PremiumWafServer
参数	是否必选	参数类型	描述
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： 1.找到独享引擎所在的虚拟私有云名称，VPC\子网这一列就是VPC的名称：登录WAF的控制台->单击系统管理->独享引擎->VPC\子网 2.登录虚拟私有云 VPC控制台->虚拟私有云->单击虚拟私有云的名称->基本信息的ID

表6 BlockPage
参数	是否必选	参数类型	描述
template	是	String	模板名称，默认页面请输入default，自定义告警页面时请输入custom，重定向请输入redirect
custom_page	否	CustomPage object	自定义告警页面
redirect_url	否	String	“重定向”页面URL

表7 CustomPage
参数	是否必选	参数类型	描述
status_code	是	String	返回状态码
content_type	是	String	“自定义”告警页面内容类型，可选择text/html、text/xml和application/json三种类型
content	是	String	根据选择的“页面类型”配置对应的页面内容，具体示例可以参考“Web应用防火墙 WAF”用户手册

响应参数

状态码： 200

表8 响应Body参数
参数	参数类型	描述
id	String	域名id
hostname	String	防护域名
protocol	String	对外协议，客户端（例如浏览器）请求访问网站的协议类型
server	Array of PremiumWafServer objects	防护域名的源站服务器配置信息
proxy	Boolean	是否使用代理 true：代表使用代理 false：代表未使用代理
locked	Integer	域名冻结状态，0表示未冻结，1表示为冻结，冗余参数
timestamp	Long	创建域名的时间，13位毫秒时间戳
tls	String	配置的最低TLS版本（TLS v1.0/TLS v1.1/TLS v1.2）,默认为TLS v1.0版本，对于低于最低TLS版本的请求，将无法正常访问网站
cipher	String	对外协议为https时才有cipher参数，加密套件（cipher_1，cipher_2，cipher_3，cipher_4，cipher_5，cipher_6，cipher_default）： cipher_1：加密算法为ECDHE-ECDSA-AES256-GCM-SHA384:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!DES:!MD5:!PSK:!RC4:!kRSA:!SRP:!3DES:!DSS:!EXP:!CAMELLIA:@STRENGTH cipher_2：加密算法为EECDH+AESGCM:EDH+AESGCM cipher_3：加密算法为ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH cipher_4：加密算法为ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!EDH cipher_5：加密算法为AES128-SHA:AES256-SHA:AES128-SHA256:AES256-SHA256:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!EXPORT:!DES:!MD5:!PSK:!RC4:!DHE:@STRENGTH cipher_6：加密算法为ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256 cipher_default：加密算法为ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH:!AESGCM
extend	Map<String,String>	扩展字段，用于保存防护域名的一些配置信息。
flag	Flag object	特殊标识，用于前端使用
mode	String	云模式elb接入域名返回此字段：elb-shared
loadbalancer_id	String	云模式elb接入域名返回此字段，表示负载均衡器（ELB）id
listener_id	String	云模式elb接入域名返回此字段，表示监听器id
protocol_port	Integer	云模式elb接入域名返回此字段，表示业务端口
description	String	域名描述
policyid	String	防护域名初始绑定的防护策略ID,可以通过策略名称调用查询防护策略列表（ListPolicy）接口查询到对应的策略id
domainid	String	账号ID,对应控制台用户名->我的凭证->账号ID
projectid	String	项目ID，对应控制台用户名->我的凭证->项目列表->项目ID
enterprise_project_id	String	企业项目ID，对应控制台用户名->企业->项目管理->点击项目名称->ID
protect_status	Integer	域名防护状态： 0：暂停防护，WAF只转发该域名的请求，不做攻击检测 1：开启防护，WAF根据您配置的策略进行攻击检测
access_status	Integer	域名接入状态，0表示未接入，1表示已接入
block_page	BlockPage object	告警页面配置
forward_header_map	Map<String,String>	字段转发配置，WAF会将添加的字段插到header中，转给源站；Key不能跟nginx原生字段重复。Value支持的值包括: $time_local $request_id $connection_requests $tenant_id $project_id $remote_addr $remote_port $scheme $request_method $http_host -$origin_uri $request_length $ssl_server_name $ssl_protocol $ssl_curves $ssl_session_reused

表9 PremiumWafServer
参数	参数类型	描述
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： 1.找到独享引擎所在的虚拟私有云名称，VPC\子网这一列就是VPC的名称：登录WAF的控制台->单击系统管理->独享引擎->VPC\子网 2.登录虚拟私有云 VPC控制台->虚拟私有云->单击虚拟私有云的名称->基本信息的ID

**表10** Flag
参数	参数类型	描述
pci_3ds	String	是否开启pci_3ds合规认证 true：开启 false：不开启
pci_dss	String	是否开启pci_dss合规认证 true：开启 false：不开启
cname	String	old：代表域名使用的老的cname，new：代表域名使用新的cname
is_dual_az	String	是否支持双AZ模式 true：支持 false：不支持
ipv6	String	域名是否开启ipv6 true：支持 false：不支持

**表11** BlockPage
参数	参数类型	描述
template	String	模板名称，默认页面请输入default，自定义告警页面时请输入custom，重定向请输入redirect
custom_page	CustomPage object	自定义告警页面
redirect_url	String	“重定向”页面URL

**表12** CustomPage
参数	参数类型	描述
status_code	String	返回状态码
content_type	String	“自定义”告警页面内容类型，可选择text/html、text/xml和application/json三种类型
content	String	根据选择的“页面类型”配置对应的页面内容，具体示例可以参考“Web应用防火墙 WAF”用户手册

状态码： 400

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息
encoded_authorization_message	String	编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。
details	Array of IAM5ErrorDetails objects	调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。

**表14** IAM5ErrorDetails
参数	参数类型	描述
error_code	String	下游服务错误码
error_msg	String	下游服务报错信息

状态码： 401

**表15** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息
encoded_authorization_message	String	编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。
details	Array of IAM5ErrorDetails objects	调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。

**表16** IAM5ErrorDetails
参数	参数类型	描述
error_code	String	下游服务错误码
error_msg	String	下游服务报错信息

状态码： 500

**表17** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息
encoded_authorization_message	String	编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。
details	Array of IAM5ErrorDetails objects	调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。

**表18** IAM5ErrorDetails
参数	参数类型	描述
error_code	String	下游服务错误码
error_msg	String	下游服务报错信息

请求示例

在项目id为project_id的项目中创建创建独享模式域名，域名为"www.demo.com"，防护域名的源站服务器配置中，客户端请求访问防护域名源站服务器的协议和

WAF转发客户端请求到防护域名源站服务器的协议是HTTP协议，独享引擎所在的虚拟私有云id是"cf6dbace-b36a-4d51-ae04-52a3319ae247",源站地址为ipv4，源站IP地址是x.x.x.x，WAF转发客户端请求到源站服务的业务端口是80。

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

{
  "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",
  "domainid" : "d4ecb00b031941ce9171b7bc3386883f",
  "enterprise_project_id" : "0",
  "protect_status" : 1,
  "access_status" : 0
}

SDK代码示例

SDK代码示例如下。

在项目id为project_id的项目中创建创建独享模式域名，域名为"www.demo.com"，防护域名的源站服务器配置中，客户端请求访问防护域名源站服务器的协议和

      
       
         
         
           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 CreatePremiumHostSolution {

    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();
        CreatePremiumHostRequest request = new CreatePremiumHostRequest();
        CreatePremiumHostRequestBody body = new CreatePremiumHostRequestBody();
        List<PremiumWafServer> listbodyServer = new ArrayList<>();
        listbodyServer.add(
            new PremiumWafServer()
                .withFrontProtocol(PremiumWafServer.FrontProtocolEnum.fromValue("HTTP"))
                .withBackProtocol(PremiumWafServer.BackProtocolEnum.fromValue("HTTP"))
                .withAddress("x.x.x.x")
                .withPort(80)
                .withType(PremiumWafServer.TypeEnum.fromValue("ipv4"))
                .withVpcId("cf6dbace-b36a-4d51-ae04-52a3319ae247")
        );
        body.withDescription("");
        body.withServer(listbodyServer);
        body.withProxy(false);
        body.withHostname("www.demo.com");
        request.withBody(body);
        try {
            CreatePremiumHostResponse response = client.createPremiumHost(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"，防护域名的源站服务器配置中，客户端请求访问防护域名源站服务器的协议和

      
       
         
         
           # 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 = CreatePremiumHostRequest()
        listServerbody = [
            PremiumWafServer(
                front_protocol="HTTP",
                back_protocol="HTTP",
                address="x.x.x.x",
                port=80,
                type="ipv4",
                vpc_id="cf6dbace-b36a-4d51-ae04-52a3319ae247"
            )
        ]
        request.body = CreatePremiumHostRequestBody(
            description="",
            server=listServerbody,
            proxy=False,
            hostname="www.demo.com"
        )
        response = client.create_premium_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"，防护域名的源站服务器配置中，客户端请求访问防护域名源站服务器的协议和

      
       
         
         
           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.CreatePremiumHostRequest{}
	var listServerbody = []model.PremiumWafServer{
        {
            FrontProtocol: model.GetPremiumWafServerFrontProtocolEnum().HTTP,
            BackProtocol: model.GetPremiumWafServerBackProtocolEnum().HTTP,
            Address: "x.x.x.x",
            Port: int32(80),
            Type: model.GetPremiumWafServerTypeEnum().IPV4,
            VpcId: "cf6dbace-b36a-4d51-ae04-52a3319ae247",
        },
    }
	descriptionCreatePremiumHostRequestBody:= ""
	request.Body = &model.CreatePremiumHostRequestBody{
		Description: &descriptionCreatePremiumHostRequestBody,
		Server: listServerbody,
		Proxy: false,
		Hostname: "www.demo.com",
	}
	response, err := client.CreatePremiumHost(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码	描述
200	OK
400	非法请求
401	Token无权限
500	服务器内部错误

错误码

请参见错误码。

父主题：独享模式防护网站管理

上一篇：查询独享模式域名列表

下一篇：修改独享模式域名配置

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

创建独享模式域名

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线