Help Center/ Domain Name Service/ API Reference/ APIs/ Resolver Management/ Binding an IP Address to an Endpoint
Updated on 2026-09-28 GMT+08:00

Binding an IP Address to an Endpoint

Function

This API is used to bind an IP address to an endpoint.

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, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    dns:endpoint:createIpaddress

    Write

    endpoint *

    -

    -

    • vpc:subnets:get
    • vpc:networks:get
    • vpc:ports:list

URI

POST /v2.1/endpoints/{endpoint_id}/ipaddresses

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

endpoint_id

Yes

String

Definition

Endpoint ID. You can obtain the value by calling the API for querying endpoints (ListEndpoints).

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which is used for identity authentication. It must be carried in the request header to verify the user identity during API calls.

You can obtain it by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

For details about how to obtain a user token, see Obtaining a User Token.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ipaddress

Yes

IpaddressInfo object

Definition

IP address to be bound.

Constraints

N/A

Table 4 IpaddressInfo

Parameter

Mandatory

Type

Description

subnet_id

Yes

String

Definition

Subnet ID. You can obtain the value by calling the API for querying the VPC subnet list.

Constraints

N/A

Range

N/A

Default Value

N/A

ip

No

String

Definition

Custom IP address, which must be within the IP address range of the subnet.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter

Type

Description

endpoint

EndpointResp object

Definition

Endpoint object.

Table 6 EndpointResp

Parameter

Type

Description

id

String

Definition

Endpoint ID, which is a UUID used to identify the endpoint.

Range

N/A

name

String

Definition

Endpoint name.

Range

N/A

direction

String

Definition

Endpoint direction.

Range

  • inbound: indicates an inbound endpoint.

  • outbound: indicates an outbound endpoint.

status

String

Definition

Resource status.

Range

  • ACTIVE: Normal

  • PENDING_CREATE: Creating

  • PENDING_DELETE: Deleting

  • ERROR: Failed

vpc_id

String

Definition

ID of the VPC to which the endpoint belongs.

Range

N/A

ipaddress_count

Integer

Definition

Number of IP addresses of the endpoint.

Range

N/A

resolver_rule_count

Integer

Definition

Number of endpoint rules.

This field is returned only for outbound endpoints.

Range

N/A

create_time

String

Definition

Creation time.

The value must be a UTC+0 time in format of yyyy-MM-dd'T'HH:mm:ss.SSS, for example, 2023-01-01T12:00:00.000.

Range

N/A

update_time

String

Definition

Update time.

The value must be a UTC+0 time in format of yyyy-MM-dd'T'HH:mm:ss.SSS, for example, 2023-01-01T12:00:00.000.

Range

N/A

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Example Requests

Binding an IP address to an endpoint

POST https://{Endpoint}/v2.1/endpoints/{endpoint_id}/ipaddresses

{
  "ipaddress" : {
    "ip" : "",
    "subnet_id" : "3ee6107e-4188-4c4d-b453-80d6b9a147d5"
  }
}

Example Responses

Status code: 202

{
  "endpoint" : {
    "id" : "ff80808169bf16c70169bf1d02270000",
    "name" : "poi-666",
    "direction" : "inbound",
    "status" : "PENDING_CREATE",
    "vpc_id" : null,
    "ipaddress_count" : 0,
    "resolver_rule_count" : 0,
    "create_time" : "2019-03-27T12:25:43.181",
    "update_time" : "2019-03-27T12:25:43.181"
  }
}

SDK Sample Code

The SDK sample code is as follows.

Binding an IP address to an endpoint

 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
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.dns.v2.region.DnsRegion;
import com.huaweicloud.sdk.dns.v2.*;
import com.huaweicloud.sdk.dns.v2.model.*;


public class AssociateEndpointIpaddressSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DnsClient client = DnsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DnsRegion.valueOf("<YOUR REGION>"))
                .build();
        AssociateEndpointIpaddressRequest request = new AssociateEndpointIpaddressRequest();
        request.withEndpointId("{endpoint_id}");
        Ipaddresses body = new Ipaddresses();
        IpaddressInfo ipaddressbody = new IpaddressInfo();
        ipaddressbody.withSubnetId("3ee6107e-4188-4c4d-b453-80d6b9a147d5")
            .withIp("");
        body.withIpaddress(ipaddressbody);
        request.withBody(body);
        try {
            AssociateEndpointIpaddressResponse response = client.associateEndpointIpaddress(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());
        }
    }
}

Binding an IP address to an endpoint

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdns.v2.region.dns_region import DnsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdns.v2 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"]

    credentials = BasicCredentials(ak, sk)

    client = DnsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DnsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = AssociateEndpointIpaddressRequest()
        request.endpoint_id = "{endpoint_id}"
        ipaddressbody = IpaddressInfo(
            subnet_id="3ee6107e-4188-4c4d-b453-80d6b9a147d5",
            ip=""
        )
        request.body = Ipaddresses(
            ipaddress=ipaddressbody
        )
        response = client.associate_endpoint_ipaddress(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Binding an IP address to an endpoint

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dns "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/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")

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := dns.DnsClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dns.NewDnsClient(hcClient)

    request := &model.AssociateEndpointIpaddressRequest{}
	request.EndpointId = "{endpoint_id}"
	ipIpaddress:= ""
	ipaddressbody := &model.IpaddressInfo{
		SubnetId: "3ee6107e-4188-4c4d-b453-80d6b9a147d5",
		Ip: &ipIpaddress,
	}
	request.Body = &model.Ipaddresses{
		Ipaddress: ipaddressbody,
	}
	response, err := client.AssociateEndpointIpaddress(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

202

Request accepted

400

Error response

500

Error response

Error Codes

See Error Codes.