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

文档中心

立即注册

导航

TrafficRoute DNS 套件

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

最近更新时间：2025.05.22 20:07:03首次发布时间：2023.02.08 13:13:25

启用或禁用一个记录集的负载均衡。

使用说明

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

注意事项

在调用该 API 之前，您必须确保在调用 CreatePrivateZone API 创建域名时开启了负载均衡功能。如果您的域名没有开启负载均衡功能，您可以调用 UpdatePrivateZone API 更新负载均衡配置。否则，API 会返回 ErrWeightDisabled 错误。

请求说明

请求方式：POST
请求地址：https://private-zone.volcengineapi.com/?Action=UpdateRecordSet?Version=2022-06-01

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateRecordSet	要执行的操作，取值：UpdateRecordSet。
Version	String	是	2022-06-01	API的版本，取值：2022-06-01。
RecordSetID	String	是	OTA3OTI1Njg0ODc3ODkyMTA3M3x3d3cuaW50ZXJuYWwwMDMuY29tLnxBfGRlZmF1bHQ7MC4wLjAuMC8w	解析记录集 ID。您可以通过 ListRecordSets API 获取。
WeightEnabled	Boolean	是	true	是否开启负载均衡。 true：开启负载均衡。 false：关闭负载均衡。
ZID	Long	否	1234	域名 ID。您可以通过以下 API 获取： CreatePrivateZone API ListPrivateZones API 如果您需要验证子用户是否对域名所在的项目有操作权限，您需要传入该参数。

返回参数

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

参数	类型	示例值	描述
ID	String	OTA3OTI1Njg0ODc3ODkyMTA3M3x3d3cuaW50ZXJuYWwwMDMuY29tLnxBfGRlZmF1bHQ7MC4wLjAuMC8w	记录集 ID。
FQDN	String	www.example.com	解析记录的完整域名，以 FQDN 格式显示。
Host	String	www	主机记录（域名前缀）。
Type	String	A	解析记录类型。
Line	String	vpc-1234567	智能解析开启时，解析记录对应的 VPC 子网。`default;0.0.0.0/0` 表示默认线路。
WeightEnabled	Boolean	true	该解析记录是否开启了负载均衡。 true：开启了负载均衡。 false：关闭了负载均衡。

请求示例

POST https://private-zone.volcengineapi.com/?Action=UpdateRecordSet&Version=2022-06-01

{
    "RecordSetID": "OTA3OTI1Njg0ODc3ODkyMTA3M3x3d3cuaW50ZXJuYWwwMDMuY29tLnxBfGRlZmF1bHQ7MC4wLjAuMC8w",
    "WeightEnabled": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221228190253EC1BBB7CEA00101F5152",
        "Action": "UpdateRecordSet",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn"
    },
    "Result": {
        "ID": "OTA3OTI1Njg0ODc3ODkyMTA3M3x3d3cuaW50ZXJuYWwwMDMuY29tLnxBfGRlZmF1bHQ7MC4wLjAuMC8w",
        "FQDN": "www.example.com",
        "Host": "www",
        "Type": "A",
        "Line": "default;0.0.0.0/0",
        "WeightEnabled": true
    }
}

错误码

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

状态码	错误码	错误信息	说明
400	ErrParamInvalid	validation fail: params:[%s] , value:[%v]	参数校验失败
500	ErrInternalServer	server internal error	服务内部错误