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}
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 |
host_id |
Yes |
String |
Definition ID of the domain name protected by the dedicated WAF engine. Constraints N/A Range N/A Default Value N/A |
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
Default Value 0 |
Request 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
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition Domain name ID. Range N/A |
hostname |
String |
Definition Domain name created in dedicated mode Range N/A |
protocol |
String |
Definition Protocol used by a client (for example, a browser) to access a website. Range
|
server |
Array of PremiumWafServer objects |
Origin server configuration of the protected domain name |
proxy |
Boolean |
Definition Whether a proxy is used for the domain name. Range
|
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 |
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. |
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, 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. |
certificateid |
String |
HTTPS certificate ID. |
certificatename |
String |
Certificate name |
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. |
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:
|
access_progress |
Array of Access_progress objects |
Access progress, which is used only for the new WAF console. |
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
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
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
Default Value N/A |
vpc_id |
String |
Definition VPC ID. To obtain the VPC ID, perform the following steps:
Constraints N/A Range N/A Default Value N/A |
Parameter |
Type |
Description |
---|---|---|
pci_3ds |
String |
Definition Whether to enable PCI 3DS compliance authentication. Constraints N/A Range
Default Value N/A |
pci_dss |
String |
Definition Whether to enable PCI_DSS compliance authentication. Constraints N/A Range
Default Value N/A |
cname |
String |
Definition old: The old CNAME record is used. new: new CNAME record is used. Constraints N/A Range
Default Value N/A |
is_dual_az |
String |
Definition Whether the dual-AZ mode is supported Constraints N/A Range
Default Value N/A |
ipv6 |
String |
Definition Whether IPv6 is enabled for the domain name. Constraints N/A Range
Default Value N/A |
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 |
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 |
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 |
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 |
Parameter |
Type |
Description |
---|---|---|
step |
Integer |
Definition Steps Range
|
status |
Integer |
Definition Status Range
|
Status code: 400
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. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Status code: 401
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. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Status code: 500
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. |
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
OK
{ "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.
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 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()); } } } |
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 = 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) |
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.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.
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