更新时间:2025-12-29 GMT+08:00

查询dns服务器列表

功能介绍

查询dns服务器列表

URI

GET /v1/{project_id}/dns/servers

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID, 可以从调API处获取,也可以从控制台获取。项目ID获取方式

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

每页显示个数,范围为1-1024

offset

否

Integer

偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0

fw_instance_id

否

String

防火墙id,可通过防火墙ID获取方式获取

enterprise_project_id

否

String

企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。可通过如何获取用户Token获取。

Content-Type

是

String

内容类型,只有application/json的值是适用的

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data

Array of DnsServersResponseDTO objects

dns服务器列表

total

Integer

dns服务器总数

表5 DnsServersResponseDTO

参数

参数类型

描述

id

Integer

域名服务器id

is_applied

Integer

域名服务器是否应用,0否 1是

is_customized

Integer

域名服务器是否是用户自定义的dns服务器,0否 1是

server_ip

String

DNS服务器IP

health_check_domain_name

String

健康检查域名

请求示例

获取项目id为2349ba469daf4b7daf268bb0261d18b0的dns服务器列表

https://{Endpoint}/v1/2349ba469daf4b7daf268bb0261d18b0/dns/servers?fw_instance_id=80e0f2df-24fd-49c2-8398-11f9a0299b3e

响应示例

状态码:200

获取dns服务器响应

{
  "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
}

状态码

状态码

描述

200

获取dns服务器响应

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。