文档首页/ 弹性负载均衡 ELB/ API参考/ API(V3)/ 负载均衡器/ 自定义配置负载均衡器域名解析 - UpdateUserDefinedDomainConfig
更新时间:2026-04-07 GMT+08:00
分享

自定义配置负载均衡器域名解析 - UpdateUserDefinedDomainConfig

功能介绍

自定义配置负载均衡器域名解析。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}/dns/user-defined-config

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:项目ID。获取方式请参见获取项目ID

约束限制:不涉及

取值范围:长度为32个字符,由小写字母和数字组成。

默认取值:不涉及

loadbalancer_id

String

参数解释:负载均衡器ID。

约束限制:不涉及

取值范围:不涉及

默认取值:不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:IAM鉴权Token。

约束限制:不涉及

取值范围:不涉及

默认取值:不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

loadbalancer

UserDefinedDnsConfigRequestBody object

参数解释:自定义负载均衡器域名解析的配置参数。

约束限制:不涉及

取值范围:不涉及

默认取值:不涉及

表4 UserDefinedDnsConfigRequestBody

参数

是否必选

参数类型

描述

public_domain_name_enable

Boolean

参数解释:是否启用公网域名解析。

约束限制:不涉及

取值范围

  • true:开启公网域名解析。

  • false:关闭公网域名解析。

默认取值:false

public_dns_zone_name

String

参数解释:公网域名解析所使用的根域名。

约束限制

  • 公网域名解析只能选择公网类型的根域名。

  • 若启用公网域名解析(public_domain_name_enable=true),则公网根域名不能为空,且必须在云解析服务已注册。

取值范围:不涉及

默认取值:不涉及

public_dns_record_set_ttl

Integer

参数解释:公网域名解析记录在本地DNS服务器的缓存超时时间,单位:秒。域名解析信息更新后,需要等待DNS服务器上的缓存超时才会生效。如果您的域名解析信息经常变更,建议TTL值设置相对小些,反之建议设置相对大些。

约束限制:不涉及

取值范围:1-2147483647

默认取值:300

private_domain_name_enable

Boolean

参数解释:是否启用私网域名解析。

约束限制:不涉及

取值范围

true:开启私网域名

false:关闭私网域名

默认取值:false

private_dns_zone_name

String

参数解释:私网域名解析所使用的根域名。

约束限制

  • 私网域名解析可以选择私网类型的根域名,也可以选择公网类型的根域名。需要在private_dns_zone_type字段中明确指定。

  • 若启用私网域名解析(private_domain_name_enable=true),则私网根域名不能为空,且必须在云解析服务已注册。

取值范围:不涉及

默认取值:不涉及

private_dns_zone_type

String

参数解释:私网域名解析所使用的根域名的类型。

约束限制:不涉及

取值范围

  • private: 私网根域名。

  • public: 公网根域名。

默认取值:private

private_dns_record_set_ttl

Integer

参数解释:私网域名解析记录在本地DNS服务器的缓存超时时间,单位:秒。域名解析信息更新后,需要等待DNS服务器上的缓存超时才会生效。如果您的域名解析信息经常变更,建议TTL值设置相对小些,反之建议设置相对大些。

约束限制:不涉及

取值范围:1-2147483647

默认取值:300

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

loadbalancer

DnsConfigResponseBody object

参数解释:负载均衡器域名解析配置。

request_id

String

参数解释:请求ID。

取值范围:由数字、小写字母和中划线(-)组成的字符串,自动生成。

表6 DnsConfigResponseBody

参数

参数类型

描述

id

String

参数解释:自定义域名解析配置ID。

vip_address

String

参数解释:负载均衡器的IPv4虚拟IP地址。

ipv6_vip_address

String

参数解释:双栈类型负载均衡器的IPv6地址。

约束限制

eips

Array of EipInfo objects

参数解释:负载均衡器绑定的EIP。

注:该字段与publicips一致。

global_eips

Array of GlobalEipInfo objects

参数解释:负载均衡器绑定的GEIP。

public_domain_name_enable

Boolean

参数解释:是否配置公网域名。

取值范围

true:开启公网域名

false:关闭公网域名

public_dns_zone_name

String

参数解释:公网域名所使用的zone名称。

约束限制

公网域名只能使用公网类型的zone。

当配置公网域名开关打开时,该字段不能置空。

