Querying the DNS Server List

Function

This API is used to query the DNS server list.

URI

GET /v1/{project_id}/dns/servers

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of records displayed on each page, in the range 1-1024
offset	No	Integer	Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.
fw_instance_id	No	String	Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.
enterprise_project_id	No	String	Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
data	Array of DnsServersResponseDTO objects	dns server list
total	Integer	dns server total

**Table 5** DnsServersResponseDTO
Parameter	Type	Description
id	Integer	id
is_applied	Integer	Indicates whether to apply. 0: no; 1: yes
is_customized	Integer	Indicates whether the DNS server is user-defined. 0: no; 1: yes
server_ip	String	DNS server IP address
health_check_domain_name	String	health check domain name

Example Requests

Obtain the DNS server list of the project whose ID is 2349ba469daf4b7daf268bb0261d18b0.

https://console.xxxxxx.com/cfw/v1/2349ba469daf4b7daf268bb0261d18b0/dns/servers

Example Responses

Status code: 200

Response to the request for obtaining DNS servers

{
  "data" : {
    "data" : [ {
      "health_check_domain_name" : "sslstatic.xiaoyusan.com",
      "id" : 20165,
      "is_applied" : 0,
      "is_customized" : 1,
      "server_ip" : "0.0.0.0"
    }, {
      "health_check_domain_name" : "sslstatic.xiaoyusan.com",
      "id" : 14190,
      "is_applied" : 1,
      "is_customized" : 0,
      "server_ip" : "100.79.1.240"
    } ]
  },
  "total" : 2
}

Status Codes

Status Code	Description
200	Response to the request for obtaining DNS servers
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: Domain Parse and Domain Set Management

17 KiB Raw Blame History