vpc · 2017-03-12

AllocateAddresses

POST

Apply for one or more Elastic IP Addresses (EIPs 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/AllocateAddresses 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: AllocateAddresses' \
  -H 'X-TC-Version: 2017-03-12' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{}'

Request parameters

Field	Type	Required	Description
AddressCount	integer	—	The number of EIPs. Default: 1.
InternetServiceProvider	string	—	The EIP line type. Default: BGP.
InternetChargeType	string	—	The EIP billing method.
InternetMaxBandwidthOut	integer	—	The EIP outbound bandwidth cap, in Mbps.
AddressChargePrepaid	AddressChargePrepaid	—	A required billing parameter for an EIP billed by monthly bandwidth subscription. For EIPs using other billing modes, it can be ignored.
AddressType	string	—	EIP type. Default value: EIP.
AnycastZone	string	—	Anycast publishing region
VipCluster	string[]	—	Specify IP address to apply for an EIP; each account has a quota of three times per month.
ApplicableForCLB	boolean	—	[Disused]
Tags	Tag[]	—	List of tags to be bound.
BandwidthPackageId	string	—	The unique ID of a BGP bandwidth package. If you configure this parameter and set InternetChargeType as BANDWIDTH_PACKAGE, the new EIP is added to this package and billed by the bandwidth package mode.
AddressName	string	—	EIP name, which is the custom EIP name given by the user when applying for the EIP. Default: not named
DedicatedClusterId	string	—	CDC unique ID
IsDedicatedAddressPool	boolean	—	Whether to use a dedicated resource pool. Default value: True
Egress	string	—	Network egress. It defaults to `center_egress1`.
AntiDDoSPackageId	string	—	Anti-DDoS service package ID. This is required when you want to request an Anti-DDoS IP.
ClientToken	string	—	A string used to ensure the idempotency of the request. Generate a value based on your client. This can ensure that the value is unique for different requests. It only supports ASCII characters and can contain up to 64 characters.

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
AddressSet	string[]	List of the unique IDs of the requested EIPs.
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": {
    "AddressSet": …,
    "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 · AllocateAddresses

{}

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

Recorded example response — captured 2026-09-17

{
  "Response": {
    "AddressSet": [
      "eip-lrx681be"
    ],
    "TaskId": "23064",
    "RequestId": "922d416e-11d7-91d7-5224-6d4527593ff8"
  }
}