ResetInstancesInternetMaxBandwidth

Last Updated At: 2026-08-02 00:05:21

1. Interface Description

Interface request domain name: cvm.api3.convergecloud.com.

This API (ResetInstancesInternetMaxBandwidth) is used to adjust the public network bandwidth cap of an instance.

The bandwidth cap range varies for different models.
For bandwidth billed by using the BANDWIDTH_PREPAID method, parameters StartTime and EndTime need to be entered to specify the time period when the adjusted bandwidth takes effect. In this scenario, it is not supported to reduce the bandwidth, which may involve charges. Make sure your account balance is sufficient.
For bandwidth billed by using the TRAFFIC_POSTPAID_BY_HOUR, BANDWIDTH_POSTPAID_BY_HOUR, and BANDWIDTH_PACKAGE methods, adjusting the bandwidth cap through this API takes effect in real time. You can increase or reduce the bandwidth within the allowed range. It is not supported to enter parameters StartTime and EndTime.
The API does not support adjusting the bandwidth billed by using the BANDWIDTH_POSTPAID_BY_MONTH method.
The API does not support adjusting the bandwidth billed by using the BANDWIDTH_PREPAID and BANDWIDTH_POSTPAID_BY_HOUR methods in batches.
The API does not support adjusting bandwidth billed by using mixed methods in batches. For example, it does not support adjusting the bandwidth billed by using the TRAFFIC_POSTPAID_BY_HOUR and BANDWIDTH_PACKAGE methods.

Default interface request rate limit: 10 times per second.

Interface update time: 2022-10-28 03:43:18.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name	Required	Allow NULL	Type	Description
Action	Yes	No	String	Public parameter, The value of this interface: ResetInstancesInternetMaxBandwidth
Version	Yes	No	String	Public parameter, The value of this interface: 2017-03-12
Region	No	No	String	Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
InstanceIds	Yes	No	Array of String	One or more instance IDs to be operated. You can obtain the instance ID through the `InstanceId` in the returned value from the API DescribeInstances. A maximum of 100 batch instances per request are allowed. Example: ["ins-r8hr2upy"]
InternetAccessible	Yes	No	InternetAccessible	Public network outbound bandwidth configuration. Different models have different bandwidth cap ranges. For specific restrictions, see the bandwidth limit reconciliation statement. Currently, only the `InternetMaxBandwidthOut` parameter is supported. Example:View
StartTime	No	No	String	Data from which the bandwidth takes effect, in the format of `YYYY-MM-DD`, such as `2016-10-30`. The start data should not be earlier than the current time. If the start data is today, the new bandwidth takes effect immediately. This parameter is only valid for monthly subscription bandwidth, and is not supported for bandwidth billed by other modes. Otherwise, the API will return a corresponding error code. Example: 2017-03-15
EndTime	No	No	String	Date until which the bandwidth takes effect, in the format of `YYYY-MM-DD`, such as `2016-10-30`. The validity period of the new bandwidth covers the end date. The end date should not be later than the expiration date of a monthly subscription instance. You can obtain the expiration date of an instance through the `ExpiredTime` in the returned value from the API DescribeInstances. This parameter is only valid for monthly subscription bandwidth, and is not supported for bandwidth billed by other modes. Otherwise, the API will return a corresponding error code. Example: 2017-03-16

3. Output Parameters

Parameter name	Type	Description
TaskId	String	Task ID Example: 435323
FlowId	Int64	Task Flow ID Example: 4
RequestId	String	Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

4. Error Code

The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

Error Code	Description
InvalidInstanceId.NotFound	No corresponding instance was found.
InvalidInstance.NotSupported	Unsupported instance.
InvalidParameterValue	Invalid parameter value. The format of the parameter value is incorrect or not supported, etc.
InternalServerError	Internal operation error.
InvalidParameterValue.Range	Invalid parameter value. The range of the parameter value is not legal.
InvalidAccount.InsufficientBalance	Insufficient account balance
InvalidInstanceId.Malformed	Invalid Instance ID. The format of the specified instance ID is incorrect, for example, an instance ID length error `ins-1122`.
InvalidParameter	Invalid parameter. The parameter does not meet the requirements, is not supported, or the like.
MissingParameter	Parameters are missing. The request did not include mandatory parameters.
InvalidAccount.UnpaidOrder	The account has unpaid orders.
InvalidPermission	The account does not support this operation.