Help Center/ Web Application Firewall/ API Reference/ APIs/ Managing Websites Protected by Dedicated WAF Engines/ Querying Domain Name Settings in Dedicated Mode

Updated on 2026-05-12 GMT+08:00

View PDF

Querying Domain Name Settings in Dedicated Mode

Function

This API is used to query settings of domain names protected with dedicated WAF instances.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/premium-waf/host/{host_id}

**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 N/A Default Value N/A
host_id	Yes	String	Definition Domain name ID, which is obtained by calling the API (ListPremiumHost) for obtaining domain name list in dedicated mode. Constraints N/A Range N/A Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	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.

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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	Domain name ID.
hostname	String	Domain name added to WAF in dedicated mode.
protocol	String	Client protocol used by a client (for example, a browser) to access the website.
server	Array of PremiumWafServer objects	Origin server configuration of the protected domain name
proxy	Boolean	Whether the protected domain name uses a proxy. false: No proxies are used. true: At least one proxy is used.
locked	Integer	This parameter is reserved, which will be used to freeze a domain name.
timestamp	Long	Time the domain name was added to WAF.
tls	String	Minimum 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 required only when the client protocol is HTTPS.
cipher	String	The cipher parameter (cipher_1, cipher_2, cipher_3, cipher_4, cipher_default) is required only when the client protocol is HTTPS. cipher_1: The cryptographic 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 cryptographic algorithm is EECDH+AESGCM:EDH+AESGCM cipher_3: The cryptographic 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 cryptographic 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 cryptographic 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 cryptographic 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 cryptographic algorithm is ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH:!AESGCM
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.
mode	String	elb-shared is returned if cloud load balancer access mode is used.
loadbalancer_id	String	ELB load balancer ID. This field is returned when the cloud load balancer access mode is used.
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	Service port. This field is returned when the cloud load balancer access mode is used.
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 the specific policy.
domainid	String	Account ID. You can obtain it from My Credentials > Account ID page on the Huawei Cloud management console.
projectid	String	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.
enterprise_project_id	String	Enterprise project ID. To obtain it, log in to the Huawei Cloud management console, click the username, choose Enterprise > Project Management, click the project name, and locate the project ID.
certificateid	String	HTTPS certificate ID.
certificatename	String	Certificate name
protect_status	Integer	Definition Domain name protection status. Constraints N/A Range -1: WAF protection is bypassed. Requests are directly sent to backend servers without passing through WAF. 0: WAF protection is suspended. WAF only forwards requests for the domain name but does not detect attacks. 1: WAF protection is enabled. WAF detects attacks based on the configured policy. Default Value N/A
access_status	Integer	Definition Domain name access status. Constraints N/A Range 0: Inaccessible 1: Accessible Default Value N/A
web_tag	String	Website name, which is the same as the website name in the domain name details on the WAF console.
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>	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
access_progress	Array of Access_progress objects	Access progress, which is used only for the new WAF console.

**Table 5** 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: HTTP protocol HTTPS: HTTPS protocol 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: HTTP protocol HTTPS: HTTPS protocol Default Value N/A
weight	Integer	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 cloud mode.
address	String	IP address of origin server accessed by the client.
port	Integer	Port used by WAF to forward client requests to the origin server.
type	String	Type of the origin server address: IPv4 or IPv6
vpc_id	String	VPC ID. You can query the VPC ID in the following way: 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.

**Table 6** Flag
Parameter	Type	Description
pci_3ds	String	Whether to enable PCI 3DS compliance check. true: enabled false: disabled
pci_dss	String	Whether to enable PCI DSS compliance check. true: enabled false: disabled
cname	String	old: The old CNAME record is used. new: The new CNAME record is used.
is_dual_az	String	Whether IPv6 is enabled for the domain name. true: enabled false: disabled
ipv6	String	Whether IPv6 is enabled for the domain name. true: enabled false: disabled

