Querying the Domain Name Resolution Information of a Load Balancer
Function
This API is used to query the domain name resolution configuration of all IP addresses of a load balancer. This includes whether the IP addresses of the load balancer are mapped to domain names and their corresponding domain names.
Note: Only the IP addresses that have domain name resolution enabled will be returned. If only public domain name resolution is enabled, only the public IP addresses and their domain names will be returned. If neither public nor private domain name resolution is enabled for the load balancer, an empty list will be returned.
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
GET /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}/dns/ips
| 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 |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| ips | Array of DnsIpResponse objects | Specifies the domain name resolution information of IP addresses bound to a load balancer. |
| page_info | PageInfo object | Definition: Specifies the pagination information. |
| 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 |
|---|---|---|
| enable | Boolean | Definition: Specifies whether domain name resolution is enabled for the IP address. Range: |
| ip_address | String | Definition: Specifies the IP address. It can be an IPv4 or IPv6 address. Constraints: The IP address must be a private or public IP address of the load balancer. |
| type | String | Definition: Specifies the IP address type. Range: |
| domain_name | String | Definition: Specifies the domain name that the IP address is mapped to. Constraints: |
| created_at | String | Definition: Specifies the creation time. Range: N/A |
| updated_at | String | Definition: Specifies the update time. Range: N/A |
| Parameter | Type | Description |
|---|---|---|
| previous_marker | String | Definition: Specifies the ID of the first record in the pagination query result. If page_reverse is set to true, this parameter is used together to query resources on the previous page. Range: N/A |
| next_marker | String | Definition: Specifies the ID of the last record in the pagination query result. It is usually used to query resources on the next page. Range: N/A |
| current_count | Integer | Definition: Specifies the number of records returned on the current page. Range: N/A |
Example Requests
Querying the domain name resolution information of a load balancer
GET https://{ELB_Endpoint}/v3/{project_id}/elb/loadbalancers/38278031-cfca-44be-81be-a412f618773b/dns/ips Example Responses
Status code: 200
Successful request.
{
"request_id" : "888189c3-06b0-4e37-bba9-9063e18a420e",
"ips" : [ {
"enable" : true,
"type" : "eip",
"created_at" : "2026-01-29T06:57:26Z",
"updated_at" : "2026-01-29T06:57:26Z",
"ip_address" : "10.83.50.35",
"domain_name" : "737b61b6-ff56-4112-a14a-c7abaa4e58bf.elb.example.com"
}, {
"enable" : true,
"type" : "vip",
"created_at" : "2026-01-29T07:01:46Z",
"updated_at" : "2026-01-29T07:01:46Z",
"ip_address" : "192.168.0.166",
"domain_name" : "737b61b6-ff56-4112-a14a-c7abaa4e58bf-internal.elb.elb-test"
} ],
"page_info" : {
"previous_marker" : "7b8eec37-fd21-49ac-83d5-31e54fc052e8",
"current_count" : 2
}
} SDK Sample Code
The SDK sample code is as follows.
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 | 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 ListDomainIPsSolution { 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(); ListDomainIPsRequest request = new ListDomainIPsRequest(); request.withLoadbalancerId("{loadbalancer_id}"); try { ListDomainIPsResponse response = client.listDomainIPs(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()); } } } |
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 | # 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 = ListDomainIPsRequest() request.loadbalancer_id = "{loadbalancer_id}" response = client.list_domain_i_ps(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 | 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.ListDomainIpsRequest{} request.LoadbalancerId = "{loadbalancer_id}" response, err := client.ListDomainIPs(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