Contents:
1. API Description
Domain name for API request: vpc.tencentcloudapi.com.
This API (ResetVpnGatewayInternetMaxBandwidth) is used to adjust the bandwidth cap of a VPN gateway. Configuration upgrade is supported. For prepaid VPN gateways, they 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. 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: 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 | VPN gateway instance ID. |
| InternetMaxBandwidthOut | Yes | Integer | Public network bandwidth setting. Available bandwidth specifications: 5, 10, 20, 50, and 100 (in 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. 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.Malformed | Invalid input parameter format. |
| ResourceNotFound | Resource does not exist. |
5. Example
Example 1 Adjust 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"
}
}6. Other Resources
Cloud API 3.0 comes with the following development tools to make it easier to call the API.