Adding a Protected Domain Name

Function

This API is used to add a domain name to WAF.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Content type. Default value: application/json;charset=utf8

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 3 Request body parameters

Parameter

Mandatory

Type

Description

certificateid

No

String

HTTPS certificate ID. It can be obtained by calling the ListCertificates API. This parameter is not required when the client protocol is HTTP, but it is mandatory when the client protocol is HTTPS.

certificatename

No

String

Certificate name. Certifacteid and certificatename are required at the same. If certificateid does not match certificatename, an error is reported. This parameter is not required when the client protocol is HTTP, but it is mandatory when the client protocol is HTTPS.

hostname

Yes

String

Protected domain name or IP address (port allowed)

proxy

No

Boolean

Whether a proxy is used for the domain name. If your website has no layer-7 proxy server such as CDN and cloud acceleration service deployed in front of WAF and uses only layer-4 load balancers (or NAT), set Proxy Configured to No. Otherwise, Proxy Configured must be set to Yes. This ensures that WAF obtains real IP addresses of website visitors and takes protective actions configured in protection policies.

policyid

No

String

ID of the policy initially used to the domain name. It can be obtained by calling the API Querying Protection Policies.

server

No

Array of PremiumWafServer objects

Server configuration in dedicated mode.

web_tag

No

String

website name

description

No

String

website remarks

Table 4 PremiumWafServer

Parameter

Mandatory

Type

Description

front_protocol

Yes

String

Client protocol

Enumeration values:

  • HTTP

  • HTTPS

back_protocol

Yes

String

Server protocol

Enumeration values:

  • HTTP

  • HTTPS

address

Yes

String

IP address or domain name of the origin server that the client accesses.

port

Yes

Integer

Server port

type

Yes

String

The origin server address is an IPv4 or IPv6 address. Default value: ipv4

Enumeration values:

  • ipv4

  • ipv6

vpc_id

Yes

String

VPC ID. Perform the following steps to obtain the VPC ID:

  • 1.Find the name of the VPC where the dedicated engine is located. The VPC name is in the VPC\Subnet column. Log in to the WAF console and choose Instance Management > Dedicated Engine > VPC\Subnet.

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

weight

No

Integer

This parameter is reserved and can be ignored currently.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

id

String

Protected domain name ID

policyid

String

Policy ID

hostname

String

Protected domain name

domainid

String

Tenant ID

projectid

String

Project ID

protocol

String

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

Enumeration values:

  • HTTPS

  • HTTP

protect_status

Integer

WAF status of the protected domain name.

  • 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. -1: Enabled. WAF detects attacks based on the configured policy.

access_status

Integer

Whether a domain name is connected to WAF.

  • 0: disconnected

  • 1: connected

proxy

Boolean

Whether a proxy is used.

  • true: The proxy is enabled.

  • false: The proxy is disabled.

server

Array of PremiumWafServer objects

Origin server list

flag

Flag object

Feature switch for configuring compliance certification checks for domain names protected with the dedicated WAF instance.

block_page

BlockPage object

Alarm configuration page

extend

Extend object

This parameter includes some extended information about the protected domain name.

web_tag

String

website name

description

String

website remarks

locked

Integer

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

Default: 0

timestamp

Long

Creation time.

Table 6 PremiumWafServer

Parameter

Type

Description

front_protocol

String

Client protocol

Enumeration values:

  • HTTP

  • HTTPS

back_protocol

String

Server protocol

Enumeration values:

  • HTTP

  • HTTPS

address

String

IP address or domain name of the origin server that the client accesses.

port

Integer

Server port

type

String

The origin server address is an IPv4 or IPv6 address. Default value: ipv4

Enumeration values:

  • ipv4

  • ipv6

vpc_id

String

VPC ID. Perform the following steps to obtain the VPC ID:

  • 1.Find the name of the VPC where the dedicated engine is located. The VPC name is in the VPC\Subnet column. Log in to the WAF console and choose Instance Management > Dedicated Engine > VPC\Subnet.

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

weight

Integer

This parameter is reserved and can be ignored currently.

Table 7 Flag

Parameter

Type

Description

pci_3ds

String

Whether to enable PCI 3DS compliance check. This parameter must be used together with tls and cipher. tls must be set to TLS v1.2, and cipher must be set to cipher_2. Note: If PCI 3DS compliance check is enabled and the minimum TLS is set to TLS v1.2, the website can be accessed using TLS v1.2, but cannot be accessed using TLS v1.1 or earlier. Once PCI 3DS is enabled, it cannot be disabled. Before you enable it, ensure that your website services will not be affected. You can ignore it.

  • true: Enable this check.

  • false: Disable this check.

Enumeration values:

  • true

  • false

pci_dss

String

Whether to enable PCI DSS compliance check. This parameter must be used together with tls and cipher. tls must be set to TLS v1.2, and cipher must be set to cipher_2. Note: If PCI DSS compliance check is enabled and the minimum TLS is set to TLS v1.2, the website can be accessed using TLS v1.2, but cannot be accessed using TLS v1.1 or earlier. Before you enable it, ensure that your website services will not be affected. You can ignore it.

  • true: Enable this check.

  • false: Disable this check.

Enumeration values:

  • true

  • false

Table 8 BlockPage

Parameter

Type

Description

template

String

Template type, the value can be:

  • default: The default block page.

  • custom: Your custom block page is returned when a request is blocked. The request is redirected to the URL you specify.

custom_page

CustomPage object

Custom alarm page.

redirect_url

String

Redirect URL. The root domain name of the redirection address must be the name of the currently protected domain (including a wildcard domain name).${http_host} can be used to indicate the currently protected domain name and port, for example, ${http_host}/error.html.

Table 9 CustomPage

Parameter

Type

Description

status_code

String

Status Codes

content_type

String

Content type of alarm page.

content

String

Page content.

Table 10 Extend

Parameter

Type

Description

ltsInfo

String

Details about LTS configuration

extend

String

Timeout configuration details.

Status code: 400

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 401

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 13 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?

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

Example Responses

Status code: 200

Request succeeded.

{
  "id" : "51a5649e52d341a9bb802044950969dc",
  "policyid" : "1607df035bc847b582ce9c838c083b88",
  "hostname" : "www.demo.com",
  "protocol" : "HTTP",
  "server" : [ {
    "address" : "1.1.1.1",
    "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" : "",
  "projectid" : "550500b49078408682d0d4f7d923f3e1",
  "domainid" : "d4ecb00b031941ce9171b7bc3386883f",
  "protect_status" : 1,
  "access_status" : 0,
  "extend" : { },
  "block_page" : {
    "template" : "default"
  }
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Request failed.

401

The token does not have the required permission.

500

Internal server error.

Error Codes

See Error Codes.

last updated: 2024-09-09 09:53 UTC - commit: 0dd8692423ca7a0fd922b672f45ba4c8930aad67