Modifies the configuration of a router interface.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyRouterInterfaceAttribute

The operation that you want to perform.

Set the value to ModifyRouterInterfaceAttribute.

RegionId String Yes cn-shanghai

The ID of the region to which the router interface belongs.

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

RouterInterfaceId String Yes ri-2zeo3xzyf38r4urz****

The ID of the router interface.

Name String No TEST

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.

Description String No Router interface

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://.

OppositeInterfaceId String No ri-2zeo3xzyf38r4urz****

The ID of the peer router interface.

OppositeRouterId String No vrt-bp1jcg5cmxjbl9xgc****

The ID of the peer router.

OppositeRouterType String No VBR

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

  • VRouter: vRouter
  • VBR (default): virtual border router (VBR)
OppositeInterfaceOwnerId Long No 28768383240243****

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

HealthCheckSourceIp String No 116.62.XX.XX

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 if an Express Connect circuit is used.
HealthCheckTargetIp String No 116.62.XX.XX

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

Note This parameter is required when the HealthCheckSourceIp parameter is set.
HcThreshold Integer No 8

The health check 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.

HcRate Integer No 2000

The rate of the heath check. 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.

DeleteHealthCheckIp Boolean No false

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

  • true: yes
  • false (default): no

Response parameters

Parameter Type Example Description
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ModifyRouterInterfaceAttribute
&RegionId=cn-shanghai
&RouterInterfaceId=ri-2zeo3xzyf38r4urz****
&Name=TEST
&Description=router_interface
&OppositeInterfaceId=ri-2zeo3xzyf38r4urz****
&OppositeRouterId=vrt-bp1jcg5cmxjbl9xgc****
&OppositeRouterType=VBR
&HealthCheckSourceIp=116.62.XX.XX
&HealthCheckTargetIp=116.62.XX.XX
&HcThreshold=8
&HcRate=2000
&DeleteHealthCheckIp=false
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyRouterInterfaceAttributeResponse>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
</ModifyRouterInterfaceAttributeResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error code Error message Description
400 InvalidName.Malformed The attribute name is illegal. The error message returned because the format of the name is invalid.
400 InvalidDescription.Malformed The Description is illegal. The error message returned because the specified Description parameter is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
400 Forbbiden The Router instance owner error The error message returned because the specified router does not belong to your Alibaba Cloud account.
400 LinkRole.NotSupport This linkrole is not supported The error message returned because this link is not supported.
400 InvalidParam.ModifyRouterInterface Modify routerinterface param invalid The error message returned because a parameter is set to an invalid value.
400 IllegalParam.HcSourceIp The specified healthCheck Ip is not valid. The error message returned because the IP address used for health checks is invalid.
404 InvalidRegionId.NotFound The specified RegionId does not exist in our records. The error message returned because the ID of the specified region does not exist.
404 InvalidRouterInterfaceId.NotFound The specified RouterInterfaceId does not exist in our records. The error message returned because the specified router interface does not exist. Check whether the specified router interface is valid.

For a list of error codes, see Service error codes.