vpc · 2017-03-12

AssociateAddress

POST

Bind an Elastic IP (EIP for short) to the specified private IP of an instance or ENI.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /vpc/AssociateAddress path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl

curl -sS https://vpc.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/vpc/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: vpc.api3.convergecloud.com' \
  -H 'X-TC-Action: AssociateAddress' \
  -H 'X-TC-Version: 2017-03-12' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"AddressId":"<AddressId>"}'

Request parameters

Field	Type	Required	Description
AddressId	string	Yes	The unique ID of the EIP, such as `eip-11112222`.
InstanceId	string	No	The ID of the instance to be bound, such as `ins-11112222`, `lb-11112222`. You can query the instance ID by logging into the Console. You can also obtain the parameter value from the `InstanceId` field in the returned result of DescribeInstances API.
NetworkInterfaceId	string	No	The ID of the ENI to be bonud, such as `eni-11112222`. `NetworkInterfaceId` and `InstanceId` cannot be specified at the same time. You can query the ENI ID by logging into the Console. You can also obtain the parameter value from the `networkInterfaceId` field in the returned result of DescribeNetworkInterfaces API.
PrivateIpAddress	string	No	The private IP to be bound. If you specify `NetworkInterfaceId`, then you must also specify `PrivateIpAddress`, indicating the EIP is bound to the specified private IP of the specified ENI. At the same time, you must ensure the specified `PrivateIpAddress` is a private IP on the `NetworkInterfaceId`. You can query the private IP of the specified ENI by logging into the Console. You can also obt…
EipDirectConnection	boolean	No	Specify whether to configure direct access when binding EIPs. For details, see EIP Direct Access. Valid values: `True` and `False` (default). This parameter can be set to `True` when binding EIPs to a CVM instance or EKS cluster. It is in a beta test. To try it out, please submit a ticket.

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

Field	Type	Description
TaskId	string	The async task ID. You can use the DescribeTaskResult API to query the task status.
RequestId	string	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Success

{
  "Response": {
    "TaskId": …,
    "RequestId": "…"
  }
}

Error

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/vpc.

SecretIdSecretKey

Request bodyvalid JSONPOST vpc.api3.convergecloud.com · AssociateAddress

{
  "AddressId": "<AddressId>"
}

This action changes resources in my own account and may create a charge. I understand.

Recorded example response — captured 2026-09-16

{
  "Response": {
    "TaskId": "23050",
    "RequestId": "b5ed4cf1-2bf3-a695-af60-9906fb0c6065"
  }
}

Behaviour

An address attached to a network interface reports AddressStatus BIND_ENI rather than BIND. Treat BIND, BIND_ENI and BINDING as attached.