tencent cloud

Feedback

ModifyAddressesBandwidth

Last updated: 2022-03-31 16:51:33

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.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

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

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.AddressIdMalformed This IP address ID is invalid.
InvalidParameterValue.AddressNotFound Unable to find the address.
InvalidParameterValue.BandwidthOutOfRange The bandwidth exceeds the limit.
InvalidParameterValue.BandwidthTooSmall The selected bandwidth is smaller than the minimum permissible range.
InvalidParameterValue.InconsistentInstanceInternetChargeType The billing mode of this instance is different from that of others.
InvalidParameterValue.InstanceIdMalformed Incorrect instance ID.
InvalidParameterValue.InstanceNoCalcIP Request failed: this instance does not have a CalcIP (device IP).
InvalidParameterValue.InstanceNoWanIP Request failed: this instance does not have a WanIP (public IP).
InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
InvalidParameterValue.ResourceExpired The resource has expired.
InvalidParameterValue.ResourceNotExisted The resource is not associated with this bandwidth package.
InvalidParameterValue.ResourceNotSupport The resource does not support this operation.
UnsupportedOperation.ActionNotFound The port does not exist.
UnsupportedOperation.AddressStatusNotPermit This operation is not supported by the IP address status.
UnsupportedOperation.InstanceStateNotSupported This operation is not supported by the status of the instance bound with the IP address.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support