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

Querying Features Available at a Site

Function

This API is used to query the features available at specific site.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/waf/config/console

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

Request Parameters

Table 2 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 3 Response body parameters

Parameter

Type

Description

eps

Boolean

Definition

Whether EPS is supported.

Range

  • false: not supported

  • true: supported

tls

Boolean

Definition

Minimum TLS version supported (TLS v1.0, TLS v1.1, or TLS v1.2). TLS v1.0 is used by default.

Range

  • false: not supported

  • true: supported

ipv6

Boolean

Definition

Whether IPv6 is supported.

Range

  • false: not supported

  • true: supported

alert

Boolean

Definition

Whether alarms are supported.

Range

  • false: not supported

  • true: supported

custom

Boolean

Definition

Whether precise protection is supported.

Range

  • false: not supported

  • true: supported

elb_mode

Boolean

Definition

Whether the ELB mode is supported.

Range

  • false: not supported

  • true: supported

event_lts

Boolean

Definition

Whether LTS for WAF logging is supported.

Range

  • false: not supported

  • true: supported

multi_dns

Boolean

Definition

Whether multiple DNS resolution records are supported.

Range

  • false: not supported

  • true: supported

search_ip

Boolean

Definition

Whether IP address search is supported.

Range

  • false: not supported

  • true: supported

cc_enhance

Boolean

Definition

Whether CC enhancement is supported.

Range

  • false: not supported

  • true: supported

cname_switch

Boolean

Definition

Whether CNAME switchover is supported.

Range

  • false: not supported

  • true: supported

custom_block

Boolean

Definition

Whether custom block pages are supported.

Range

  • false: not supported

  • true: supported

advanced_ignore

Boolean

Definition

Whether false alarm masking is supported.

Range

  • false: not supported

  • true: supported

js_crawler_enable

Boolean

Definition

Whether JS anti-crawler is supported.

Range

  • false: not supported

  • true: supported

deep_decode_enable

Boolean

Definition

Whether in-depth detection of basic web protection is supported.

Range

  • false: not supported

  • true: supported

overview_bandwidth

Boolean

Definition

Whether security overview bandwidth statistics are supported.

Range

  • false: not supported

  • true: supported

proxy_use_oldcname

Boolean

Definition

Whether the old CNAME record can be used for resolution.

Range

  • false: not supported

  • true: supported

check_all_headers_enable

Boolean

Definition

Whether all headers can be checked.

Range

  • false: not supported

  • true: supported

geoip_enable

Boolean

Definition

Whether geolocation access control is supported.

Range

  • false: not supported

  • true: supported

load_balance_enable

Boolean

Definition

Whether load balancer access is supported.

Range

  • false: not supported

  • true: supported

ipv6_protection_enable

Boolean

Definition

Whether IPv6 protection is supported.

Range

  • false: not supported

  • true: supported

policy_sharing_enable

Boolean

Definition

Whether policy sharing is supported.

Range

  • false: not supported

  • true: supported

ip_group

Boolean

Definition

Whether IP address groups are supported.

Range

  • false: not supported

  • true: supported

robot_action_enable

Boolean

Definition

Whether website anti-crawler is supported.

Range

  • false: not supported

  • true: supported

http2_enable

Boolean

Definition

Whether HTTP/2 is supported.

Range

  • false: not supported

  • true: supported

timeout_config_enable

Boolean

Definition

Whether timeout configuration is supported.

Range

  • false: not supported

  • true: supported

Status code: 400

Table 4 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 5 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 6 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 7 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 8 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 9 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 query the features enabled at a site. The project ID is specified by project_id and the time is from 2022-04-21 00:00:00 to 2022-04-21 14:45:20.

GET https://{Endpoint}/v1/{project_id}/waf/config/console?enterprise_project_id=0&from=1650470400089&to=1650523520089

Example Responses

Status code: 200

OK

{
  "eps" : true,
  "tls" : true,
  "ipv6" : true,
  "alert" : true,
  "custom" : true,
  "ip_group" : true,
  "event_lts" : true,
  "multi_dns" : true,
  "search_ip" : true,
  "cc_enhance" : true,
  "cname_switch" : true,
  "custom_block" : true,
  "geoip_enable" : true,
  "http2_enable" : true,
  "advanced_ignore" : true,
  "js_crawler_enable" : true,
  "deep_decode_enable" : true,
  "overview_bandwidth" : true,
  "proxy_use_oldcname" : false,
  "load_balance_enable" : true,
  "robot_action_enable" : true,
  "policy_sharing_enable" : true,
  "timeout_config_enable" : true,
  "ipv6_protection_enable" : true,
  "check_all_headers_enable" : true,
  "elb_mode" : true
}

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

    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();
        ShowConsoleConfigRequest request = new ShowConsoleConfigRequest();
        try {
            ShowConsoleConfigResponse response = client.showConsoleConfig(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
# 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 = ShowConsoleConfigRequest()
        response = client.show_console_config(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
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.ShowConsoleConfigRequest{}
	response, err := client.ShowConsoleConfig(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.