All Products
Document Center

Virtual Private Cloud:ModifyRouterInterfaceAttribute

Last Updated:Nov 29, 2023

Modifies the configuration of a router interface.


You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.


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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
  • RouterInterface
  • vpc:TargetAccountRDId

Request parameters


The region ID of the router interface.

You can call the DescribeRegions operation to query the most recent region list.


The ID of the router interface.


The name of the router interface.

The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.


The description of the router interface.

The value must be 2 to 256 characters in length. It must start with a letter but cannot start with http:// or https://.


The ID of the peer router interface.


The ID of the peer router.


The type of router to which the peer router interface belongs. Valid values:

  • VRouter
  • VBR (default)

The ID of the Alibaba Cloud account to which the peer router interface belongs.


The source IP address that is used to perform health checks. The source IP address must be an idle IP address of the local virtual private cloud (VPC).

Note You can set this parameter when an Express Connect circuit is used.

The destination IP address that is used to perform health checks.

Note This parameter is required when HealthCheckSourceIp is specified.

The healthy threshold. Unit: packets. We recommend that you set the value to 8. This value specifies the number of probe packets that are sent during a health check.


The rate of health checks. Unit: milliseconds. The recommended value is 2000. This value specifies the interval at which probe packets are sent during a health check.

In this example, HcThreshold is set to 8 and HcRate is set to 2000. In this example, probe packets are sent from HealthCheckSourceIp (source address) to HealthCheckTargetIp (destination address) every 2,000 seconds. If no response is returned for eight consecutive times, the health check fails.


Specifies whether to delete the health check IP addresses configured on the router interface. Valid values:

  • true
  • false (default)

Response parameters


The request ID.


The request ID.



Sample success responses


  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF"

Error codes

HTTP status codeError codeError messageDescription
400IncorrectStatusRouterInterface can be operated by this action only when the status is Active,idle or inactive.This operation is supported only when a router interface is in the Active, Idle, or Inactive state.
400Forbidden.FinancialLockedThis RouterInterface is financiel locked because of bills outstanding.-
400InvalidName.MalformedThe attribute name is illegal.-
400InvalidOppositeRouterType.ValueNotSupportedThe specified OppositeRouterType is not valid.The value of the OppositeRouterType parameter is invalid.
400InvalidDescription.MalformedThe Description is illegal.-
400ForbbidenThe Router instance owner error-
400LinkRole.NotSupportThis linkrole is not supportedThis link is not supported.
400Forbbiden.ModifyIdAndTypeOpposite is VBR, cannot modify the ID and type-
400InvalidParam.ModifyRouterInterfaceModify routerinterface param invalid-
400InvalidParam.ModifyRouterInterfaceModify routerinterface health check source ip invalid-
400InvalidParam.ModifyRouterInterfacehealthCheck Ip is conflicted with DeleteHealthCheckIp option-
400INSTANCE_IN_PROCESSIONGInstance is in processing,please wait and try again-
400InvalidHealthCheckIP.MalformdHealthcheck sourceip or targetip is not valid.-
400IllegalParam.HcSourceIpThe specified healthCheck Ip is not valid.The IP address used for health checks is invalid.
404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.The specified region ID does not exist.
404InvalidRouterInterfaceId.NotFoundThe specified RouterInterfaceId does not exist in our records.The specified router interface does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2021-11-17The error codes of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    Error Codes 400 change
    delete Error Codes: 404
2021-11-17The error codes of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    Error Codes 400 change
    delete Error Codes: 404