**Table 7** BlockPage
Parameter	Type	Description
template	String	Template name. default: the default page. custom: the custom alarm page. redirect: redirection.
custom_page	CustomPage object	Custom alarm page.
redirect_url	String	URL of the redirection page.

**Table 8** CustomPage
Parameter	Type	Description
status_code	String	Response status code.
content_type	String	Definition Content type of the custom alarm page. Constraints N/A Range text/html text/xml application/json Default Value N/A
content	String	Configure the page content based on the selected page type. For details, see the Web Application Firewall User Guide.

**Table 9** TrafficMark
Parameter	Type	Description
sip	Array of strings	IP tag: The HTTP request header field of the original client IP address.
cookie	String	Session tag, which is used for the cookie-based known attack rules. This tag must be configured for cookie-based known attack rules.
params	String	User tag. This tag is used to block possibly malicious requests based on the Params attribute of an attack source. This tag must be configured for Params-based known attack rules.

**Table 10** TimeoutConfig
Parameter	Type	Description
connect_timeout	Integer	Timeout for WAF to connect to the origin server.
send_timeout	Integer	Timeout for WAF to send requests to the origin server.
read_timeout	Integer	Timeout for WAF to receive responses from the origin server.

**Table 11** Access_progress
Parameter	Type	Description
step	Integer	Step. 1: Whitelist the WAF IP addresses. 2: Test connectivity. 3: Modify DNS resolution.
status	Integer	Definition Completion status of the corresponding step. Constraints N/A Range 0: The step is not finished. 1: The step is finished. Default Value N/A

Status code: 400

**Table 12** 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 13** 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 14** 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 15** 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 16** 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 17** 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 shows how to query configurations of a domain name protected with a dedicated WAF instance in a specific project. The project ID is specified by project_id, and the domain ID is specified by host_id.

GET https://{Endpoint}/v1/{project_id}/premium-waf/host/{host_id}?enterprise_project_id=0

Example Responses

Status code: 200

{
  "id" : "ee896796e1a84f3f85865ae0853d8974",
  "hostname" : "www.demo.com",
  "protocol" : "HTTPS",
  "server" : [ {
    "address" : "1.2.3.4",
    "port" : 443,
    "type" : "ipv4",
    "weight" : 1,
    "front_protocol" : "HTTPS",
    "back_protocol" : "HTTPS",
    "vpc_id" : "ebfc553a-386d-4746-b0c2-18ff3f0e903d"
  } ],
  "proxy" : false,
  "locked" : 0,
  "timestamp" : 1650593801380,
  "tls" : "TLS v1.0",
  "cipher" : "cipher_1",
  "flag" : {
    "pci_3ds" : "false",
    "pci_dss" : "false"
  },
  "description" : "",
  "policyid" : "df15d0eb84194950a8fdc615b6c012dc",
  "domainid" : "0ee78615ca08419f81f539d97c9ee353",
  "projectid" : "550500b49078408682d0d4f7d923f3e1",
  "protect_status" : 1,
  "access_status" : 0,
  "certificateid" : "360f992501a64de0a65c50a64d1ca7b3",
  "certificatename" : "certificatename75315"
}

SDK Sample Code

The SDK sample code is as follows.

     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.*;


public class ShowPremiumHostSolution {

    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();
        ShowPremiumHostRequest request = new ShowPremiumHostRequest();
        request.withHostId("{host_id}");
        try {
            ShowPremiumHostResponse response = client.showPremiumHost(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());
        }
    }
}
 
 
  

     # 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 = ShowPremiumHostRequest()
        request.host_id = "{host_id}"
        response = client.show_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)
 
 
  

     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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := waf.WafClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := waf.NewWafClient(hcClient)

    request := &model.ShowPremiumHostRequest{}
	request.HostId = "{host_id}"
	response, err := client.ShowPremiumHost(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.

Parent Topic: Managing Websites Protected by Dedicated WAF Engines

Previous topic: Modifying a Domain Name Protected by a Dedicated WAF Instance

Next topic: Deleting a Domain Name from a Dedicated WAF Instance

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot