UpdateRecordSet - 启用或禁用记录集的负载均衡--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

TrafficRoute DNS 套件

请输入

记录集管理

UpdateRecordSet - 启用或禁用记录集的负载均衡

对指定的解析记录集启用或者禁用负载均衡。

使用说明

请求频率：每秒最多调用 5 次。

请求说明

请求方式：POST
请求地址：https://dns.volcengineapi.com/?Action=UpdateRecordSet?Version=2018-08-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateRecordSet	要执行的操作，取值：UpdateRecordSet。
Version	String	是	2018-08-01	API的版本，取值：2018-08-01。
ID	String	是	MzE3MDUzNDEzNzY2OTA5ODc5OHxALnlhbWFzaXRlLnRvcC58QXxkZWZhdWx0	需要启用或者禁用负载均衡的解析记录集的 ID。
WeightEnabled	Boolean	否	true	是否启用负载均衡。如果启用了负载均衡，云解析 DNS 会根据解析记录的权重返回解析结果。该参数有以下取值： `true`：启用负载均衡。 `false`：禁用负载均衡。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
FQDN	String	@.example.com	（废弃）解析记录集所包含的主机名，PQDN（Partially Qualified Domain Name）格式。例如 www.example.com。
Host	String	@	解析记录包含的主机记录。
ID	String	MzE3MDUzNDEzNzY2OTA5ODc5OHxALnlhbWFzaXRlLnRvcC58QXxkZWZhdWx0	解析记录集的 ID。
Line	String	default	解析记录集对应的线路代号。关于该参数的值所对应的线路名称，您可以调用 ListLines API 获取。
PQDN	String	@.example.com	解析记录集所包含的主机名，PQDN（Partially Qualified Domain Name）格式。例如 www.example.com。
Type	String	A	解析记录集中解析记录的类型。
WeightEnabled	Boolean	true	解析记录集是否启用了负载均衡。如果启用了负载均衡，云解析 DNS 会根据解析记录的权重返回解析结果。该参数有以下取值： `true`：启用了负载均衡。 `false`：未启用负载均衡。

请求示例

POST /?Action=UpdateRecordSet&Version=2018-08-01 HTTP/1.1
Host: dns.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240908T113948Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240908/cn-beijing/dns/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "ID": "MzE3MDUzNDEzNzY2OTA5ODc5OHxALnlhbWFzaXRlLnRvcC58QXxkZWZhdWx0\t",
  "WeightEnabled": true
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240908193952078005243122978F21",
    "Action": "UpdateRecordSet",
    "Version": "2018-08-01",
    "Service": "dns",
    "Region": "cn-beijing"
  },
  "Result": {
    "FQDN": "@.example.com",
    "Host": "@",
    "ID": "MzE3MDUzNDEzNzY2OTA5ODc5OHxALnlhbWFzaXRlLnRvcC58QXxkZWZhdWx0",
    "Line": "default",
    "PQDN": "@.example.com",
    "Type": "A",
    "WeightEnabled": true
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ErrParsingParams	parsing params error	解析请求失败。
400	ErrParamInvalid	validation fail:%s	参数校验失败。
400	ErrDBNotFound	record not found :%s	数据库条目未找到。
400	ErrZoneNotFound	zone not found	未找到域名。
400	ErrZoneInactive	zone is inactive	域名待找回。
500	ErrInternalServer	server internal error	服务内部错误。

最近更新时间：2025.06.23 20:22:16

这个页面对您有帮助吗？

有用

无用

TrafficRoute DNS 套件

使用说明 #

请求说明 #

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #