edit-icon download-icon

ModifyRouterInterfaceAttribute

Last Updated: Apr 09, 2018

Description

Modify the configurations of a router interface.

Request parameters

Name Type Required Description
Action String Yes

The action to perform.

Valid value: ModifyRouterInterfaceAttribute

RegionId String Yes

The region where the router interface is located.

You can obtain the region ID by calling the DescribeRegions API.

RouterInterfaceId String Yes The ID of the router interface.
DeleteHealthCheckIp Boolean No

Whether to delete the health check IP configured on the router interface. Valid value:

  • true: Delete the health check IP.

  • false(Default): Do not delete the health check IP.

Name String No

The name of the router interface.

The name must start with an English letter, but cannot start withhttp:// or https://.

The name can contain from 2 to 128 characters including a-z, A-Z, 0-9, underlines, and hyphens.

Description String No

The description of the router interface.

The description must start with English letters, but cannot start with http:// or https://.

The description can contain from 2 to 256 characters.

OppositeInterfaceId String No The ID of the peer router interface.
OppositeRouterId String No The ID of the peer VRouter or VBR to connect.
OppositeInterfaceOwnerId String No The account ID of the owner of the peer router interface.
HealthCheckSourceIp String No

The source IP address used to perform health check on the physical connection. It must be unused IP address of the VPC where local router interface is located.

Note: This parameter works only when creating route interfaces to establish a physical connection.

HealthCheckTargetIp String No

The destination IP address used to perform health check on the physical connection.

Note: This parameter is required when the HealthCheckSourceIp parameter is specified.

Response parameters

Name Type Description
RequestId String The ID of the request.

Error codes

See VPC API Error Center.

Examples

Request example

  1. https://vpc.aliyuncs.com/?Action=ModifyRouterInterfaceAttribute
  2. &Name=test
  3. &RouterInterfaceId=ri-2ze7fbuohm7pc3ybei8nv
  4. &RegionId=cn-hangzhou
  5. &<CommonParameters>

Response example

JSON format

  1. {
  2. "RequestId":"4EC47282-1B74-4534-BD0E-403F3EE64CAF"
  3. }
Thank you! We've received your feedback.