Updated on 2024-04-25 GMT+08:00

Querying Domain Name Settings in Dedicated Mode

Function

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

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. To obtain it, go to Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials.Then, in the Projects area, view Project ID of the corresponding project.

host_id

Yes

String

ID of the domain name protected by the dedicated WAF engine

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

You can obtain the ID by calling the ListEnterpriseProject API of EPS.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Content type.

Default: application/json;charset=utf8

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).

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Domain name ID

hostname

String

Domain name added to the dedicated WAF instance

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 a proxy is used for the protected domain name.

  • false: No proxy is used.

  • true: A proxy is used.

locked

Integer

This parameter is reserved, which will be used to freeze a domain name.

Default: 0

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.

Enumeration values:

  • TLS v1.0

  • TLS v1.1

  • TLS v1.2

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.

  • cipher_1: ECDHE-ECDSA-AES256-GCM-SHA384:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!DES:!MD5:!PSK:!RC4:!kRSA:!SRP:!3DES:!DSS:!EXP:!CAMELLIA:@STRENGTH

  • cipher_2: EECDH+AESGCM:EDH+AESGCM

  • cipher_3: ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH

  • cipher_4: ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!EDH

  • cipher_default: ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH:!AESGCM.

Enumeration values:

  • cipher_1

  • cipher_2

  • cipher_3

  • cipher_4

  • 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 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 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 Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials.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 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.

  • 0: The WAF protection is suspended. WAF only forwards requests destined for the domain name and does not detect attacks.

  • 1: The WAF protection is enabled. WAF detects attacks based on the policy you configure.

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:

  • $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

Protocol used by the client to request access to the origin server.

Enumeration values:

  • HTTP

  • HTTPS

back_protocol

String

Protocol used by WAF to forward client requests it received to origin servers

Enumeration values:

  • HTTP

  • HTTPS

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.

Enumeration values:

  • ipv4

  • ipv6

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.

  • Log in to the WAF console and choose Instance Management > Dedicated Engine > VPC\Subnet. The VPC ID is in the VPC\Subnet column.

  • Log in to the VPC console and click the VPC name. On the page displayed, copy the ID in the VPC Information area.

Table 6 Flag

Parameter

Type

Description

pci_3ds

String

Whether the website passes the PCI 3DS certification check.

  • true: The website passed the PCI 3DS certification check.

  • false: The website failed the PCI 3DS certification check.

Enumeration values:

  • true

  • false

pci_dss

String

Whether the website passed the PCI DSS certification check.

  • true: The website passed the PCI DSS certification check.

  • false: The website failed the PCI DSS certification check.

Enumeration values:

  • true

  • false

cname

String

The CNAME record being used.

  • old: The old CNAME record is used.

  • new: The new CNAME record is used.

Enumeration values:

  • old

  • new

is_dual_az

String

Whether WAF support Multi-AZ DR

  • true: WAF supports multi-AZ DR.

  • false: WAF does not support multi-AZ DR.

Enumeration values:

  • true

  • false

ipv6

String

Whether IPv6 protection is supported.

  • true: IPv6 protection is supported.

  • false: IPv6 protection is not supported.

Enumeration values:

  • true

  • false

Table 7 BlockPage

Parameter

Type

Description

template

String

Template name

custom_page

CustomPage object

Custom alarm page

redirect_url

String

URL of the redirected page

Table 8 CustomPage

Parameter

Type

Description

status_code

String

Status Codes

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.

Table 9 TrafficMark

Parameter

Type

Description

sip

Array of strings

IP tag. HTTP request header field of the original client IP address.

cookie

String

Session tag. This tag is used by known attack source rules to block malicious attacks based on cookie attributes. This parameter must be configured in known attack source rules to block requests based on cookie attributes.

params

String

User tag. This tag is used by known attack source rules to block malicious attacks based on params attributes. This parameter must be configured to block requests based on the params attributes.

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

Procedure

  • 1: Whitelisting the WAF IP addresses.

  • 2: Testing connectivity.

  • 3: Modifying DNS records.

status

Integer

Status. The value can be 0 or 1.

  • 0: The step has not been finished.

  • 1: The step has finished.

Status code: 400

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 401

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 14 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

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"
}

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.