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. It cannot start with http:// or https://.

Description String No The router interface

The description of the router interface.

The description 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 the router to which the peer router interface belongs.

  • VRouter
  • VBR (default)
OppositeInterfaceOwnerId Long No 16880000000000000

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 VPC.

Note You can set this parameter when an Express Connect circuit is connected.
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 12

The health check threshold.

HcRate Integer No 2

The rate of heath checks.

DeleteHealthCheckIp Boolean No false

Specifies whether to delete the IP address for health check configured on the router interface.

  • true: yes
  • false: no

Response parameters

Parameter Type Sample response 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****
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

HttpCode Error code Error message Description
404 InvalidRegionId.NotFound The specified RegionId does not exist in our records. The error message returned because the specified region ID 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.
400 InvalidName.Malformd The attribute name is illeagl. The error message returned because the format of the name is invalid.
400 InvalidOppositeRouterType.ValueNotSupported The specified OppositeRouterType is not valid. The error message returned because OppositeRouterType is set to an invalid value.
400 InvalidDescription.Malformed The Description is illeagl. The error message returned because the format of the 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 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 invalide The error message returned because the value of the parameter that you set to modify the router interface is invalid.

For a list of error codes, visit the API Error Center.