tencent cloud



最后更新时间:2023-03-27 16:21:21

1. API Description

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

This API is used to change the public bandwidth cap of an instance.

  • The allowed bandwidth cap varies for different models. For details, see Purchasing Network Bandwidth.
  • For bandwidth billed by the TRAFFIC_POSTPAID_BY_HOUR method, changing the bandwidth cap through this API takes effect in real time. Users can increase or reduce bandwidth within applicable limits.

A maximum of 10 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: ResetInstancesInternetMaxBandwidth.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
InstanceIds.N Yes Array of String Instance ID(s). To obtain the instance IDs, you can call DescribeInstances and look for InstanceId in the response. The maximum number of instances in each request is 100. When changing the bandwidth of instances with BANDWIDTH_PREPAID or BANDWIDTH_POSTPAID_BY_HOUR as the network billing method, you can only specify one instance at a time.
InternetAccessible Yes InternetAccessible Configuration of public network egress bandwidth. The maximum bandwidth varies among different models. For more information, see the documentation on bandwidth limits. Currently only the InternetMaxBandwidthOut parameter is supported.
StartTime No String Date from which the new bandwidth takes effect. Format: YYYY-MM-DD, such as 2016-10-30. The starting date cannot be earlier than the current date. If the starting date is the current date, the new bandwidth takes effect immediately. This parameter is only valid for prepaid bandwidth. If you specify the parameter for bandwidth with other network billing methods, an error code will be returned.
EndTime No String Date until which the new bandwidth is effective. Format: YYYY-MM-DD, such as 2016-10-30. The validity period of the new bandwidth covers the end date. The end date cannot be later than the expiration date of a prepaid instance. You can query the expiration time of an instance by calling DescribeInstances and looking for ExpiredTime in the response. This parameter is only valid for prepaid bandwidth. If you specify the parameter for bandwidth with other network billing methods, an error code will be returned.

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 Modifying the public network bandwidth cap of an instance

This example shows you how to modify the public network bandwidth cap of an instance.

Input Example

GET https://cvm.tencentcloudapi.com/?Action=ResetInstancesInternetMaxBandwidth
&<Common request parameters>

Output Example

    "Response": {
        "RequestId": "d39d6c09-44e9-4e80-8661-77b5ff3cbc15"

5. Developer Resources


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.NotFoundEIP This instance does not bind an EIP.
InternalError.TradeUnknownError Internal error.
InternalServerError Internal error.
InvalidAccount.InsufficientBalance Insufficient account balance.
InvalidAccount.UnpaidOrder The account has unpaid orders.
InvalidInstance.NotSupported This instance is not supported.
InvalidInstanceId.Malformed Invalid instance ID. The specified instance ID has an invalid format. For example, ins-1122 has an invalid ID length.
InvalidInstanceId.NotFound No instance found.
InvalidParameter A parameter error occurred.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.BandwidthPackageIdMalformed The shared bandwidth package ID is invalid. Please provide a standard shared bandwidth package ID in the format similar to bwp-xxxxxxxx. In this format, the letter x stands for a lowercase character or a number.
InvalidParameterValue.InstanceIdMalformed Invalid instance ID. Please enter a valid ID, such as ins-xxxxxxxx (“x” represents a lower-case letter or a number).
InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
InvalidParameterValue.Range Invalid parameter value: invalid parameter value range.
InvalidPermission This operation is not supported for the account.
MissingParameter Missing parameter.
MutexOperation.TaskRunning An identical job is running.
OperationDenied.InstanceOperationInProgress The instance has an operation in progress. Please try again later.
UnsupportedOperation.BandwidthPackageIdNotSupported The specified instance or network cannot use the bandwidth package.
UnsupportedOperation.InstanceChargeType This instance billing mode does not support the operation.
UnsupportedOperation.InstanceStateBanning This CVM is blocked. Please submit a ticket.
UnsupportedOperation.InstanceStateEnterServiceLiveMigrate The instance ins-xxxxxx in the ENTER_SERVICE_LIVE_MIGRATE status is not supported.
UnsupportedOperation.InstanceStateIsolating Unable to isolate: the instance is isolated
UnsupportedOperation.InstanceStatePending The instances are being created, and this operation is not supported.
UnsupportedOperation.InstanceStateRebooting The instances are being restarted, and this operation is not supported.
UnsupportedOperation.InstanceStateRescueMode Instances in the rescue mode are not available for this operation.
UnsupportedOperation.InstanceStateShutdown Isolated instances do not support this operation.
UnsupportedOperation.InstanceStateStarting The instance is starting up, and this operation is not supported.
UnsupportedOperation.InstanceStateStopping The instance is being shut down, and this operation is not supported.
UnsupportedOperation.InstanceStateTerminating The instance is being terminated, and the operation is not supported.
UnsupportedOperation.StoppedModeStopCharging The instance does not support the no charges when shut down feature.




7x24 电话支持