Updated on 2025-08-19 GMT+08:00

Adding a Domain Name to a Dedicated WAF Instance

Function

This API is used to add a domain name to a dedicated WAF instance.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose My Credentials, and find the project ID in the Projects list.

Constraints

N/A

Range

Enter 32 characters. Only letters and digits are allowed.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). To obtain the resource details in all enterprise projects of a user, set this parameter to all_granted_eps.

Constraints

N/A

Range

  • 0: the default enterprise project.

  • all_granted_eps: all enterprise projects.

  • A specific enterprise project ID: Enter a maximum of 36 characters.

Default Value

0

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

N/A

Default Value

application/json;charset=utf8

X-Auth-Token

Yes

String

Definition

User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Constraints

N/A

Range

N/A

Default Value

N/A

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

certificateid

No

String

Definition

Certificate ID, which can be obtained by calling the ListCertificates API.

Constraints

  • This parameter is not required if the client protocol is HTTP.

  • This parameter is mandatory if the client protocol is HTTPS.

Range

N/A

Default Value

N/A

certificatename

No

String

Definition

Certificate name.

Constraints

  • This parameter is not required if the client protocol is HTTP.

  • This parameter is mandatory if the client protocol is HTTPS.

Range

N/A

Default Value

N/A

hostname

Yes

String

Definition

Protected domain name or IP address (port allowed)

Constraints

N/A

Range

N/A

Default Value

N/A

proxy

Yes

Boolean

Definition

Whether the protected domain name uses a proxy.

Constraints

N/A

Range

  • false: No proxy is used.

  • true: At least one proxy is used.

Default Value

N/A

policyid

No

String

Definition

ID of the protection policy initially bound to the protected domain name. You can call the ListPolicy API to query the policy ID based on the policy name.

Constraints

N/A

Range

N/A

Default Value

N/A

server

Yes

Array of PremiumWafServer objects

Origin server configuration of the protected domain name.

block_page

No

BlockPage object

Alarm page configuration. This parameter is optional. When a user-defined page needs to be configured, all subfields of this parameter are mandatory.

forward_header_map

No

Map<String,String>

Definition

Field forwarding configuration. WAF inserts the added fields into the header and forwards the header to the origin server. The key cannot be the same as the native Nginx field. The options of Value are as follows:

  • $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

Constraints

N/A

Range

N/A

Default Value

N/A

mode

No

String

Definition

If you use the cloud load balancer access mode, enter enter elb-shared. Otherwise, leave this parameter blank.

Constraints

N/A

Range

N/A

Default Value

N/A

loadbalancer_id

No

String

Definition

Load balancer (ELB) ID, which can be queried on the ELB side. This parameter is mandatory when a cloud ELB access domain name is added.

Constraints

N/A

Range

N/A

Default Value

N/A

listener_id

No

String

Definition

Listener ID. You can query the listener ID on the Listeners tab on the ELB console. If you leave this parameter blank, all listeners configured and to be configured for the load balancer will be protected by WAF. In cloud load balancer access mode, you are advised to set this parameter.

Constraints

N/A

Range

N/A

Default Value

N/A

protocol_port

No

Integer

Definition

Specifies the service port. This parameter is mandatory when you add an ELB access domain name in cloud mode.

Constraints

N/A

Range

0 - 65535

Default Value

N/A

description

No

String

Definition

Domain NAME REMARKS

Constraints

N/A

Range

0 - 65535

Default Value

N/A

web_tag

No

String

Definition

Website name, which is the website name displayed on the domain name details page on the WAF console.

Constraints

N/A

Range

Enter 0 to 128 characters.

Default Value

N/A

Table 5 PremiumWafServer

Parameter

Mandatory

Type

Description

front_protocol

Yes

String

Definition

Protocol used by the client to access the origin server of the protected domain name.

Constraints

N/A

Range

  • HTTP

  • HTTPS

Default Value

N/A

back_protocol

Yes

String

Definition

Protocol used by WAF to forward client requests to the origin server of the protected domain name.

Constraints

N/A

Range

  • HTTP

  • HTTPS

Default Value

N/A

weight

No

Integer

Definition

