Tenant Cloud Network Virtual Private Cloud Elastic IP APIs AllocateAddresses

AllocateAddresses

Last Updated At: 2026-08-02 00:06:17

1. Interface Description

Interface request domain name: vpc.api3.convergecloud.com.

This API (AllocateAddresses) is used to apply for one or more Elastic IPs (referred to as EIP).

  • An EIP is a static IP address designed for dynamic cloud computing. With an EIP, you can quickly remap the EIP to another instance, thereby shielding against instance failures.
  • Your EIP is associated with your cloud platform account, not with any particular instance. It remains associated with your cloud platform account until you choose to explicitly release the address or if the account is overdue for more than 24 hours.
  • There is a limit on the maximum quota of EIPs that a cloud platform account can apply for in each region, as detailed in the EIP Product Introduction. The aforementioned quota can be obtained through the DescribeAddressQuota API.

Default interface request rate limit: 10 times per second.

Interface update time: 2022-06-24 18:32:38.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: AllocateAddresses
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
AddressCount No No Int64 EIP quantity. Default value: 1.
Example: 1
InternetServiceProvider No No String EIP line type.
<ul style="margin:0">
  • User with static single-line IP address allowlist enabled. Valid values: 
    • CMCC
    • CTCC
    • CUCC
     Note: Only some regions support static single-line IP addresses.

    • Example: BGP
    DedicatedClusterId No No Array of String Unique CDC ID.
    Example: cluster-gbo27yc4
    InternetChargeType No No String EIP billing method.
    Example: TRAFFIC_POSTPAID_BY_HOUR
    InternetMaxBandwidthOut No No Int64 EIP bandwidth limit, unit: Mbps.
    <ul style="margin:0">
  • For users on the bandwidth uplift allowlist, the value range depends on the EIP billing method:
    • BANDWIDTH_PACKAGE: from 1 Mbps to 1000 Mbps
    • BANDWIDTH_POSTPAID_BY_HOUR: from 1 Mbps to 100 Mbps
    • TRAFFIC_POSTPAID_BY_HOUR: from 1 Mbps to 100 Mbps
    Default value: 1 Mbps.
  • For users not on the bandwidth uplift allowlist, the EIP bandwidth limit depends on the public network bandwidth limit of the instance it's bound to. This parameter is not required.

    • Example: 10
    AddressChargePrepaid No No AddressChargePrepaid Billing cycle, required in case of prepaid mode.
    Example:View
    DealId No No String Order ID, internal parameters.
    Example: 20200609000000528579909840049393
    AddressType No No String EIP type. Default value: EIP.
    Example: AnycastEIP
    Zone No No String EIP availability zone, used to specify the availability zone to apply for EIP.
    Example: ap-region-1
    ZoneName No No String EIP availability zone, used to specify the availability zone to apply for EIP.
    Example:
    VipCluster No No Array of String Specifies IP address to apply for EIP. Each account has a quota of three times per month.
    Example: ['10.0.0.5']
    Tags No No Array of Tag List of tags to associate.
    Example:View
    BandwidthPackageId No No String Unique ID parameter for the BGP bandwidth package. Setting this parameter and having InternetChargeType as BANDWIDTH_PACKAGE indicate that the created EIP will join this BGP bandwidth package and adopt the bandwidth package billing mode.
    Example: bwp-6jnvlsv4

    3. Output Parameters

    Parameter name Type Description
    AddressSet Array of String List of unique IDs for requested EIPs.
    Example: ["eip-m44ku5d2"]
    TaskId String Asynchronous task TaskId. The task status can be queried using the DescribeTaskResult API.
    Example: 61531428
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    AddressQuotaLimitExceeded Insufficient account quota. Each account can create up to 20 EIPs in each region.
    AddressQuotaLimitExceeded.DailyAllocate Insufficient purchase attempts. The number of daily subscriptions for each account in each region is twice the quota.