InquiryPriceCreateVpnGateway

Last updated: 2019-11-29 18:12:16

PDF

1. API Description

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

This API (InquiryPriceCreateVpnGateway) is used to inquire the price for VPN gateway creation.

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

Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com.

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 parameter. The value used for this API: InquiryPriceCreateVpnGateway
Version Yes String Common parameter. The value used for this API: 2017-03-12
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InternetMaxBandwidthOut Yes Integer Public network bandwidth setting. Available bandwidth specifications: 5, 10, 20, 50, and 100 (in Mbps)
InstanceChargeType No String Billing method of the VPN gateway. PREPAID: Prepaid; POSTPAID_BY_HOUR: Postpaid. Default is POSTPAID_BY_HOUR. If the prepaid mode is specified, the parameter InstanceChargePrepaid is required.
InstanceChargePrepaid No InstanceChargePrepaid Indicates the relevant parameter setting for the prepaid mode. This parameter can specify the purchased usage period, whether to set automatic renewal, and other attributes of the instance purchased on a prepaid basis. This parameter is required if the billing method for the specified instance is prepaid.

3. Output Parameters

Parameter Name Type Description
Price Price Price.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Error Codes

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

Error Code Description
InvalidParameterValue Invalid parameter value.

5. Example

Example 1 Inquire the price for creating a prepaid VPN gateway

Input example

https://vpc.tencentcloudapi.com/?Action=InquiryPriceCreateVpnGateway
&Version=2017-03-12
&InstanceChargeType=PREPAID
&InstanceChargePrepaid.Period=1
&InternetMaxBandwidthOut=5
&<Common request parameters>

Output example

{
  "Response": {
    "Price": {
      "InstancePrice": {
        "DiscountPrice": 380,
        "OriginalPrice": 380
      }
    },
    "RequestId": "1b2534de-3f38-4913-921a-af5ff1a9cb73"
  }
}

Example 2 Inquire the price for creating a postpaid VPN gateway

Input example

https://vpc.tencentcloudapi.com/?Action=InquiryPriceCreateVpnGateway
&Version=2017-03-12
&InstanceChargeType=POSTPAID_BY_HOUR
&InternetMaxBandwidthOut=5
&<Common request parameters>

Output example

{
  "Response": {
    "Price": {
      "BandwidthPrice": {
        "ChargeUnit": "GB",
        "UnitPrice": 0.8
      },
      "InstancePrice": {
        "ChargeUnit": "HOUR",
        "UnitPrice": 0.48
      }
    },
    "RequestId": "e87327cd-f8fa-4340-9959-58ebe8f11f6b"
  }
}

6. Other Resources

Cloud API 3.0 comes with the following development tools to make it easier to call the API.