InquiryPriceResetInstancesInternetMaxBandwidth

Last updated: 2020-10-16 18:38:21

1. API Description

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

This API is used to query the price for upgrading 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. You can increase or reduce bandwidth within applicable limits.

A maximum of 10 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: cvm.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: InquiryPriceResetInstancesInternetMaxBandwidth.
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.
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
Price Price Price of the new bandwidth
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the price of a pay-as-you-go instance with a new bandwidth cap

This example shows you how to query the price for changing the bandwidth of the instance “ins-fd8spnmq” to 20 Mbps.

Input Example

GET https://cvm.tencentcloudapi.com/?Action=InquiryPriceResetInstancesInternetMaxBandwidth
&InstanceIds.0=ins-fd8spnmq
&InternetAccessible.InternetMaxBandwidthOut=20
&<common request parameters>

Output Example

{
  "Response": {
    "Price": {
      "BandwidthPrice": {
        "UnitPrice": 0.8,
        "ChargeUnit": "GB"
      }
    },
    "RequestId": "700864b9-85da-4cb9-bc80-d99eaf9fa047"
  }
}

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
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.Range Invalid parameter value: invalid parameter value range.
InvalidPermission This operation is not supported for the account.
MissingParameter Missing parameter.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help