Weight of the origin server. The load balancing algorithm allocates requests to the origin server based on the weight. The default value is 1. This parameter is not required for WAF cloud mode.

Constraints

N/A

Range

N/A

Default Value

N/A

address

Yes

String

Definition

IP address of origin server accessed by the client.

Constraints

N/A

Range

N/A

Default Value

N/A

port

Yes

Integer

Definition

Port used by WAF to forward client requests to the origin server.

Constraints

N/A

Range

N/A

Default Value

N/A

type

Yes

String

Definition

Type of the origin server address: IPv4 or IPv6

Constraints

N/A

Range

  • ipv4

  • ipv6

Default Value

N/A

vpc_id

Yes

String

Definition

VPC ID. To obtain the VPC ID, perform the following steps:

  • 1. Query the name of the VPC where the dedicated engine (instance) is provisioned. To do so, log in to the WAF console and choose Instance Management > Dedicated Engine . Locate the target instance, and check the VPC and Subnet column. The VPC name is displayed in the VPC and subnet columns.

  • 2. Go to the VPC console and choose Virtual Private Cloud > My VPCs. You can copy the ID next to the VPC name or click the VPC name and copy the ID in the VPC Information area.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 6 BlockPage

Parameter

Mandatory

Type

Description

template

Yes

String

Definition

Template name. Enter default for the default page, custom for the customized alarm page, and redirect for redirection.

Constraints

N/A

Range

N/A

Default Value

N/A

custom_page

No

CustomPage object

Custom alarm page.

redirect_url

No

String

Definition

URL of the redirection page.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 7 CustomPage

Parameter

Mandatory

Type

Description

status_code

Yes

String

Definition

Return Code

Constraints

N/A

Range

N/A

Default Value

N/A

content_type

Yes

String

Definition

Content type of the custom alarm page. The options are text/html, text/xml, and application/json.

Constraints

N/A

Range

N/A

Default Value

N/A

content

Yes

String

Definition

Configure the page content based on the selected page type. For details, see the Web Application Firewall User Manual.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 8 Response body parameters

Parameter

Type

Description

id

String

Domain name ID

hostname

String

Protected domain names

protocol

String

Client protocol, which is the protocol used by a client (for example, a browser) to access your website.

server

Array of PremiumWafServer objects

Origin server configuration of the protected domain name

proxy

Boolean

Whether to use a proxy

  • true: A proxy is used.

  • false: No proxies are used.

locked

Integer

Domain name status. The value can be 0 or 1.

  • 0: The domain name is not frozen.

  • 1: The domain name is frozen. This parameter is redundant in this version.

timestamp

Long

Time the domain name was added to WAF. The value is a 13-digit timestamp in ms.

tls

String

TLS version. You can use TLS v1.0, TLS v1.1, or TLS v1.2. TLS v1.0 is used by default. Parameter tls is available only when the client protocol is HTTPS.

cipher

String

Definition

The cipher parameter (cipher_1, cipher_2, cipher_3, cipher_4, cipher_5, cipher_6, cipher_default) is available only when the external protocol is HTTPS.

Range

  • cipher_1: The encryption algorithm is ECDHE-ECDSA-AES256-GCM-SHA384:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!DES:!MD5:!PSK:!RC4:!kRSA:!SRP:!3DES:!DSS:!EXP:!CAMELLIA:@STRENGTH.

  • cipher_2: The encryption algorithm is EECDH+AESGCM:EDH+AESGCM.

  • cipher_3: The encryption algorithm is ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH.

  • cipher_4: The encryption algorithm is 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: The encryption algorithm is AES128-SHA:AES256-SHA:AES128-SHA256:AES256-SHA256:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!EXPORT:!DES:!MD5:!PSK:!RC4:!DHE:@STRENGTH.

  • cipher_6: The encryption algorithm is 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: The encryption algorithm is ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH:!AESGCM.

extend

Map<String,String>

Definition

Extended field, which is used to save the configuration information of the protected domain name.

Range

N/A

flag

Flag object

Special identifier, which is used on the console.

mode

String

Definition

elb-shared is returned if cloud load balancer access mode is used.

Range

N/A

loadbalancer_id

String

Definition

ELB load balancer ID. This field is returned when the cloud load balancer access mode is used.