所填的公网zone必须在云解析服务已注册过。

public_domain_name

String

参数解释

负载均衡实例的公网域名。

约束限制

根据负载均衡实例id,局点id和zone信息以如下格式生成:

{lb_id}.elb.{region_id}.{zone_name}

public_dns_record_set_ttl

Integer

参数解释:

公网解析记录集超时时间。

解析记录在本地DNS服务器的缓存时间,缓存时间越长更新生效越慢,以秒为单位。

如果您的服务地址经常更换,建议TTL值设置相对小些,反之,建议设置相对大些。

取值范围

1-2147483647

默认取值

300

private_domain_name_enable

Boolean

参数解释

是否配置私网域名。

取值范围

true:开启私网域名

false:关闭私网域名

private_dns_zone_name

String

参数解释

私网域名所使用的zone的名称。

约束限制

私网域名既能使用公网zone,也能使用私网zone,zone的类型在private_dns_zone_type字段中指定。

当配置私网域名开关打开时,该字段不能置空。

所填的私网zone必须在云解析服务已注册过。

private_domain_name

String

参数解释:负载均衡实例的私网域名。

约束限制

根据负载均衡实例id,局点id和zone信息以如下格式生成:

{lb_id}-internal.elb.{region_id}.{zone_name}

private_dns_zone_type

String

参数解释:私网域名所使用的zone的类型。

约束限制:不涉及

取值范围:private public

默认取值:private

private_dns_record_set_ttl

Integer

参数解释

私网解析记录集超时时间。

解析记录在本地DNS服务器的缓存时间,缓存时间越长更新生效越慢,以秒为单位。

如果您的服务地址经常更换,建议TTL值设置相对小些,反之,建议设置相对大些。

取值范围

1-2147483647

默认取值

300

表7 EipInfo

参数

参数类型

描述

eip_id

String

参数解释:弹性IP的ID。

取值范围:不涉及

eip_address

String

参数解释:弹性IP的IP地址。

取值范围:不涉及

ip_version

Integer

参数解释:IP版本号。

取值范围

  • 4:表示IPv4地址。

  • 6:表示IPv6地址。

表8 GlobalEipInfo

参数

参数类型

描述

global_eip_id

String

参数解释:global eip的ID。

取值范围:不涉及

global_eip_address

String

参数解释:global eip的ip地址。

取值范围:不涉及

ip_version

Integer

参数解释:IP版本信息。

取值范围

  • 4,表示IPv4

  • 6,表示IPv6

请求示例

自定义配置负载均衡器域名解析

POST https://{ELB_Endpoint}/v3/{project_id}/elb/loadbalancers/{loadbalancer_id}/dns/user-defined-config

{
  "loadbalancer" : {
    "private_dns_record_set_ttl" : "302",
    "private_dns_zone_name" : "elb-test.",
    "private_dns_zone_type" : "private",
    "private_domain_name_enable" : true,
    "public_dns_record_set_ttl" : "301",
    "public_dns_zone_name" : "www.example.com.",
    "public_domain_name_enable" : true
  }
}

响应示例

状态码:200

操作正常返回。

{
  "request_id" : "2939b3e68e917cd11af436c6dfe3194d",
  "loadbalancer" : {
    "id" : "737b61b6-ff56-4112-a14a-c7abaa4e58bf",
    "vip_address" : "192.168.0.166",
    "ipv6_vip_address" : null,
    "global_eips" : [ ],
    "eips" : [ {
      "eip_id" : "0e2749aa-15ca-4826-91e8-d944086b452f",
      "eip_address" : "10.83.50.35",
      "ip_version" : 4
    } ],
    "public_dns_zone_name" : "www.example.com.",
    "public_domain_name_enable" : true,
    "public_domain_name" : "737b61b6-ff56-4112-a14a-c7abaa4e58bf.elb.cn-southwest-242.www.example.com",
    "public_dns_record_set_ttl" : 301,
    "private_dns_zone_name" : "elb-lzs-test.",
    "private_dns_zone_type" : "private",
    "private_domain_name_enable" : true,
    "private_domain_name" : "737b61b6-ff56-4112-a14a-c7abaa4e58bf-internal.elb.elb-test",
    "private_dns_record_set_ttl" : 302
  }
}

状态码

状态码

描述

200

操作正常返回。

错误码

请参见错误码

相关文档