Querying the List of Domain Names Connected to Dedicated WAF Instances
Function
This API is used to query the list of domain names connected to dedicated WAF instances.
Debugging
You can use API Explorer to debug this API.
URI
GET /v1/{project_id}/premium-waf/host
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| enterprise_project_id | No | String | Enterprise project ID |
| page | No | String | Page number Default: 1 |
| pagesize | No | String | Number of records on each page. Default: 10 |
| hostname | No | String | Domain name |
| policyname | No | String | Policy Name |
| protect_status | No | Integer | Protection status of the domain name |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| 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
| Parameter | Type | Description |
|---|---|---|
| total | Integer | Number of all protected domain names |
| items | Array of SimplePremiumWafHost objects | Details about the protected domain name |
| Parameter | Type | Description |
|---|---|---|
| id | String | Domain name ID |
| hostname | String | Domain name |
| policyid | String | Policy ID |
| protect_status | Integer | Protection status |
| access_status | Integer | Access status |
| flag | Map<String,String> | Special identifier |
| mode | String | Dedicated engine identifier in special mode, for example, the ELB mode. |
| pool_ids | Array of strings | Dedicated engine group to which the domain name in special mode belongs |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code |
| error_msg | String | Error code message |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code |
| error_msg | String | Error code message |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code |
| error_msg | String | Error code message |
Example Requests
None
Example Responses
None
Status Codes
| Status Code | Description |
|---|---|
| 200 | OK |
| 400 | Invalid request |
| 401 | Unauthorized token |
| 500 | Internal server error |
Error Codes
See Error Codes.
Did this article solve your problem?
Thank you for your score!Your feedback would help us improve the website.