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

更新dns服务器列表

功能介绍

更新dns服务器列表

URI

PUT /v1/{project_id}/dns/servers

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

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的值是适用的

表4 请求Body参数

参数

是否必选

参数类型

描述

dns_server

Array of dns_server objects

DNS服务器列表

health_check_domain_name

String

健康检查域名,可通过查询dns服务器列表接口查询获得,通过返回值中的data.health_check_domain_name(.表示各对象之间层级的区分)获得。

表5 dns_server

参数

是否必选

参数类型

描述

server_ip

String

DNS服务器IP,可通过查询dns服务器列表接口查询获得,通过返回值中的data.server_ip(.表示各对象之间层级的区分)获得。

is_customized

Integer

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

is_applied

Integer

是否应用,0否 1是

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

data

Array of strings

域名服务器列表

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

更新项目id为2349ba469daf4b7daf268bb0261d18b0的dns解析器的设置,服务器ip为8.8.8.8,默认服务器,更新为使用,服务器ip为192.168.0.2,非默认服务器,更新为非使用

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

{
  "dns_server" : [ {
    "server_ip" : "8.8.8.8",
    "is_customized" : 0,
    "is_applied" : 1
  }, {
    "server_ip" : "192.168.0.2",
    "is_customized" : 1,
    "is_applied" : 0
  } ]
}

响应示例

状态码:200

更新Dns服务器响应

{
  "data" : [ "100.95.150.83", "114.114.114.114", "223.5.5.5", "223.6.6.6", "119.29.29.29", "8.8.8.8", "100.79.1.250", "100.79.1.240" ]
}

状态码:400

Bad Request

{
  "error_code" : "CFW.00109003",
  "error_msg" : "HTTP响应状态码错误"
}

状态码

状态码

描述

200

更新Dns服务器响应

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码