ModifyAddressesBandwidth

Last updated: 2021-09-29 17:58:14

1. API Description

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

This API is used to adjust the bandwidth of Elastic IP, including EIP billed on a pay-as-you-go, monthly subscription, and bandwidth package basis.

A maximum of 20 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

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: ModifyAddressesBandwidth.
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.
AddressIds.N	Yes	Array of String	List of EIP IDs, such as “eip-xxxx”.
InternetMaxBandwidthOut	Yes	Integer	Target bandwidth value adjustment
StartTime	No	Timestamp	(Disused) The start time of the monthly bandwidth subscription
EndTime	No	Timestamp	(Disused) The end time of the monthly bandwidth subscription

3. Output Parameters

Parameter Name	Type	Description
TaskId	String	The async task ID. You can use the DescribeTaskResult API to query the task status.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Adjusting the pay-as-you-go bandwidth

Input Example

https://vpc.tencentcloudapi.com/?Action=ModifyAddressesBandwidth
&InternetMaxBandwidthOut=2
&AddressIds.0=eip-alfxy9c8
&<Common request parameters>

Output Example

{
  "Response": {
    "TaskId": "11531422",
    "RequestId": "24cfceab-3492-482c-b86f-27f598b1b044"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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
InternalServerError	Internal error.
InvalidAddressId.NotFound	The specified EIP does not exist.
InvalidParameterValue.BandwidthOutOfRange	The bandwidth exceeds the limit.
InvalidParameterValue.BandwidthTooSmall	The selected bandwidth is smaller than the minimum permissible range.
InvalidParameterValue.InstanceNoCalcIP
InvalidParameterValue.InstanceNoWanIP

Recent Pages