Range

N/A

listener_id

String

ID of the listener configured for the ELB load balancer. This field is returned when the cloud load balancer access mode is used.

protocol_port

Integer

Definition

Service port. This field is returned when the cloud load balancer access mode is used.

Range

N/A

description

String

Definition

Domain name description.

Range

N/A

policyid

String

Definition

ID of the protection policy initially bound to the protected domain name. You can call the ListPolicy API to query the policy ID based on the policy name.

Range

N/A

domainid

String

Definition

Account ID. You can obtain it from My Credentials > Account ID page on the management console.

Range

N/A

projectid

String

Definition

Project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose My Credentials, and find the project ID in the Projects list.

Range

N/A

enterprise_project_id

String

Definition

Enterprise project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose Enterprise > Project Management, click the project name, and locate the project ID.

Range

N/A

certificateid

String

Definition

HTTPS certificate ID.

Range

N/A

certificatename

String

Definition

Certificate name.

Range

Enter a maximum of 256 characters. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

protect_status

Integer

Definition

Domain protection status.

Range

  • 0: The WAF protection is suspended. WAF only forwards requests for the domain name but does not detect attacks.

  • 1: The WAF protection is enabled. WAF detects attacks based on the configured policy.

access_status

Integer

Definition

Domain name access status.

Range

  • 0: Inaccessible.

  • 1: Accessible.

web_tag

String

Definition

Website name, which is the website name displayed on the domain name details page on the WAF console.

Range

N/A

block_page

BlockPage object

Alarm page configuration

traffic_mark

TrafficMark object

Traffic identifier.

timeout_config

TimeoutConfig object

Timeout settings.

forward_header_map

Map<String,String>

Definition

Field forwarding configuration. WAF inserts the added fields into the header and forwards the header to the origin server. The key cannot be the same as the native Nginx field. The options of Value are as follows:

  • $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

Table 9 PremiumWafServer

Parameter

Type

Description

front_protocol

String

Definition

Protocol used by the client to access the origin server of the protected domain name.

Constraints

N/A

Range

  • HTTP

  • HTTPS

Default Value

N/A

back_protocol

String

Definition

Protocol used by WAF to forward client requests to the origin server of the protected domain name.

Constraints

N/A

Range

  • HTTP

  • HTTPS

Default Value

N/A

weight

Integer

Definition

Weight of the origin server. The load balancing algorithm allocates requests to the origin server based on the weight. The default value is 1. This parameter is not required for WAF cloud mode.

Constraints

N/A

Range

N/A

Default Value

N/A

address

String

Definition

IP address of origin server accessed by the client.

Constraints

N/A

Range

N/A

Default Value

N/A

port

Integer

Definition

Port used by WAF to forward client requests to the origin server.

Constraints

N/A

Range

N/A

Default Value

N/A

type

String

Definition

Type of the origin server address: IPv4 or IPv6

Constraints

N/A

Range

  • ipv4

  • ipv6

Default Value

N/A

vpc_id

String

Definition

VPC ID. To obtain the VPC ID, perform the following steps:

  • 1. Query the name of the VPC where the dedicated engine (instance) is provisioned. To do so, log in to the WAF console and choose Instance Management > Dedicated Engine . Locate the target instance, and check the VPC and Subnet column. The VPC name is displayed in the VPC and subnet columns.

  • 2. Go to the VPC console and choose Virtual Private Cloud > My VPCs. You can copy the ID next to the VPC name or click the VPC name and copy the ID in the VPC Information area.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 10 Flag

Parameter

Type

Description

pci_3ds

String

Definition

Whether to enable PCI 3DS compliance authentication.

Constraints

N/A

Range

  • true: enabled

  • false: disabled

Default Value

N/A

pci_dss

String

Definition

Whether to enable PCI_DSS compliance authentication.

Constraints

N/A

Range

  • true: enabled

  • false: disabled

Default Value

N/A

cname

String

Definition

old: The old CNAME record is used. new: new CNAME record is used.

Constraints

N/A

Range

  • old: old CNAME used by the domain name

  • new: The domain name uses a new CNAME.

Default Value

N/A

is_dual_az

String

Definition

