vpc — Virtual Private Cloud
vpc · 2017-03-12
DisassociateAddress
POST
Unbind an Elastic IP (EIP for short).
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /vpc/DisassociateAddress 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: DisassociateAddress' \
-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`. |
| ReallocateNormalPublicIp | boolean | No | Whether a common public IP is assigned after the EIP is unbound. Value range: TRUE: Indicates that after the EIP is unbound, a common public IP is assigned. FALSE: Indicates that after the EIP is unbound, a common public IP is not assigned. Default value: FALSE. The parameter can be specified only under the following conditions: It can only be specified when you unbind an EIP from the primary p… |
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.
Request bodyvalid JSONPOST vpc.api3.convergecloud.com · DisassociateAddress
Behaviour
Poll DescribeAddresses for AddressStatus UNBIND before attempting to release the address.