Querying a Domain Name¶
Function Description¶
This API is used to query details about a domain name.
URI¶
URI format
GET /v1/{project_id}/waf/instance/{instance_id}
Parameter description
¶ Parameter
Mandatory
Type
Description
project_id
Yes
String
Specifies the project ID.
instance_id
Yes
String
Specifies the instance ID.
Request¶
Request parameters
None
Response¶
Response parameters
Parameter | Type | Description |
---|---|---|
id | String | Specifies the instance ID. |
hostname | String | Specifies the domain name. |
cname | String | Specifies the CNAME value. For example, efec1196267b41c399f2980ea4048517.waf.cloud.com. |
txt_code | String | Specifies the TXT record. This parameter is returned only when proxy is set to true. |
sub_domain | String | Specifies the subdomain name. This parameter is returned only when proxy is set to true. |
policy_id | String | Specifies the policy ID. |
protect_status | Integer | Specifies the WAF mode.
|
access_status | Integer | Specifies whether a domain name is connected to WAF.
|
protocol | String | Specifies the protocol type. The options are HTTP, HTTPS, and HTTP,HTTPS. |
certificate_id | String | Specifies the certificate ID. This parameter is returned only when client_protocol is set to HTTPS. |
server | Array | Specifies the origin server information, including the client_protocol, server_protocol, address, and port fields.
|
proxy | Boolean | Specifies whether a proxy is configured.
|
sip_header_name | String | Specifies the type of the source IP header. This parameter is returned only when proxy is set to true. The options are as follows: default, cloudflare, akamai, and custom. |
sip_header_list | Array | Specifies the HTTP request header for identifying the real source IP address. This parameter is returned only when proxy is set to true.
|
timestamp | Long | Specifies the time when a domain name is created. |
block_page | BlockPage object | Alarm page configuration |
tls | String | Specifies the minimum TLS version for accessing the protected domain name. This parameter is returned only when client_protocol is set to HTTPS.
|
cipher | String | Specifies the cipher suite supported by the protected domain name. This parameter is returned only when client_protocol is set to HTTPS.
|
Parameter | Type | Description |
---|---|---|
template | String | Template name |
custom_page | CustomPage object | Custom alarm page |
redirect_url | String | URL |
Parameter | Type | Description |
---|---|---|
status_code | String | Status code |
content_type | String | The content type of the custom alarm page. The value can be text/html, text/xml, or application/json. |
content | String | Configure the page content based on the value for content_type. |
Example¶
www.a.com is used as an example.
Response example
{
"id": "388a7789d55b41d1918b3088a8f1e7f3",
"hostname": "www.a.com",
"cname": "3249d21e5eb34d21be12fdc817fcb67d.waf.cloud.com",
"txt_code": "3249d21e5eb34d21be12fdc817fcb67d",
"sub_domain": "3249d21e5eb34d21be12fdc817fcb67d.www.a.com",
"policy_id": "xxxxxxxxxxxxxx",
"certificate_id": "xxxxxxxxxxxxxxxxxxx",
"protect_status": 0,
"access_status": 0,
"protocol": "HTTP,HTTPS",
"server": [
{"client_protocol": "HTTPS", "server_protocol":"HTTP", "address":"X.X.X.X.", "port":443},
{"client_protocol": "HTTP", "server_protocol":"HTTP", "address":"X.X.X.X", "port":80}
],
"proxy": true,
"sip_header_name": "default",
"sip_header_list": ["X-Forwarded-For"],
"timestamp": 1499817600,
"block_page" : {
"template" : "default"
},
"cipher": "cipher_1",
"tls": "TLS v1.1"
}
Status Code¶
Table 5 describes the normal status code returned by the API.
Status Code | Description | Meaning |
---|---|---|
200 | OK | The request has succeeded. |
For details about error status codes, see Status Codes.