Querying Domain Names Protected by Cloud WAF
Function
This API is used to query domain names protected by cloud WAF.
Debugging
You can use API Explorer to debug this API.
URI
GET /v1/{project_id}/waf/instance
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| enterprise_project_id | No | String | Enterprise project ID |
| page | No | Integer | Page number Default: 1 |
| pagesize | No | Integer | Number of records on each page Default: 10 |
| hostname | No | String | Domain name |
| policyname | No | String | Policy 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). |
| Content-Type | Yes | String | Content type Default: application/json;charset=utf8 |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| total | Integer | Number of domain names protected with the cloud WAF instance |
| items | Array of CloudWafHostResponseBody objects | Details about the protected domain name |
| Parameter | Type | Description |
|---|---|---|
| id | String | Domain name ID |
| hostname | String | Domain name connected to a cloud WAF instance |
| policyid | String | Policy ID |
| access_code | String | CNAME prefix |
| protect_status | Integer | Protection status |
| access_status | Integer | Access status |
| protocol | String | Returned client protocol type |
| certificateid | String | Certificate ID |
| certificatename | String | Certificate name |
| server | Array of CloudWafServer objects | Origin server details |
| proxy | Boolean | Whether the proxy is enabled |
| timestamp | Long | Time the domain name was connected to WAF |
| exclusive_ip | Boolean | Whether a dedicated IP address is used |
| Parameter | Type | Description |
|---|---|---|
| front_protocol | String | Client protocol |
| back_protocol | String | Server protocol |
| address | String | Server address |
| port | Integer | Server port |
| type | String | Origin server IP address format. The options are IPv 4 and IPv6. Default: ipv4 |
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 | Request failed. |
| 401 | The token does not have required permissions. |
| 500 | Internal server error. |
Error Codes
See Error Codes.
Last Article: Managing Websites Protected by Cloud WAF
Next Article: Adding a Domain Name to Cloud WAF
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.