tencent cloud

Feedback

InquiryPriceAllocateAddresses

Last updated: 2024-12-30 14:41:29

1. API Description

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

This API (InquiryPriceAllocateAddresses) is used to query the price of purchasing EIPs.

A maximum of 2 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: InquiryPriceAllocateAddresses.
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.
InternetChargeType No String EIP billing method.

  • Users with standard account type. Valid values:

    • 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.

InternetMaxBandwidthOut No Integer The EIP outbound bandwidth cap, in Mbps.
  • For users with standard account type, the range of optional values depends on the EIP billing method:

    • 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.

  • For users with traditional account type, the EIP outbound bandwidth cap is subject to the public network egress bandwidth limit of the bound instance. No need to pass this parameter.
  • AddressChargePrepaid No AddressChargePrepaid A required billing parameter for an EIP billed by "BANDWIDTH_PREPAID_BY_MONTH". When the EIP is billed by "BANDWIDTH_PREPAID_BY_MONTH" this parameter is required. For other scenarios, it can be ignored.
    AddressType No String EIP type. Default value: EIP.



    • High quality EIP, valid values:
      • HighQualityEIP: high quality EIP
      Note: High quality EIP is supported only in some regions.

    • High-defense IP, valid values:

      • AntiDDoSEIP: high-defense IP



    3. Output Parameters

    Parameter Name Type Description
    Price InternetPrice EIP price
    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 Inquiring About an Elastic IP Billed by Hourly Traffic

    This example shows you how to inquire about an elastic IP billed by hourly traffic.

    Input Example

    POST / HTTP/1.1
    Host: vpc.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: InquiryPriceAllocateAddresses
    <Common request parameters>
    
    {
        "AddressType": "EIP",
        "InternetMaxBandwidthOut": "1",
        "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR"
    }
    

    Output Example

    {
        "Response": {
            "Price": {
                "AddressPrice": {
                    "ChargeUnit": "HOUR",
                    "UnitPrice": 0.8,
                    "DiscountPrice": 0.8
                }
            },
            "RequestId": "90d508a8-9ee8-4220-9c8e-9faeedce3ab4"
        }
    }
    

    Example2 Hourly Bandwidth Billing Mode Elastic IP Inquiry

    This example shows you how to inquire about an elastic IP billed by hourly bandwidth.

    Input Example

    POST / HTTP/1.1
    Host: vpc.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: InquiryPriceAllocateAddresses
    <Common request parameters>
    
    {
        "AddressType": "EIP",
        "InternetMaxBandwidthOut": "1",
        "InternetChargeType": "BANDWIDTH_POSTPAID_BY_HOUR"
    }
    

    Output Example

    {
        "Response": {
            "Price": {
                "AddressPrice": {
                    "UnitPrice": 0.063,
                    "DiscountPrice": 0.063,
                    "ChargeUnit": "HOUR"
                }
            },
            "RequestId": "ebc826be-ec1a-4522-b08f-8da3fe5adedc"
        }
    }
    

    Example3 Monthly Bandwidth Billing Mode Elastic IP Inquiry

    This example shows you how to inquire about Elastic IP in monthly bandwidth billing mode.

    Input Example

    POST / HTTP/1.1
    Host: vpc.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: InquiryPriceAllocateAddresses
    <Common request parameters>
    
    {
        "AddressChargePrepaid": {
            "Period": 1
        },
        "AddressType": "EIP",
        "InternetChargeType": "BANDWIDTH_PREPAID_BY_MONTH",
        "InternetMaxBandwidthOut": 1
    }
    

    Output Example

    {
        "Response": {
            "Price": {
                "AddressPrice": {
                    "OriginalPrice": 20,
                    "DiscountPrice": 20
                }
            },
            "RequestId": "136605f0-ca35-4d22-9b77-e053168fa25f"
        }
    }
    

    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
    FailedOperation.InvalidRegion Unsupported region.
    InvalidAccount.NotSupported This account is not supported.
    InvalidParameterValue.BandwidthOutOfRange The bandwidth exceeds the limit.
    InvalidParameterValue.Combination Invalid input parameters
    InvalidParameterValue.UnavailableZone This availability zone is unavailable.
    UnsupportedOperation.ActionNotFound The port does not exist.
    UnsupportedOperation.UnsupportedRegion The service is not available in this country/region.