Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Li, Qiao <qiaoli@huawei.com>
Co-committed-by: Li, Qiao <qiaoli@huawei.com>

2022-11-16 15:31:27 +00:00

12 KiB

Raw Permalink Blame History

Connecting a Domain Name to WAF

Function Description

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

URI

URI format
PUT /v1/{project_id}/waf/instance/{instance_id}/access_status
Parameter description
Table 1 Path parameters
Parameter

Mandatory

Type

Description

projecte_id

Yes

String

Specifies the project ID.

instance_id

Yes

String

Specifies the instance ID.

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
projecte_id	Yes	String	Specifies the project ID.
instance_id	Yes	String	Specifies the instance ID.

Request

Request parameters

**Table 2** Parameter description
Parameter	Mandatory	Type	Description
access_status	Yes	Integer	Specifies whether a domain name is connected to WAF. 1: The domain name is connected to WAF.

Response

Response parameters

**Table 3** Parameter description
Parameter	Mandatory	Type	Description
access_status	Yes	Integer	Specifies whether a domain name is connected to WAF. 1: The domain name is connected to WAF. 0: The domain name is not connected to WAF.
protect_status	Yes	Integer	Specifies the WAF mode of a domain name. 1: enabled. 0: disabled. -1: bypassed. That is, a client sends a request to the server without passing through WAF.

Examples

access_status with a value of 1 is used as an example.

Request example
```
{
 "access_status": 1
}
```

Response examples
The following shows the response if the domain name is connected to WAF:
```
{
  "access_status": 1,
  "protect_status": 1
}
```
The following shows the response if connection fails:
```
{
 "access_status": 0,
 "protect_status": 0
}
```

Status Code

Table 4 describes the normal status code returned by the API.

**Table 4** Status code
Status Code	Description	Meaning
200	OK	The request has succeeded.

For details about error status codes, see Status Codes.

Parent topic: Protection Status and Domain Setup

12 KiB Raw Permalink Blame History