Modifies the bandwidth configurations of an Elastic Compute Service (ECS) instance. You can modify the bandwidth configurations of ECS instances to improve network performance. You can call this operation to upgrade or downgrade the bandwidth configurations of ECS instances.
Operation description
Take note of the following items:
-
Starting November 27, 2020, the maximum bandwidth value that is available for you to create ECS instances or change ECS instance configurations is subject to the throttling policies of your account. To increase the bandwidth limit, submit a ticket. The following throttling policies apply:
- In each region, the sum of actual maximum bandwidths of all ECS instances that use the pay-by-traffic billing method for network usage cannot exceed 5 Gbit/s.
- In each region, the sum of actual maximum bandwidths of all ECS instances that use the pay-by-bandwidth billing method for network usage cannot exceed 50 Gbit/s.
-
If you upgrade the outbound public bandwidth (InternetMaxBandwidthOut) of a subscription (PrePaid) instance from 0 Mbit/s when you modify the bandwidth configurations of the instance, a public IP address is automatically assigned to the instance.
-
If you upgrade the outbound public bandwidth (InternetMaxBandwidthOut) of a pay-as-you-go (PostPaid) instance from 0 Mbit/s when you modify the bandwidth configurations of the instance, no public IP address is automatically assigned to the instance. In this case, you can set
AllocatePublicIptotrueor call the AllocatePublicIpAddress operation to assign a public IP address to the instance. -
You can upgrade the outbound public bandwidth (InternetMaxBandwidthOut) of an instance in the classic network from 0 Mbit/s only if the instance is in the Stopped state.
-
Billing:
- After the bandwidth is upgraded, AutoPay is set to true by default and the payment is automatically made. Make sure that your account balance is sufficient. Otherwise, your order becomes invalid and is canceled. If your account balance is insufficient, you can set AutoPay to false. In this case, when you call the ModifyInstanceNetworkSpec operation, an unpaid order is generated. Then, you can log on to the ECS console to pay for the order.
- After the bandwidth is downgraded, the price difference is refunded to the payment account that you used. Vouchers or coupons that have been redeemed are not refundable.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecs:ModifyInstanceNetworkSpec | update | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The ID of the instance for which you want to modify bandwidth configurations. | i-bp67acfmxazb4**** |
| InternetMaxBandwidthOut | integer | No | The maximum outbound public bandwidth. Unit: Mbit/s. Valid values:
Note
The maximum outbound bandwidth of a single instance is also limited by the network baseline bandwidth (Gbit/s) and network burst bandwidth (Gbit/s) of the instance type. For more information, see Overview of instance families.
| 10 |
| InternetMaxBandwidthIn | integer | No | The maximum inbound bandwidth from the Internet. Unit: Mbit/s. Valid values:
| 10 |
| ISP | string | No | Note
This parameter is in invitational preview and is not publicly available.
| null |
| NetworkChargeType | string | No | The billing method for network usage. Valid values:
Note
When the pay-by-traffic billing method for network usage is used, the maximum inbound and outbound bandwidth values are used as the upper limits of bandwidths instead of guaranteed values. In scenarios where demand outstrips resource supplies, these maximum bandwidths may be limited. If you want guaranteed bandwidths for your instance, use the pay-by-bandwidth billing method for network usage.
| PayByTraffic |
| AllocatePublicIp | boolean | No | Specifies whether to assign a public IP address. Valid values:
Default value: false. | false |
| StartTime | string | No | The start time of the temporary bandwidth upgrade. Specify the time in the ISO 8601 standard in the yyyy-MM-ddThh:mmZ format. The time must be in UTC and accurate to minutes (mm). | 2017-12-05T22:40Z |
| EndTime | string | No | The end time of the temporary bandwidth upgrade. Specify the time in the ISO 8601 standard in the yyyy-MM-ddThhZ format. The time must be in UTC and accurate to hours (hh). Note
The interval between the end time and start time of temporary bandwidth upgrade must be greater than or equal to 3 hours.
| 2017-12-06T22Z |
| AutoPay | boolean | No | Specifies whether to automatically complete the payment. Valid values:
Default value: true. | true |
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence. | 123e4567-e89b-12d3-a456-426655440000 |
Response parameters
Examples
Sample success responses
JSONformat
{
"OrderId": "123457890",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidInternetMaxBandwidthIn.ValueNotSupported | The specified InternetMaxBandwidthIn is beyond the permitted range. | The specified maximum inbound public bandwidth exceeds the maximum allowed value. |
| 400 | InvalidInternetMaxBandwidthOut.ValueNotSupported | The specified InternetMaxBandwidthOut is beyond the permitted range. | The specified maximum outbound public bandwidth exceeds the maximum allowed value. |
| 400 | OperationDenied | Specified instance is in VPC. | The instance resides in a VPC. |
| 400 | InvalidParameter.Conflict | %s | The specified parameter is invalid. Check whether parameter conflicts exist. %s is a variable. An error message is dynamically returned based on call conditions. |
| 400 | InvalidStartTime.ValueNotSupported | The specified StartTime is out of the permitted range. | The specified start time is invalid. |
| 400 | InvalidEndTime.ValueNotSupported | The specified EndTime is out of the permitted range. | The specified end time is invalid. |
| 400 | ChargeTypeViolation | The operation is not permitted due to billing method of the instance. | - |
| 400 | InvalidStartTime.ValueNotSupported | %s | The specified parameter StartTime cannot be earlier than the current time. |
| 400 | Account.Arrearage | Your account has an outstanding payment. | Your account has overdue payments. |
| 400 | InvalidEndTime.ValueNotSupported | %s | - |
| 400 | InvalidInternetChargeType.ValueNotSupported | The specified InternetChargeType is invalid. | The specified InternetChargeType parameter is invalid. |
| 400 | DecreasedBandwidthNotAllowed | %s | The bandwidth downgrade operation is invalid. |
| 400 | BandwidthUpgradeDenied.EipBoundInstance | The specified VPC instance has bound EIP, temporary bandwidth upgrade is denied. | The instance is associated with an EIP and cannot have its bandwidth temporarily upgraded. |
| 400 | InvalidClientToken.ValueNotSupported | The ClientToken provided is invalid. | The specified ClientToken parameter is invalid. |
| 400 | Throttling | Request was denied due to request throttling, please try again after 5 minutes. | - |
| 400 | InvalidInstanceStatus.NotStopped | The specified Instance status is not Stopped. | The specified instance is not in the Stopped state. |
| 400 | InvalidAction | Specified action is not valid. | The operation is invalid. |
| 400 | IpAllocationError | Allocate public ip failed. | A public IP address cannot be assigned. |
| 400 | InvalidParam.AllocatePublicIp | The specified param AllocatePublicIp is invalid. | The specified AllocatePublicIp parameter is invalid. |
| 400 | InstanceDowngrade.QuotaExceed | Quota of instance downgrade is exceed. | The maximum number of configuration downgrades allowed for the instance has been reached. |
| 400 | InvalidBandwidth.ValueNotSupported | Instance upgrade bandwidth of temporary not allow less then existed. | - |
| 400 | InvalidInstanceStatus | The specified instance status does not support this action. | The instance is in a state that does not support the current operation. |
| 400 | InvalidInstance.UnPaidOrder | Unpaid order exists in your account, please complete or cancel the payment in the expense center. | Your account has an unpaid order. Pay for the order and try again. |
| 400 | OperationDenied | After downgrade, you cannot upgrade or downgrade your instances again in the remaining time of the current billing cycle. | After you downgrade the configurations of the instance, you cannot upgrade or downgrade the configurations again until the new billing cycle starts. |
| 400 | InvalidInternetChargeType.ValueNotSupported | %s | The specified InternetChargeType parameter is invalid. |
| 400 | LastOrderProcessing | The previous order is still processing, please try again later. | The order is being processed. Try again later. |
| 400 | OperationDenied | The current user does not support this operation. | Your account does not support this operation. |
| 400 | LastRequestProcessing | The previous request is still processing, please try again later. | - |
| 400 | InvalidStartTime.BeyondLifeCycle | The specified start time exceeds the expiration time. | - |
| 400 | InvalidEndTime.BeyondLifeCycle | The specified end time exceeds the expiration time. | - |
| 400 | InvalidPayMethod.SyncPaymentNotSupport | Synchronous payment is not supported. Use another payment method. | - |
| 400 | InvalidBandwidthOut.LessThanZero | The bandwidth must be larger than 0 when specifying isp. | - |
| 400 | InvalidParameter.BandwidthBiggerThanBaseBandwidth | %s | - |
| 400 | InvalidAction.WithActiveElasticUpgrade | The instance has active Elastic Upgrade. | The operation is not supported while the instance are being temporarily upgraded. The instance goes through a temporary configuration upgrade if the EndTime parameter is specified to call the ModifyPrepayInstanceSpec operation. |
| 400 | InvalidParameter.CloudboxNotSupported | %s | - |
| 400 | InvalidParameter.Bandwidth | %s | The specified bandwidth value is invalid. |
| 400 | NoPermission.Price | The operation requires price permission. Please either apply for permission from your main account, or set the parameter AutoPay as true. | - |
| 400 | NoPermission.Refund | The operation requires refund permission. Please apply for permission from your main account. | - |
| 400 | InvalidParameter.DedicatedRegionNotSupported | The specified action is rejected because the specified ECS instance in the dedicated region does not support public IP. | Parameter error codes not supported in the dedicated region |
| 400 | InvalidOperation.InstanceStatusUnsupported | The specified instance status is not supported for this operation, expect status is Running or Stopped. | The status of the specified instance is not satisfied. The status of the instance should be Running or Stopped. |
| 400 | QuotaExceeded.InternetBandwidth | %s. | Under your current account, the public network bandwidth of the Pay-As-You-Go ECS instance charged by fixed bandwidth exceeds the total bandwidth quota limit. |
| 400 | UnsupportedIspNetworkChargeType | The network charge type is not supported when specifying ISP. | The network charge type is not supported when specifying ISP. |
| 403 | IncorrectInstanceStatus | The current status of the instance does not support this operation. | The instance is in a state that does not support the current operation. |
| 403 | InstanceLockedForSecurity | The specified operation is denied as your instance is locked for security reasons. | - |
| 403 | InstanceExpiredOrInArrears | The specified operation is denied as your prepay instance is expired (prepay mode) or in arrears (afterpay mode). | The subscription instance has expired. You must renew the instance before you can proceed. |
| 403 | OperationDenied | The operation is denied due to the instance is PrePaid. | Subscription instances do not support this operation. |
| 403 | InvalidAccountStatus.NotEnoughBalance | Your account does not have enough balance. | Your account balance is insufficient. Add funds to your account and try again. |
| 403 | InvalidInstance.UnPaidOrder | The specified Instance has unpaid order. | The specified instance has a purchase order not paid for. |
| 403 | InvalidInstance.InstanceNotSupported | The special vpc instance with eip not need bandwidth. | The instance resides in a VPC and is associated with an EIP. You cannot specify a public bandwidth for the instance. |
| 403 | InvalidInstanceStatus | The current status of the instance does not support this operation. | The instance is in a state that does not support the current operation. |
| 403 | InvalidOperation.StarterPackage | StarterPackage not support modification. | - |
| 403 | NAT_PUBLIC_IP_BINDING_FAILED | Binding nat public ip failed. | - |
| 403 | InvalidInstance.EipNotSupport | The specified instance with eip is not supported, please unassociate eip first. | The operation is not supported while an EIP is associated with the instance. Disassociate the EIP first. |
| 403 | InvalidInstance.NatPortMapNotSupport | The special instance with nat port map not support operate, please remove nat port map first. | - |
| 403 | OperationDenied.UnpaidOrder | The specified instance has unpaid order. | Your account has unpaid orders for the specified instance. You can log on to the ECS console to pay for the orders. |
| 403 | Mayi.InternalError | The request processing has failed due to some unknown error. | - |
| 403 | InvalidNetworkType.ValueNotSupported | The specified parameter NetworkType is not valid. | The specified NetworkType parameter is invalid. |
| 403 | OperationDenied.ImageNotValid | The specified image is not authorized. | You are not authorized to use this image. |
| 403 | InvalidInstanceChargeType.ValueNotSupported | The specified parameter ChargeType is not valid. | - |
| 403 | IncorrectInstanceStatus | The current status of the resource does not support this operation. | The resource is in a state that does not support the current operation. |
| 403 | InvalidIspType.ValueNotSupported | %s | - |
| 403 | UnsupportedIspChargeType | %s | - |
| 403 | UnsupportedIspClassicNetwork | %s | - |
| 403 | InvalidIspBandwidthOut | %s | - |
| 403 | UnsupportedChangeIsp | %s | - |
| 403 | InvalidIspUID | %s | - |
| 403 | UnsupportedIspRegion | %s | - |
| 403 | BandIncreaseNotSupportIsp | %s | - |
| 403 | SecurityRisk.3DVerification | We have detected a security risk with your default credit or debit card. Please proceed with verification via the link in your email. | - |
| 403 | InvalidOperation.PublicIpAddressNoStock | The public IP address for the specified Region or ChargeType of the instance is out of stock. Please try another Region or ChargeType. | Under the conditions of the specified region or payment type, the public IP address inventory of the instance is insufficient. Please try another region or payment type. |
| 404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | The specified instance does not exist. |
| 500 | InternalError | The request processing has failed due to some unknown error. | An internal error has occurred. Try again later. |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | An internal error has occurred. Try again later. |
| 500 | Image.OrderFailed | Create marketplace image order failed. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-12-02 | The Error code has changed | View Change Details |
| 2024-09-27 | The Error code has changed | View Change Details |
| 2024-09-23 | The Error code has changed | View Change Details |
| 2024-01-30 | The Error code has changed | View Change Details |
| 2024-01-08 | The Error code has changed | View Change Details |
| 2023-10-10 | The Error code has changed | View Change Details |