tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

AllocateAddresses

Last updated: 2024-11-25 20:05:45

    1. API Description

    Domain name for API request: vpc.intl.tencentcloudapi.com.

    This API is used to apply for one or more Elastic IP Addresses (EIPs for short).

    • An EIP is a static IP address that is dedicated for dynamic cloud computing. You can quickly re-map an EIP to another instance under your account to protect against instance failures.
    • Your EIP is associated with your Tencent Cloud account rather than an instance. It remains associated with your Tencent Cloud account until you choose to explicitly release it or your account is in arrears for more than 24 hours.
    • The maximum number of EIPs that can be applied for a Tencent Cloud account in each region is restricted. For more information, see EIP Product Introduction. You can get the quota information through the DescribeAddressQuota API.

    A maximum of 10 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: AllocateAddresses.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    AddressCount No Integer The number of EIPs. Default: 1.
    InternetServiceProvider No String The EIP line type. Default: BGP.
    • For a user who has activated the static single-line IP allowlist, possible values are:
      • CMCC: China Mobile
      • CTCC: China Telecom
      • CUCC: China Unicom
      Note: Only certain regions support static single-line IP addresses.
    InternetChargeType No String The EIP billing method.
    • For bill-by-IP account beta users, valid values:
      • BANDWIDTH_PACKAGE: paid by the bandwidth package(who must also be bandwidth package beta users)
      • BANDWIDTH_POSTPAID_BY_HOUR: billed by hourly bandwidth on a pay-as-you-go basis
      • BANDWIDTH_PREPAID_BY_MONTH: monthly bandwidth subscription
      • TRAFFIC_POSTPAID_BY_HOUR: billed by hourly traffic on a pay-as-you-go basis
      Default value: TRAFFIC_POSTPAID_BY_HOUR
    • If you are not a bill-by-IP account beta user, the EIP billing is the same as that for the instance bound to the EIP. Therefore, you do not need to pass in this parameter.
    InternetMaxBandwidthOut No Integer The EIP outbound bandwidth cap, in Mbps.
    • For bill-by-IP account beta users, the bandwidth cap range is determined by the EIP billing mode.
      • BANDWIDTH_PACKAGE: 1 Mbps to 2000 Mbps
      • BANDWIDTH_POSTPAID_BY_HOUR: 1 Mbps to 100 Mbps
      • BANDWIDTH_PREPAID_BY_MONTH: 1 Mbps to 200 Mbps
      • TRAFFIC_POSTPAID_BY_HOUR: 1 Mbps to 100 Mbps
      Default value: 1 Mbps
    • If you are not a bill-by-IP account beta user, the EIP outbound bandwidth cap is subject to the bandwidth cap of the instance bound to the EIP. Therefore, you do not need to pass in this parameter.
    AddressChargePrepaid No AddressChargePrepaid A required billing parameter for an EIP billed by monthly bandwidth subscription. For EIPs using other billing modes, it can be ignored.
    AddressType No String EIP type. Default value: EIP.
    • For beta users of AIA, the value can be:
    AnycastEIP: an AIA IP address. For more information, see Anycast Internet Acceleration.Note: Anycast EIPs are supported only in partial regions.
    • For beta users of dedicated IP, the value can be:
      • HighQualityEIP: Dedicated IP
      Note that dedicated IPs are only available in partial regions.


    • For beta users of Anti-DDoS IP, the value can be:
      • AntiDDoSEIP: Anti-DDoS EIP
      Note that Anti-DDoS IPs are only available in partial regions.
    AnycastZone No String Anycast publishing region
    • Valid for users who have activated AIA. Values:
      • ANYCAST_ZONE_GLOBAL: global publishing region
      • ANYCAST_ZONE_OVERSEAS: overseas publishing region
      • [Disused] ANYCAST_ZONE_A: publishing region A (updated to ANYCAST_ZONE_GLOBAL)
      • [Disused] ANYCAST_ZONE_B: publishing region B (updated to ANYCAST_ZONE_GLOBAL)
      Default: ANYCAST_ZONE_OVERSEAS.
    VipCluster.N No Array of String
    ApplicableForCLB No Boolean [Disused]
    Whether the Anycast EIP can be bound to CLB instances.
    • Valid for users who have activated the AIA. Values:
      • TRUE: the Anycast EIP can be bound to CLB instances.
      • FALSE: the Anycast EIP can be bound to CVMs, NAT gateways, and HAVIPs.
      Default: FALSE.
    Tags.N No Array of Tag List of tags to be bound.
    BandwidthPackageId No 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 No String EIP name, which is the custom EIP name given by the user when applying for the EIP. Default: not named
    DedicatedClusterId No String
    Egress No String Network egress. It defaults to center_egress1.
    AntiDDoSPackageId No String Anti-DDoS service package ID. This is required when you want to request an Anti-DDoS IP.
    ClientToken No 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.

    3. Output Parameters

    Parameter Name Type Description
    AddressSet Array of 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.

    4. Example

    Example1 Creating an AIA IP

    This example shows you how to create an Anycast Internet Acceleration (AIA) IP. This is only available to beta users.

    Input Example

    POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AllocateAddresses
