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.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
endpoint_id	Yes	String	Endpoint ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition The user token. The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. For details about how to obtain a user token, seeObtaining 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	IP address to be bound

**Table 4** IpaddressInfo
Parameter	Mandatory	Type	Description
subnet_id	Yes	String	Subnet ID
ip	No	String	Custom IP address, which must fall into the subnet

Response Parameters

Status code: 202

**Table 5** Response body parameters
Parameter	Type	Description
endpoint	EndpointResp object	Endpoint

**Table 6** EndpointResp
Parameter	Type	Description
id	String	Endpoint ID, which is a UUID used to identify the endpoint
name	String	Endpoint name
direction	String	Endpoint direction. The value can be: inbound: indicates an inbound endpoint. outbound: indicates an outbound endpoint.
status	String	Resource status. The value can be PENDING_CREATE, ACTIVE, PENDING_DELETE, or ERROR.
vpc_id	String	ID of the VPC to which the endpoint belongs.
ipaddress_count	Integer	Number of IP addresses of the endpoint
resolver_rule_count	Integer	Number of endpoint rules in the endpoint This parameter is returned only for outbound endpoints.
create_time	String	The creation time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS
update_time	String	The update time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS

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

Request accepted

{
  "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"
  }
}