• Web Application Firewall

waf
  1. Help Center
  2. Web Application Firewall
  3. API Reference
  4. APIs
  5. Domain Names
  6. Querying a Domain Name

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
    Table 1 Path parameters

    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
Table 2 Parameter description

Parameter

Type

Description

id

String

Specifies the instance ID.

hostname

String

Specifies the domain name.

access_code

String

Specifies the access code.

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.

policyid

String

Specifies the policy ID.

protect_status

Integer

Specifies the WAF mode.

  • 0: disabled.
  • 1: enabled.
  • -1: bypassed.

access_status

Integer

Specifies whether a domain name is connected to WAF.

  • 0: The domain name is not connected to WAF.
  • 1: The domain name is connected to WAF.

protocol

String

Specifies the protocol type. The options are HTTP and HTTPS.

certificateid

String

Specifies the certificate ID. This parameter is returned only when front_protocol is set to HTTPS.

server

Array

Specifies the origin server information, including the front_protocol, back_protocol, address, and port fields.

  • front_protocol: Protocol type of the client. The options are HTTP and HTTPS.
  • back_protocol: Protocol used by WAF to forward client requests to the server. The options are HTTP and HTTPS.
  • address: IP address of the web server that the client accesses. For example, 192.168.1.1.
  • port: Port number used by the web server. The value ranges from 0 to 65535, for example, 8080.

proxy

Boolean

Specifies whether a proxy is configured.

  • true: A proxy is configured.
  • false: No 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.

  • If sip_header_name is default, sip_header_list is ["X-Forwarded-For"].
  • If sip_header_name is cloudflare, sip_header_list is ["CF-Connecting-IP", "X-Forwarded-For"].
  • If sip_header_name is akamai, sip_header_list is ["True-Client-IP"].
  • If sip_header_name is custom, you can customize a value.

timestamp

Long

Specifies the time when a domain name is created.

Example

www.a.com is used as an example.

Response example
{
          "id": "388a7789d55b41d1918b3088a8f1e7f3",
          "hostname": "www.a.com",
          "access_code": "3249d21e5eb34d21be12fdc817fcb67d",
          "cname": "3249d21e5eb34d21be12fdc817fcb67d.waf.cloud.com",
          "txt_code": "3249d21e5eb34d21be12fdc817fcb67d",
          "sub_domain": "3249d21e5eb34d21be12fdc817fcb67d.www.a.com",
          "policyid": "xxxxxxxxxxxxxx",
          "certificateid": "xxxxxxxxxxxxxxxxxxx",
          "protect_status": 0,
          "access_status": 0,
          "protocol": "HTTP&HTTPS",

          "server": [
             {"front_protocol": "HTTPS", "back_protocol":"HTTP", "address":"192.168.5.6.", "port":443},
             {"front_protocol": "HTTP", "back_protocol":"HTTP", "address":"192.168.5.7", "port":80}
          ],
         "proxy": true,
         "sip_header_name": "default",
         "sip_header_list": ["X-Forwarded-For"],
         "timestamp": 1499817600
}

Status Code

Table 3 describes the normal status code returned by the API.
Table 3 Status code

Status Code

Description

Meaning

200

OK

The request has succeeded.

For details about error status codes, see Status Codes.