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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. To obtain it, go to Huawei Cloud management cons**. Then, in the Projects area, view Project ID of the corresponding project. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
You can obtain the ID by calling the ListEnterpriseProject API of EPS. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Content type. |
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
certificateid |
No |
String |
Certificate ID. It can be obtained by calling the ListCertificates API.
|
certificatename |
No |
String |
Certificate name.
|
hostname |
Yes |
String |
Protected domain name or IP address (port allowed) |
proxy |
Yes |
Boolean |
Whether a proxy is used for the protected domain name.
|
policyid |
No |
String |
ID of the policy initially used to the domain name. You can call the ListPolicy API to query the policy list and view the ID of a specific policy. |
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> |
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:
|
mode |
No |
String |
If you use the cloud load balancer access mode, enter enter elb-shared. Otherwise, leave this parameter blank. |
loadbalancer_id |
No |
String |
ID of the ELB load balancer. This parameter is mandatory if you use the cloud load balancer access mode. |
listener_id |
No |
String |
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. |
protocol_port |
No |
Integer |
Port. This parameter is mandatory if you use the cloud load balancer access mode. (0 - 65535) |
description |
No |
String |
Remarks of the protected domain name. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
front_protocol |
Yes |
String |
Protocol used by the client to request access to the origin server. |
back_protocol |
Yes |
String |
Protocol used by WAF to forward client requests it received to origin servers. |
weight |
No |
Integer |
Weight of the origin server. The load balancing algorithm forwards requests to the origin server based on the weight. The default value is 1. This field is not included by cloud WAF. |
address |
Yes |
String |
IP address of your origin server requested by the client. |
port |
Yes |
Integer |
Port used by WAF to forward client requests to the origin server. |
type |
Yes |
String |
The origin server address is an IPv4 or IPv6 address. |
vpc_id |
Yes |
String |
VPC ID. To obtain the VPC ID, perform the following steps: Use either of the following methods to obtain the VPC ID.
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
template |
Yes |
String |
Template name. |
custom_page |
No |
CustomPage object |
Custom alarm page. |
redirect_url |
No |
String |
URL of the redirected page. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
status_code |
Yes |
String |
Status code. |
content_type |
Yes |
String |
The content type of the custom alarm page. The value can be text/html, text/xml, or application/json. |
content |
Yes |
String |
The page content based on the selected page type. For details, see the Web Application Firewall (WAF) User Guide. |
Response Parameters
Status code: 200
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
|
locked |
Integer |
Domain name status. The value can be 0 or 1.
|
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 |
Parameter cipher is required only when the client protocol is HTTPS. The value can be cipher_1, cipher_2, cipher_3, cipher_4, or cipher_default.
|
extend |
Map<String,String> |
Extended field, which is used to save some configuration information about the protected domain name. |
flag |
Flag object |
Special identifier, which is used on the console. |
description |
String |
Domain name description |
policyid |
String |
ID of the policy initially used to the domain name. You can call the ListPolicy API to query the policy list and view the ID of a specific policy. |
domainid |
String |
Account ID, which is the same as the account ID on the My Credentials page. To go to this page, log in to Huawei Cloud management console, hover the cursor over your username, and click My Credentials in the displayed window. |
projectid |
String |
Project ID. To obtain it, go to Huawei Cloud management cons**. Then, in the Projects area, view Project ID of the corresponding project. |
enterprise_project_id |
String |
Enterprise project ID. To obtain the ID, log in to the Huawei Cloud management console first. On the menu bar at the top of the page, choose Enterprise > Project Management. Then, click the project name and view the ID. |
protect_status |
Integer |
WAF status of the protected domain name.
|
access_status |
Integer |
Domain name access status. The value can be 0 or 1. 0: The website traffic has not been routed to WAF. 1: The website traffic has been routed to WAF. |
block_page |
BlockPage object |
Alarm page configuration |
forward_header_map |
Map<String,String> |
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:
|
Parameter |
Type |
Description |
---|---|---|
front_protocol |
String |
Protocol used by the client to request access to the origin server. |
back_protocol |
String |
Protocol used by WAF to forward client requests it received to origin servers. |
weight |
Integer |
Weight of the origin server. The load balancing algorithm forwards requests to the origin server based on the weight. The default value is 1. This field is not included by cloud WAF. |
address |
String |
IP address of your origin server requested by the client. |
port |
Integer |
Port used by WAF to forward client requests to the origin server. |
type |
String |
The origin server address is an IPv4 or IPv6 address. |
vpc_id |
String |
VPC ID. To obtain the VPC ID, perform the following steps: Use either of the following methods to obtain the VPC ID.
|
Parameter |
Type |
Description |
---|---|---|
pci_3ds |
String |
Whether the website passes the PCI 3DS certification check.
|
pci_dss |
String |
Whether the website passed the PCI DSS certification check.
|
cname |
String |
The CNAME record being used.
|
is_dual_az |
String |
Whether WAF support Multi-AZ DR
|
ipv6 |
String |
Whether IPv6 protection is supported.
|
Parameter |
Type |
Description |
---|---|---|
template |
String |
Template name. |
custom_page |
CustomPage object |
Custom alarm page. |
redirect_url |
String |
URL of the redirected page. |
Parameter |
Type |
Description |
---|---|---|
status_code |
String |
Status code. |
content_type |
String |
The content type of the custom alarm page. The value can be text/html, text/xml, or application/json. |
content |
String |
The page content based on the selected page type. For details, see the Web Application Firewall (WAF) User Guide. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot