配置负载均衡器系统默认域名化 - UpdateSystemDefaultDomainConfig
功能介绍
配置负载均衡器系统默认域名化。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
POST /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}/dns/system-default-config
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释：项目ID。获取方式请参见获取项目ID。 约束限制：不涉及 取值范围：长度为32个字符，由小写字母和数字组成。 默认取值：不涉及 |
|
loadbalancer_id |
是 |
String |
负载均衡器ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释：IAM鉴权Token。 约束限制：不涉及 取值范围：不涉及 默认取值：不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
loadbalancer |
是 |
参数解释：配置负载均衡器系统默认域名化相关配置参数。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
public_dns_record_set_ttl |
否 |
Integer |
参数解释：公网解析记录集超时时间。解析记录在本地DNS服务器的缓存时间，缓存时间越长更新生效越慢，以秒为单位。如果您的服务地址经常更换，建议TTL值设置相对小些，反之，建议设置相对大些 约束限制：不涉及 取值范围：1-2147483647 默认取值：300 |
|
private_domain_name_enable |
否 |
Boolean |
参数解释：是否配置私网域名。 约束限制：不涉及 取值范围： true：开启私网域名 false：关闭私网域名 默认取值：false |
|
public_domain_name_enable |
否 |
Boolean |
参数解释：是否配置公网域名。 约束限制：不涉及 取值范围： true：开启公网域名 false：关闭公网域名 默认取值：false |
|
private_dns_record_set_ttl |
否 |
Integer |
参数解释：私网解析记录集超时时间。解析记录在本地DNS服务器的缓存时间，缓存时间越长更新生效越慢，以秒为单位。如果您的服务地址经常更换，建议TTL值设置相对小些，反之，建议设置相对大些。 约束限制：不涉及 取值范围：1-2147483647 默认取值：300 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
loadbalancer |
DnsConfigResponseBody object |
参数解释：配置负载均衡器响应体相关配置参数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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_dns_zone_id |
String |
参数解释： 公网域名所使用的zone对应的id。 根据传入的公网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_dns_zone_id |
String |
参数解释： 私网域名所使用的zone对应的id。 约束限制： 根据传入的私网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 |
请求示例
配置负载均衡器系统默认域名化
POST https://{ELB_Endpoint}/v3/{project_id}/elb/loadbalancers/{loadbalancer_id}/dns/system-default-config
{
"loadbalancer" : {
"public_domain_name_enable" : true,
"public_dns_record_set_ttl" : 233333,
"private_domain_name_enable" : true,
"private_dns_record_set_ttl" : 9999999
}
}
响应示例
状态码：200
操作正常返回。
{
"loadbalancer" : [ {
"vip_address" : "192.168.20.87"
}, {
"ipv6_vip_address" : "2001:db8:a583:682::10"
}, {
"eips" : null,
"eip_id" : "26000000-0000-0000-0000-000000000001",
"eip_address" : "10.185.106.199",
"ip_version" : 4
}, {
"global_eips" : null,
"global_eip_id" : "26000000-0000-0000-0000-000000000001",
"global_eip_address" : "2001:db8:a583:682::11",
"ip_version" : 6
}, {
"private_domain_name_enable" : true
}, {
"private_dns_zone_id" : "8a186e6692d7f30d0192d8472fba0479"
}, {
"private_dns_zone_name" : "test.private.com"
}, {
"private_domain_name" : "10000000-0000-0000-0000-000000000001-internal.huaweicloud-elb.com"
}, {
"private_dns_record_set_ttl" : 3500
}, {
"public_domain_name_enable" : true
}, {
"public_dns_zone_id" : "9a186e6692d7f30d0192d8472fba0479"
}, {
"public_dns_zone_name" : "test.public.com"
}, {
"public_domain_name" : "10000000-0000-0000-0000-000000000001.elb.huaweicloud-elb.com"
}, {
"public_dns_record_set_ttl" : 300
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
操作正常返回。 |
错误码
请参见错误码。