Whether the dual-AZ mode is supported

Constraints

N/A

Range

  • true: supported

  • false: not supported

Default Value

N/A

ipv6

String

Definition

Whether IPv6 is enabled for the domain name.

Constraints

N/A

Range

  • true: supported

  • false: not supported

Default Value

N/A

Table 11 BlockPage

Parameter

Type

Description

template

String

Definition

Template name. Enter default for the default page, custom for the customized alarm page, and redirect for redirection.

Constraints

N/A

Range

N/A

Default Value

N/A

custom_page

CustomPage object

Custom alarm page.

redirect_url

String

Definition

URL of the redirection page.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 12 CustomPage

Parameter

Type

Description

status_code

String

Definition

Return Code

Constraints

N/A

Range

N/A

Default Value

N/A

content_type

String

Definition

Content type of the custom alarm page. The options are text/html, text/xml, and application/json.

Constraints

N/A

Range

N/A

Default Value

N/A

content

String

Definition

Configure the page content based on the selected page type. For details, see the Web Application Firewall User Manual.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 13 TrafficMark

Parameter

Type

Description

sip

Array of strings

Definition

IP flag, which is the HTTP request header field of the original IP address of the client.

Constraints

N/A

Range

N/A

Default Value

N/A

cookie

String

Definition

Session flag, which is used for the attack punishment function of malicious cookie requests. This flag must be configured before the attack punishment function for cookie interception is selected.

Constraints

N/A

Range

N/A

Default Value

N/A

params

String

Definition

User flag, which is used for the attack punishment function of Params malicious requests. Configure this parameter to block requests based on the Params attributes.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 14 TimeoutConfig

Parameter

Type

Description

connect_timeout

Integer

Definition

Timeout for WAF to connect to the origin server.

Constraints

N/A

Range

N/A

Default Value

N/A

send_timeout

Integer

Definition

Timeout for WAF to send requests to the origin server.

Constraints

N/A

Range

N/A

Default Value

N/A

read_timeout

Integer

Definition

Timeout for WAF to receive responses from the origin server.

Constraints

N/A

Range

N/A

Default Value

N/A

Status code: 400

Table 15 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 16 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 401

Table 17 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 18 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 500

Table 19 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 20 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Example Requests

The following example shows how to add a website domain name to a dedicated WAF instance in a specific project. The project ID is specified by project_id, and the domain name is www.demo.com. The client protocol and server protocol is HTTP. The origin server address is ipv4 x.x.x.x. The service port used by WAF to forward client requests to the origin server is 80. The ID of the VPC where the dedicated WAF instance is deployed is cf6dbace-b36a-4d51-ae04-52a3319ae247.

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" : ""
}

Example Responses

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

SDK Sample Code

The SDK sample code is as follows.

The following example shows how to add a website domain name to a dedicated WAF instance in a specific project. The project ID is specified by project_id, and the domain name is www.demo.com. The client protocol and server protocol is HTTP. The origin server address is ipv4 x.x.x.x. The service port used by WAF to forward client requests to the origin server is 80. The ID of the VPC where the dedicated WAF instance is deployed is cf6dbace-b36a-4d51-ae04-52a3319ae247.

 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
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());
        }
    }
}

The following example shows how to add a website domain name to a dedicated WAF instance in a specific project. The project ID is specified by project_id, and the domain name is www.demo.com. The client protocol and server protocol is HTTP. The origin server address is ipv4 x.x.x.x. The service port used by WAF to forward client requests to the origin server is 80. The ID of the VPC where the dedicated WAF instance is deployed is cf6dbace-b36a-4d51-ae04-52a3319ae247.

 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
# 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)

The following example shows how to add a website domain name to a dedicated WAF instance in a specific project. The project ID is specified by project_id, and the domain name is www.demo.com. The client protocol and server protocol is HTTP. The origin server address is ipv4 x.x.x.x. The service port used by WAF to forward client requests to the origin server is 80. The ID of the VPC where the dedicated WAF instance is deployed is cf6dbace-b36a-4d51-ae04-52a3319ae247.

 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
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)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

400

Invalid request.

401

The token does not have the required permission.

500

Internal server error.

Error Codes

See Error Codes.