Modifies the configurations 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 where the router interface is deployed. You can call the DescribeRegions operation to query region IDs.

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 digits, periods (.), underscores (_), and hyphens (-). The name cannot start with http:// or https://.

Description String No Router interfaces

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 VRouter

The type of the router to which the peer router interface belongs. Default value: VBR.

Valid values: VRouter and VBR.

OppositeInterfaceOwnerId Long No 10

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

HealthCheckSourceIp String No 116.62.222.XX

The source IP address that is used to perform health checks. It must be an idle IP address of the local VPC.

Note You can set this parameter when a physical connection is connected.
HealthCheckTargetIp String No 116.62.222.XX

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

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

The health check threshold.

HcRate Integer No 2

The rate of heath checks.

DeleteHealthCheckIp Boolean No true

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

  • true: deletes the IP address for health checks.
  • false: does not delete the IP addresses. This is the default value.

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****
&<Common request parameters>

Sample success responses

XML format

<ModifyRouterInterfaceAttributeResponse>
      <RequestId>980960B0-2969-40BF-8542-EBB34FD358AB</RequestId>
</ModifyRouterInterfaceAttributeResponse>

JSON format

{ 
    "RequestId": "980960B0-2969-40BF-8542-EBB34FD358AB"
}

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. Check whether the service is available in the region.
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 specified 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 specified 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.