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

文档中心

立即注册

导航

TrafficRoute DNS 套件

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

最近更新时间：2024.06.27 14:33:48首次发布时间：2022.11.24 20:57:30

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

使用说明

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

请求说明

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

请求参数

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

Query

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

Body

名称	类型	是否必选	示例值	描述
ID	String	是	`MzE3MDUzNDEzNzY2OTA5ODc5OHxALnlhbWFzaXRlLnRvcC58QXxkZWZhdWx0`	需要启用或者禁用负载均衡的解析记录集的 ID。
WeightEnabled	Boolean	是	`true`	是否启用负载均衡。如果启用了负载均衡，云解析 DNS 会根据解析记录的权重返回解析结果。该参数有以下取值： `true`：启用负载均衡。 `false`：禁用负载均衡。

返回参数

ResponseMetadata 对象

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

Result 对象

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

示例

请求示例

POST https://open.volcengineapi.com?Version=2018-08-01&Action=UpdateRecordSet
{
  "ID": "MTU0MHxpbWcubWljcm9maXNoLmxpZmUufEF8ZGVmYXVsdA==",
  "WeightEnabled": true
}

返回示例

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

错误码

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