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

文档中心

导航

TrafficRoute DNS 套件

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

最近更新时间：2024.11.20 11:13:11首次发布时间：2023.02.08 13:13:25

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

注意

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

请求说明

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

请求参数

除了以下参数，您还需要对请求进行鉴权。

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`UpdateRecordSet`	API 的名称。该参数的取值是 `UpdateRecordSet`。
Version	String	是	`2022-06-01`	API 的版本。该参数的取值是 `2022-06-01`。

Body

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

返回参数

ResponseMetadata 对象

名称	类型	描述
RequestId	String	标识本次请求的 ID。
Action	String	Action 查询参数的值。
Version	String	API 版本。
Service	String	服务类型。
Region	String	服务所在地域。

Result 对象

名称	类型	描述
ID	String	解析记录集 ID。
FQDN	String	解析记录的完整域名，以 FQDN 格式显示。
Host	String	主机记录（域名前缀）。
Type	String	解析记录类型。
Line	Integer	智能解析开启时，解析记录对应的 VPC 子网。
WeightEnabled	Boolean	该解析记录是否开启了负载均衡。 true：开启了负载均衡。 false：关闭了负载均衡。

示例

请求示例

POST https://open.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.internal003.com",
        "Host": "www",
        "Type": "A",
        "Line": "default;0.0.0.0/0",
        "WeightEnabled": true
    }
}

错误码

您可访问公共错误码，获取详细信息。