Updated on 2023-09-08 GMT+08:00

Adding a Domain Name to a Dedicated WAF Instance

Function

This API is used to connect a domain name to a dedicated WAF instance.

URI

POST /v1/{project_id}/premium-waf/host

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.

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

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

certificateid

No

String

Certificate ID. It can be obtained by calling the ListCertificates API.

  • This parameter is not required when the client protocol is HTTP.

  • This parameter is mandatory when the client protocol is HTTPS.

certificatename

No

String

Certificate name.

  • This parameter is not required when the client protocol is HTTP.

  • This parameter is mandatory when the client protocol is HTTPS.

hostname

Yes

String

Protected domain name or IP address (port allowed)

proxy

Yes

Boolean

Whether a proxy is used for the protected domain name.

  • false: No proxy is used.

  • true: A proxy is used.

policyid

No

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 a specific policy.

server

Yes

Array of PremiumWafServer objects

Origin server configuration of the protected domain name

block_page

No

BlockPage object

Alarm page configuration. This parameter is optional. When a user-defined page needs to be configured, all subfields of this parameter are mandatory.

description

No

String

Remarks of the protected domain name

Table 5 PremiumWafServer

Parameter

Mandatory

Type

Description

front_protocol

Yes

String

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

Enumeration values:

  • HTTP

  • HTTPS

back_protocol

Yes

String

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

Enumeration values:

  • HTTP

  • HTTPS

weight

No

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

Yes

String

IP address of your origin server requested by the client

port

Yes

Integer

Port used by WAF to forward client requests to the origin server

type

Yes

String

The origin server address is an IPv4 or IPv6 address.

Enumeration values:

  • ipv4

  • ipv6

vpc_id

Yes

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 BlockPage

Parameter

Mandatory

Type

Description

template

Yes

String

Template name

custom_page

No

CustomPage object

Custom alarm page

redirect_url

No

String

URL of the redirected page

Table 7 CustomPage

Parameter

Mandatory

Type

Description

status_code

Yes

String

Status Codes

content_type

Yes

String

The content type of the custom alarm page. The value can be text/html, text/xml, or application/json.

content

Yes

String

The page content based on the selected page type. For details, see the Web Application Firewall (WAF) User Guide.

Response Parameters

Status code: 200

Table 8 Response body parameters

Parameter

Type

Description

id

String

Domain name ID

hostname

String

Protected domain names

protocol

String

Client protocol, which is the protocol used by a client (for example, a browser) to access your website.

Enumeration values:

  • HTTPS

  • HTTP

  • HTTP&HTTPS

server

Array of PremiumWafServer objects

Origin server configuration of the protected domain name

proxy

Boolean

Whether to use a proxy

  • true: A proxy is used.

  • false: No proxy is used.

locked

Integer

Domain name status. The value can be 0 or 1.

  • 0: The domain name is not frozen.

  • 1: The domain name is frozen. This parameter is redundant in this version.

timestamp

Long

Time the domain name was added to WAF. The value is a 13-digit timestamp in ms.

tls

String

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 available only when the client protocol is HTTPS.

Enumeration values:

  • TLS v1.0

  • TLS v1.1

  • TLS v1.2

  • TLS v1.3

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.

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

protect_status

Integer

WAF status of the protected domain name.

  • -1: The WAF protection is bypassed. Requests of the domain name are directly sent to the backend server and do not pass through WAF.

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

block_page

BlockPage object

Alarm page configuration

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

Table 11 BlockPage

Parameter

Type

Description

template

String

Template name

custom_page

CustomPage object

Custom alarm page

redirect_url

String

URL of the redirected page

Table 12 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.

Status code: 400

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 401

Table 14 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 15 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Requests

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

{
  "hostname" : "www.demo.com",
  "server" : [ {
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP",
    "vpc_id" : "cf6dbace-b36a-4d51-ae04-52a3319ae247",
    "type" : "ipv4",
    "address" : "x.x.x.x",
    "port" : 80
  } ],
  "proxy" : false,
  "description" : ""
}

Example Responses

Status code: 200

OK

{
  "id" : "51a5649e52d341a9bb802044950969dc",
  "hostname" : "www.demo.com",
  "protocol" : "HTTP",
  "server" : [ {
    "address" : "x.x.x.x",
    "port" : 80,
    "type" : "ipv4",
    "weight" : 1,
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP",
    "vpc_id" : "cf6dbace-b36a-4d51-ae04-52a3319ae247"
  } ],
  "proxy" : false,
  "locked" : 0,
  "timestamp" : 1650596007113,
  "flag" : {
    "pci_3ds" : "false",
    "pci_dss" : "false"
  },
  "description" : "",
  "policyid" : "1607df035bc847b582ce9c838c083b88",
  "domainid" : "d4ecb00b031941ce9171b7bc3386883f",
  "enterprise_project_id" : "0",
  "protect_status" : 1,
  "access_status" : 0
}

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.