<Common request parameters>

{
    "AddressCount": "1",
    "AddressType": "AnycastEIP"
}

    Output Example

    {
    "Response": {
        "AddressSet": [
            "eip-m44ku5d2"
        ],
        "TaskId": "61531428",
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
    }
}

    Example2 Creating a regular IP

    This example shows you how to create a regular IP.

    Input Example

    POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AllocateAddresses
<Common request parameters>

{
    "AddressCount": "1"
}

    Output Example

    {
    "Response": {
        "AddressSet": [
            "eip-m44ku5d2"
        ],
        "TaskId": "61531421",
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
    }
}

    Example3 Creating a static single-line IP address

    This example shows you how to create a static single-line IP, provided that you are a static single-line IP beta user.

    Input Example

    POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AllocateAddresses
<Common request parameters>

{
    "AddressCount": "1",
    "InternetServiceProvider": "CTCC"
}

    Output Example

    {
    "Response": {
        "AddressSet": [
            "eip-m44ku5d2"
        ],
        "TaskId": "61531429",
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
    }
}

    Example4 申请EIP失败

    幂等请求失败，更新幂等参数。

    Input Example

    POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AllocateAddresses
<common request parameters>

{
    "ClientToken": "b8fcdf80-248a-4095-bfa3-7f59df1aec"
}

    Output Example

    {
    "Response": {
        "Error": {
            "Code": "UnsupportedOperation.DeliveryFailed",
            "Message": "发货失败，请更新`ClientToken`并重试。"
        },
        "RequestId": "8e176c15-f087-4816-a270-306cf87229a6"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    AddressQuotaLimitExceeded The account quota is reached. Each Tencent Cloud account can create up to 20 EIPs in each region.
    AddressQuotaLimitExceeded.DailyAllocate The maximum number of requests is reached. The maximum number of requests made by a Tencent Cloud account per day in each region equals to two times the quota.
    FailedOperation.BalanceInsufficient Insufficient account balance.
    FailedOperation.InvalidRegion Unsupported region.
    InvalidAccount.NotSupported This account is not supported.
    InvalidAddressId.Blocked The specified EIP is in blocked status. When the EIP is in blocked status, it cannot be bound. You must first unblock it.
    InvalidParameterConflict The two parameters cannot be specified at the same time, nor exist concurrently. EIP can only be bound to the instances or the specified private IPs of the specified ENIs.
    InvalidParameterValue.AddressAttacked Attacked IP address.
    InvalidParameterValue.AddressIpNotAvailable The IP address is not available now.
    InvalidParameterValue.BandwidthOutOfRange The bandwidth exceeds the limit.
    InvalidParameterValue.BandwidthPackageIdMalformed Incorrect bandwidth package ID.
    InvalidParameterValue.BandwidthPackageNotFound Failed to query the bandwidth package
    InvalidParameterValue.BandwidthTooSmall The selected bandwidth is smaller than the minimum permissible range.
    InvalidParameterValue.Combination Invalid input parameters
    InvalidParameterValue.InstanceIdMalformed Incorrect instance ID.
    InvalidParameterValue.InvalidDedicatedClusterId Invalid DedicatedClusterId.
    InvalidParameterValue.InvalidTag This Tag is invalid.
    InvalidParameterValue.MixedAddressIpSetType A request cannot contain IP addresses with different cluster types.
    InvalidParameterValue.Range The parameter value is not in the specified range.
    InvalidParameterValue.ResourceIdMalformed The resource ID is incorrect.
    InvalidParameterValue.ResourceNotSupport The resource does not support this operation.
    InvalidParameterValue.TagNotExisted The tag and value do not exist.
    InvalidParameterValue.UnavailableZone This availability zone is unavailable.
    LimitExceeded.BandwidthPackageQuota Exceeded the upper limit of the bandwidth package quota.
    LimitExceeded.BandwidthPackageResourceQuota Number of resources added to this bandwidth package reached the upper limit.
    LimitExceeded.MonthlyAddressRecoveryQuota Ran out of the monthly quota of chances to retrieve IPs.
    LimitExceeded.TagQuota Exceeded the tag quota. Unable to create resources.
    ResourceInsufficient Insufficient resources.
    UnauthorizedOperation.AnycastEip No permission to apply for AnycastEip resources.
    UnauthorizedOperation.InvalidAccount Unauthorized user.
    UnsupportedOperation.AccountNotSupported This account is not supported.
    UnsupportedOperation.ActionNotFound The port does not exist.
    UnsupportedOperation.BandwidthPackageIdNotSupported This bandwidth package does not support this operation.
    UnsupportedOperation.DeliveryFailed
    UnsupportedOperation.InstanceStateNotSupported This operation is not supported by the status of the instance bound with the IP address.
    UnsupportedOperation.InvalidAction Unsupported operation.
    UnsupportedOperation.NotSupportedPurchaseCenterEgressResource
    UnsupportedOperation.OfflineChargeType This billing mode is disused. Please try another billing mode.
    UnsupportedOperation.UnsupportedRegion The service is not available in this country/region.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy