Help & DocumentationVirtual Private CloudAPI DocumentationVPN Gateway-Related APIsResetVpnGatewayInternetMaxBandwidth

ResetVpnGatewayInternetMaxBandwidth

Last updated: 2020-03-06 20:26:08

PDF

Contents：

1. API Description

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

This API (ResetVpnGatewayInternetMaxBandwidth) is used to adjust the bandwidth cap of VPN gateways. Currently, only configuration upgrade is supported. VPN gateways with monthly subscription must be within the validity period.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, 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: ResetVpnGatewayInternetMaxBandwidth.
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.
VpnGatewayId Yes String The ID of the VPN gateway instance.
InternetMaxBandwidthOut Yes Integer The public network bandwidth configuration. Available bandwidth specifications: 5, 10, 20, 50, and 100. Unit: Mbps.

3. Output Parameters

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

4. Example

Example1 Adjusting the bandwidth cap of a VPN gateway

Input Example

https://vpc.tencentcloudapi.com/?Action=ResetVpnGatewayInternetMaxBandwidth
&Version=2017-03-12
&VpnGatewayId=vpngw-lazly92z
&InternetMaxBandwidthOut=10
&<Common Request Parameters>

Output Example

{
  "Response": {
    "RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
InvalidParameterValue.Malformed Invalid input parameter format.
ResourceNotFound The resource does not exist.