ModifyRouterInterfaceAttribute - Elastic Compute Service

Modifies the attributes of a router interface.

Note

This API has been deprecated. We recommend migrating to Vpc(2016-04-28) - ModifyRouterInterfaceAttribute 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:ModifyRouterInterfaceAttribute

update

*RouterInterface

acs:vpc:{#regionId}:{#accountId}:routerinterface/{#RouterInterfaceId}

vpc:TargetAccountRDId

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the router interface is deployed.
RouterInterfaceId	string	Yes	The ID of the router interface that you want to modify.
Name	string	No	The new name of the router interface. The name must be 2 to 128 characters long and can contain letters, digits, underscores (_), and hyphens (-). It must start with a letter.
Description	string	No	The new description of the router interface. The description must be 2 to 256 characters long and cannot start with `http://` or `https://`.
OppositeInterfaceId	string	No	The ID of the opposite router interface.
OppositeRouterId	string	No	The ID of the opposite router.
OppositeRouterType	string	No	The type of the opposite router. Valid values: `VRouter` and `VBR`. The default value is `VRouter`.
OppositeInterfaceOwnerId	integer	No	The ID of the Alibaba Cloud account that owns the opposite router interface.
HealthCheckSourceIp	string	No	The source IP address used for the health check.
HealthCheckTargetIp	string	No	The destination IP address used for the health check.

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The ID of the request.

Examples

Success response

JSON format

{
  "RequestId": ""
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectStatus	RouterInterface can be operated by this action only when the status is Active,idle or inactive.
400	Forbidden.FinancialLocked	This RouterInterface is financiel locked because of bills outstanding.
400	InvalidName.Malformd	The attribute name is illeagl.	The attribute name is invalid.
400	InvalidOppositeRouterType.ValueNotSupported	The specified OppositeRouterType is not valid.	The specified OppositeRouterType parameter is invalid.
400	InvalidDescription.Malformed	The Description is illeagl.	The specified resource description is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
400	Forbbiden	The Router instance owener error
400	LinkRole.NotSupport	This linkrole is not supported	The specified link role is not supported.
400	Forbbiden.ModifyIdAndType	Opposite is VBR, cannot modify the ID and type
400	InvalidParam.ModifyRouterInterface	Modify routerinterface param invalid
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	The specified RegionId parameter does not exist. Check whether the service is available in the specified region.
404	InvalidRouterInterfaceId.NotFound	The specified RouterInterfaceId does not exist in our records.	The specified router interface does not exist. Check whether the router interface ID is valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.