Configuring User-defined Domain Name Resolution for a Load Balancer
Function
This API is used to configure user-defined domain name resolution for a load balancer.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
POST /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}/dns/user-defined-config
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints: N/A Range: The value can contain a maximum of 32 characters, including digits and lowercase letters. Default value: N/A |
| loadbalancer_id | Yes | String | Definition: Specifies the load balancer ID. Constraints: N/A Range: N/A Default value: N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition: Specifies the token used for IAM authentication. Constraints: N/A Range: N/A Default value: N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| loadbalancer | Yes | Definition: Specifies the request parameters for updating user-defined domain name resolution for a load balancer. Constraints: N/A Range: N/A Default value: N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| loadbalancer | DnsConfigResponseBody object | Definition: Specifies the response parameters for configuring domain name resolution for a load balancer. |
| request_id | String | Definition: Specifies the request ID. Range: The value is automatically generated, and can contain characters including digits, lowercase letters, and hyphens (-). |
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition: Specifies ID of the user-defined domain name resolution for a load balancer. |
| vip_address | String | Definition: Specifies the virtual IPv4 address of the load balancer. |
| ipv6_vip_address | String | Definition: Specifies the IPv6 address of the load balancer. Constraints: |
| eips | Array of EipInfo objects | Definition: Specifies the EIPs bound to the load balancer. NOTE: This parameter has the same meaning as publicips. |
| global_eips | Array of GlobalEipInfo objects | Definition: Specifies the global EIPs bound to the load balancer. |
| public_domain_name_enable | Boolean | Definition: Specifies whether to enable public domain name resolution. Range: |
| public_dns_zone_name | String | Definition: Specifies the public zone that will be used to generate public domain names for the load balancer. Constraints: |
| public_domain_name | String | Definition: Specifies the public domain names of the load balancer. Constraints: The public domain names are generated in the following format: {lb_id}.elb.{region_id}.{zone_name} |
| public_dns_record_set_ttl | Integer | Definition: Specifies the cache duration of the public record set on a local DNS server. The longer the duration is, the slower the update takes effect. If your service address changes frequently, set TTL to a smaller value. Otherwise, set TTL to a larger value. Range: 1 to 2147483647 Default value: 300 |
| private_domain_name_enable | Boolean | Definition: Specifies whether to enable private domain resolution. Range: |
| private_dns_zone_name | String | Definition: Specifies the zone that will be used to generate private domain names for the load balancer. Constraints: |
| private_domain_name | String | Definition: Specifies the private domain names of the load balancer. Constraints: The private domain names are generated in the following format: {lb_id}-internal.elb.{region_id}.{zone_name} |
| private_dns_zone_type | String | Definition: Specifies the type of the zone that will be used to generate private domain names for the load balancer. Constraints: N/A Range: private or public Default value: private |
| private_dns_record_set_ttl | Integer | Definition: Specifies the cache duration of the private record set on a local DNS server. The longer the duration is, the slower the update takes effect. If your service address changes frequently, set TTL to a smaller value. Otherwise, set TTL to a larger value. Range: 1 to 2147483647 Default value: 300 |
| Parameter | Type | Description |
|---|---|---|
| eip_id | String | Definition: Specifies the EIP ID. Range: N/A |
| eip_address | String | Definition: Specifies the EIP. Range: N/A |
| ip_version | Integer | Definition: Specifies the IP address version. Range: |
Example Requests
Configuring user-defined domain name resolution for a load balancer
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
}
} Example Responses
Status code: 200
Successful request.
{
"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
}
} SDK Sample Code
The SDK sample code is as follows.
Configuring user-defined domain name resolution for a load balancer
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.elb.v3.region.ElbRegion; import com.huaweicloud.sdk.elb.v3.*; import com.huaweicloud.sdk.elb.v3.model.*; public class UpdateUserDefinedDomainConfigSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); ElbClient client = ElbClient.newBuilder() .withCredential(auth) .withRegion(ElbRegion.valueOf("<YOUR REGION>")) .build(); UpdateUserDefinedDomainConfigRequest request = new UpdateUserDefinedDomainConfigRequest(); request.withLoadbalancerId("{loadbalancer_id}"); UpdateUserDefinedDomainConfigRequestBody body = new UpdateUserDefinedDomainConfigRequestBody(); UserDefinedDnsConfigRequestBody loadbalancerbody = new UserDefinedDnsConfigRequestBody(); loadbalancerbody.withPublicDomainNameEnable(true) .withPublicDnsZoneName("www.example.com.") .withPublicDnsRecordSetTtl(301) .withPrivateDomainNameEnable(true) .withPrivateDnsZoneName("elb-test.") .withPrivateDnsZoneType("private") .withPrivateDnsRecordSetTtl(302); body.withLoadbalancer(loadbalancerbody); request.withBody(body); try { UpdateUserDefinedDomainConfigResponse response = client.updateUserDefinedDomainConfig(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Configuring user-defined domain name resolution for a load balancer
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkelb.v3.region.elb_region import ElbRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkelb.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = ElbClient.new_builder() \ .with_credentials(credentials) \ .with_region(ElbRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateUserDefinedDomainConfigRequest() request.loadbalancer_id = "{loadbalancer_id}" loadbalancerbody = UserDefinedDnsConfigRequestBody( public_domain_name_enable=True, public_dns_zone_name="www.example.com.", public_dns_record_set_ttl=301, private_domain_name_enable=True, private_dns_zone_name="elb-test.", private_dns_zone_type="private", private_dns_record_set_ttl=302 ) request.body = UpdateUserDefinedDomainConfigRequestBody( loadbalancer=loadbalancerbody ) response = client.update_user_defined_domain_config(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Configuring user-defined domain name resolution for a load balancer
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := elb.ElbClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := elb.NewElbClient(hcClient) request := &model.UpdateUserDefinedDomainConfigRequest{} request.LoadbalancerId = "{loadbalancer_id}" publicDomainNameEnableLoadbalancer:= true publicDnsZoneNameLoadbalancer:= "www.example.com." publicDnsRecordSetTtlLoadbalancer:= int32(301) privateDomainNameEnableLoadbalancer:= true privateDnsZoneNameLoadbalancer:= "elb-test." privateDnsZoneTypeLoadbalancer:= "private" privateDnsRecordSetTtlLoadbalancer:= int32(302) loadbalancerbody := &model.UserDefinedDnsConfigRequestBody{ PublicDomainNameEnable: &publicDomainNameEnableLoadbalancer, PublicDnsZoneName: &publicDnsZoneNameLoadbalancer, PublicDnsRecordSetTtl: &publicDnsRecordSetTtlLoadbalancer, PrivateDomainNameEnable: &privateDomainNameEnableLoadbalancer, PrivateDnsZoneName: &privateDnsZoneNameLoadbalancer, PrivateDnsZoneType: &privateDnsZoneTypeLoadbalancer, PrivateDnsRecordSetTtl: &privateDnsRecordSetTtlLoadbalancer, } request.Body = &model.UpdateUserDefinedDomainConfigRequestBody{ Loadbalancer: loadbalancerbody, } response, err := client.UpdateUserDefinedDomainConfig(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | Successful request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot