ModifyVirtualBorderRouterAttribute - Elastic Compute Service

Note

This API has been deprecated. We recommend migrating to Vpc(2016-04-28) - ModifyVirtualBorderRouterAttribute for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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:ModifyVirtualBorderRouterAttribute

update

*VirtualBorderRouter

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the virtual border router (VBR) is deployed. To get a list of the latest regions, call the `DescribeRegions` operation.
VbrId	string	Yes	The ID of the VBR to modify.
VlanId	integer	No	The VLAN ID of the VBR. The VLAN ID must be unique on the physical connection. Valid values: 0 to 4095. A value of 0 indicates that the VBR does not use a VLAN.
CircuitCode	string	No	The circuit code of the Express Connect circuit. The circuit code is provided by your connectivity provider.
LocalGatewayIp	string	No	The local gateway IP address for the BGP session.
PeerGatewayIp	string	No	The peer gateway IP address for the BGP session.
PeeringSubnetMask	string	No	The subnet mask for the `LocalGatewayIp` and `PeerGatewayIp`.
Description	string	No	The description of the VBR. The description must be 2 to 256 characters long. It must start with a letter and cannot start with `http://` or `https://`.
Name	string	No	The name of the VBR. The name must be 2 to 128 characters long. It must start with a letter and can contain letters, digits, underscores (_), and hyphens (-).
ClientToken	string	No	A client-generated token that ensures the request is idempotent. The token must be unique for each request, contain only ASCII characters, and not exceed 64 characters in length.
UserCidr	string	No	The CIDR block of the on-premises network that is connected to the VBR.

Response elements

Element	Type	Description	Example
	object	Data returned in the response.
RequestId	string	The request ID.

Examples

Success response

JSON format

{
  "RequestId": ""
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidVbrId.NotFound	The specified VirutalBorderRouter is not found.	The specified VBR does not exist.
400	InvalidVlanId.Used	The specified VlanId has been used.	The specified VLAN ID is already used.
400	InvalidCircuitCode.Malformed	The specified CircuitCode is not valid.	The specified CircuitCode parameter is invalid.
400	InvalidVlanId.Malformed	The specified VlanId is not valid.	The specified VlanId is invalid.
400	InvalidIp.Malformed	The specified ip address is not valid.	The specified private IP address is invalid.
400	InvalidPeeringSubnetMask.Malformed	The specified PeeringSubnetMask is not valid.	The specified PeeringSubnetMask parameter is invalid.
400	InvalidName.Malformed	The specified Name is not valid.	The specified Name parameter is invalid.
400	InvalidDescription.Malformed	The specifid Description is not valid.	The resource description is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
400	MissingParameter	LocalGatewayIp, peerGatewayIp and peeringSubnetMask must not be null.
400	InvalidIp.NotSameSubnet	Local gateway ip and peer gateway ip are not in the same subnet.	The IP addresses of the local gateway and the peer gateway do not fall within the same subnet.
400	InvalidParameter	%s	The specified parameter is invalid.
400	OperationFailed.VlanIdInUse	Operation failed because vlanId is in use.
403	Forbidden.CircuitCodeNotAllowedByCaller	The caller is not allowed to modify.
403	Forbidden.LocalGatewayIpNotAllowedByCaller	The caller is not allowed to specify the LocalGatewayIp parameter.
403	Forbidden.PeerGatewayIpNotAllowedByCaller	The caller is not allowed to specify the PeerGatewayIp parameter.	You are not allowed to set the PeerGatewayIp parameter.
403	Forbidden.PeeringSubnetMaskNotAllowedByCaller	The caller is not allowed to specify the PeeringSubnetMask parameter.	You are not allowed to set the PeeringSubnetMask parameter.
403	Forbidden.VlanIdNotAllowedByCaller	The caller is not allowed to specify the VlanId.
403	Forbidden.NameNotAllowedByCaller	The caller is not allowed to specify the Name parameter.	You are not allowed to use the Name parameter.
403	Forbidden.DescriptionNotAllowedByCaller	The caller is not allowed to specify the Description parameter.	The caller is not allowed to specify the Description.
404	InvalidRegionId.NotFound	The specified RegionId is not found.	The specified RegionId parameter does not exist. Check whether the service is available in the specified region.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.