UpdateVirtualBorderBandwidth-阿里云帮助中心

Calls the UpdateVirtualBorderBandwidth operation to update the bandwidth throttling for both the upstream and downstream routing directions on a Virtual Border Router (VBR).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:UpdateVirtualBorderBandwidth

update

*VirtualBorderRouter

acs:vpc:*:{#accountId}:virtualborderrouter/{#VirtualBorderRouterId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the VBR. You can call the DescribeRegions operation to query region IDs.	cn-shanghai
VirtualBorderRouterId	string	Yes	The instance ID of the VBR.	vbr-bp15zckdt37pq72****
Bandwidth	integer	Yes	The new bandwidth limit of the VBR. Unit: Mbit/s.	2
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 ClientToken value can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request is different.	02fb3da4-130e-11e9-8e44-0016****

Response elements

Element	Type	Description	Example
	object
Code	string	The response code.	200
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The response message.	successful
RequestId	string	The request ID.	AA4486A8-B6AE-469E-AB09-820EF8ECFA2B
Success	boolean	Indicates whether the modification was successful. Valid values: true: Successful. false: Failed.	true

Examples

Success response

JSON format

{
  "Code": "200",
  "HttpStatusCode": 200,
  "Message": "successful",
  "RequestId": "AA4486A8-B6AE-469E-AB09-820EF8ECFA2B",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationFailed.Vpconn	The operation is failed because of Vpconn.	You cannot set the Vpconn parameter.
400	MissingParam.InstanceId	Missing param of InstanceId.	The InstanceId parameter is not set.
400	InvalidInstanceId.NotFound	InstanceId not found.	The InstanceId is set to an invalid value.
400	MissingParam.Bandwidth	Missing param of Bandwidth.	The Bandwidth parameter is not set.
400	IllegalParam.Bandwidth	Illegal Param of Bandwidth.	The Bandwidth parameter is set to an invalid value.
400	MissingParam.regionNo	Missing param of regionNo.
400	QuotaExceeded.VirtualBorderRouterBandwidth	Quota Exceeded of VirtualBorderRouterBandwidth	The bandwidth of the VBR exceeds the upper limit.
400	OperationUnsupported.SetMultiPconnBandwidth	Set Multi PhysicalConnection Bandwidth Unsupported.	Bandwidth for multiple Express Connect circuits is not supported.
400	OperationUnsupported.ModifyBandwidth	Modify Sale VirtualBorderRouter Bandwidth Unsupported.	You cannot save the modified bandwidth parameter.
400	OperationFailed.PconnTrafficNotEnable	The operation is failed because of PconnTrafficNotEnable.	Billing for outbound data transfer is disabled.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.