Help Center/ Web Application Firewall/ API Reference/ APIs/ Protected Website Management in Cloud Mode/ Querying Details About a Domain Name by Domain Name ID in Cloud Mode
Updated on 2025-08-19 GMT+08:00

Querying Details About a Domain Name by Domain Name ID in Cloud Mode

Function

This API is used to query details about a domain name protected in cloud mode by domain name ID.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/waf/instance/{instance_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

Enter 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Domain name ID. You can call the ListHost API to obtain the domain name ID.

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

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

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

N/A

Default Value

application/json;charset=utf8

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Definition

Domain name ID.

Range

N/A

hostname

String

Definition

Domain name added to cloud WAF.

Range

N/A

policyid

String

Definition

Protection policy ID.

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

protocol

String

Definition

Backend protocol type. The value can be HTTPS, HTTP, or HTTP&HTTPS.

Range

N/A

server

Array of CloudWafServer objects

Origin server configuration of the protected domain name

proxy

Boolean

Definition

Whether the protected domain name uses a proxy.

Range

  • false: No proxy is used.

  • true: At least one proxy is used.

protect_status

Integer

Definition

Domain protection status.

Range

  • -1: Bypassed. Requests are directly sent to the backend servers without passing through WAF.

  • 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

access_code

String

Definition

CNAME prefix. The CNAME suffix is .vip1.huaweicloudwaf.com.

Range

N/A

locked

Integer

Definition

This parameter is reserved for freezing and unlocking domain names. Currently, this parameter is not supported.

Range

N/A

timestamp

Long

Definition

Timestamp when the protected domain name was created (Unit: ms)

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.

tls

String

Definition

Minimum TLS version (TLS v1.0, TLS v1.1, or TLS v1.2). The default value is TLS v1.0. Requests that do not meet the minimum TLS version cannot access the website.

Range

  • TLS v1.0

  • TLS v1.1

  • TLS v1.2

cipher

String

Definition

Cipher Suite (cipher_1, cipher_2, cipher_3, cipher_4, cipher_5, cipher_6, cipher_default)

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.

block_page

BlockPage object

Alarm page configuration

extend

Map<String,String>

Definition

Extended field, which is used to store the switch configuration of basic web protection.

Range

N/A

traffic_mark

TrafficMark object

Traffic identifier

circuit_breaker

CircuitBreaker object

Circuit breaker configuration

lb_algorithm

String

Definition

Load balancing (available only for professional and enterprise editions).

  • Origin server IP hash: Requests from the same IP address are routed to the same backend server.

  • Weighted round robin: Requests are distributed across backend servers in turn based on the weight you assign to each server.

  • Session hash: Requests with the same session tag are routed to the same origin server. To enable this algorithm, configure traffic identifiers for known attack sources, or session hash algorithm cannot take effect.

Range

  • ip_hash

  • round_robin

  • session_hash

timeout_config

TimeoutConfig object

Timeout settings

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

flag

Flag object

Special identifier, which is used on the console.

description

String

Definition

Website remarks.

Range

N/A

http2_enable

Boolean

Definition

Whether HTTP/2 is supported.

Range

  • true: HTTP/2 is supported.

  • false: HTTP/2 is not supported.

exclusive_ip

Boolean

Definition

Whether to use the dedicated public IP address. This parameter is reserved for future function expansion and can be ignored.

Range

  • true: A dedicated IP address is used.

  • false: No dedicated IP address is used.

access_progress

Array of Access_progress objects

Definition

Access progress, which is used only for the new console (frontend).

Range

N/A

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

Range

N/A

Table 5 CloudWafServer

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: Requests are distributed across backend origin servers based on the load balancing algorithm you select and the weight you assign to each server.

Constraints

N/A

Range

The default value is 1, which is a redundant field in cloud mode.

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

Table 6 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 7 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 8 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 9 CircuitBreaker

Parameter

Type

Description

switch

Boolean

Definition

Circuit breaker switch, indicating whether to enable connection protection

Constraints

N/A

Range

  • true: Connection protection is enabled.

  • false: Connection protection is disabled.

Default Value

N/A

dead_num

Integer

Definition

502/504 error quantity threshold, that is, the 502/504 error quantity threshold accumulated every 30s.

Constraints

N/A

Range

N/A

Default Value

N/A

dead_ratio

Number

Definition

Percentage of 502/504 errors (%). When the percentage of 502/504 errors in the total number of requests reaches the specified value and the number threshold is met, breakdown protection is triggered.

Constraints

N/A

Range

N/A

Default Value

N/A

block_time

Integer

Definition

Protection period upon the first breakdown. During this period, WAF stops forwarding client requests.

Constraints

N/A

Range

N/A

Default Value

N/A

superposition_num

Integer

Definition

The maximum multiplier you can use for consecutive breakdowns. The number of breakdowns are counted from 0 every time the accumulated breakdown protection duration reaches 3,600s. For example, the initial protection time is set to 180s, and the continuous trigger addition coefficient is set to 3.

Constraints

N/A

Range

  • When the number of triggering times is 2 (that is, less than 3), the protection time is 360s.

  • When the number of times is greater than or equal to 3, the protection time is 540s.

  • When the accumulated protection time exceeds 1 hour (3600s), the number of accumulated times is counted from the beginning.

Default Value

N/A

suspend_num

Integer

Definition

Threshold of the number of read waiting URL requests. When the number of read waiting URL requests reaches the threshold, connection protection is triggered.

Constraints

N/A

Range

N/A

Default Value

N/A

sus_block_time

Integer

Definition

Circuit breaker time when the number of read waiting URL requests exceeds the threshold. When the number of read waiting URL requests reaches the protection time triggered by the threshold, WAF stops forwarding user requests.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 10 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

Table 11 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 12 Access_progress

Parameter

Type

Description

step

Integer

Definition

Steps

Range

  • 1: Whitelist the WAF IP addresses.

  • 2: Test connectivity.

  • 3: Modify DNS resolution.

status

Integer

Definition

Status

Range

  • 0: This step is not complete.

  • 1: completed

Status code: 400

Table 13 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 14 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 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: 500

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.

Example Requests

The following shows how to obtain details about domain names protected with cloud WAF in a specific project. The project ID is specified by project_id, and the domain ID is specified by instance_id.

GET https://{Endpoint}/v1/{project_id}/waf/instance/{instance_id}?enterprise_project_id=0

Example Responses

Status code: 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,
  "locked" : 0,
  "timestamp" : 1650527546420,
  "flag" : {
    "pci_3ds" : "false",
    "pci_dss" : "false",
    "ipv6" : "false",
    "cname" : "new",
    "is_dual_az" : "true"
  },
  "description" : "",
  "policyid" : "41cba8aee2e94bcdbf57460874205494",
  "domainid" : "d4ecb00b031941ce9171b7bc3386883f",
  "projectid" : "0456cf04d6f64725ab02ed5bd2efdfa4",
  "enterprise_project_id" : "0",
  "protect_status" : 0,
  "access_status" : 0,
  "access_code" : "1b18879b9d064f8bbcbf8abce7294cac",
  "block_page" : {
    "template" : "default"
  },
  "web_tag" : "",
  "exclusive_ip" : false,
  "http2_enable" : false
}

SDK Sample Code

The SDK sample code is as follows.

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

    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();
        ShowHostRequest request = new ShowHostRequest();
        request.withInstanceId("{instance_id}");
        try {
            ShowHostResponse response = client.showHost(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());
        }
    }
}
 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
# 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 = ShowHostRequest()
        request.instance_id = "{instance_id}"
        response = client.show_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)
 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
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.ShowHostRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ShowHost(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

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.