You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /
  • TrafficRoute DNS 套件

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

最近更新时间：2023.10.26 21:10:58

首次发布时间：2022.11.24 20:57:30

我的收藏

API 说明

API 名称：UpdateRecordSet。
API 域名：open.volcengineapi.com。
API 描述：对指定的解析记录集启用或者禁用负载均衡。

请求方法

POST

使用限制

每秒最多调用 5 次。

请求参数

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

参数名称
数据类型
参数类型
是否必选参数说明
ActionString查询参数是API 的名称。该参数的取值是 UpdateRecordSet。
VersionString查询参数是API 的版本。该参数的取值是 2018-08-01。
IDString请求正文参数是需要启用或者禁用负载均衡的解析记录集的 ID。

WeightEnabled

Boolean

请求正文参数

是

是否启用负载均衡。如果启用了负载均衡，云解析 DNS 会根据解析记录的权重返回解析结果。
该参数有以下取值：

  • true：启用负载均衡。

  • false：禁用负载均衡。

响应正文

ResponseMetadata 对象

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

Result 对象

参数名称
数据类型参数说明
IDString解析记录集的 ID。
FQDNString（废弃）解析记录集所包含的主机名，PQDN（Partially Qualified Domain Name） 格式。例如 www.example.com。
PQDNString解析记录集所包含的主机名，PQDN（Partially Qualified Domain Name） 格式。例如 www.example.com。
HostString解析记录包含的主机记录。
TypeString解析记录集中解析记录的类型。
LineString解析记录集对应的线路代号。关于该参数的值所对应的线路名称，您可以调用 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
    }
}