Modifies the attributes of a router interface, such as the name, description, peer connection, and health check settings.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID of the router interface. You can call the DescribeRegions operation to query available regions. |
cn-shanghai |
| RouterInterfaceId |
string |
Yes |
The ID of the router interface. |
ri-2zeo3xzyf38r4urz**** |
| Name |
string |
No |
The name of the router interface. The name must be 2 to 128 characters in length and can contain letters, digits, underscores (_), and hyphens (-). It must start with a letter. |
TEST |
| Description |
string |
No |
The description of the router interface. The description must be 2 to 256 characters in length. It must start with a letter and cannot start with |
路由器接口 |
| OppositeInterfaceId |
string |
No |
The ID of the peer router interface. |
ri-2zeo3xzyf38r4urz**** |
| OppositeRouterId |
string |
No |
The ID of the peer router. |
vrt-bp1jcg5cmxjbl9xgc**** |
| OppositeRouterType |
string |
No |
The type of the peer router. Valid values:
|
VBR |
| OppositeInterfaceOwnerId |
integer |
No |
The ID of the Alibaba Cloud account that owns the peer router interface. |
28768383240243**** |
| HealthCheckSourceIp |
string |
No |
The source IP address for health checks. Must be an idle IP address in the local VPC. Note
Available when an Express Connect circuit is used. |
116.62.XX.XX |
| HealthCheckTargetIp |
string |
No |
The destination IP address for health checks. Note
This parameter is required when HealthCheckSourceIp is specified. |
116.62.XX.XX |
| HcThreshold |
integer |
No |
The health check threshold. Unit: packets. Recommended value: 8. The number of probe packets sent per health check. |
8 |
| HcRate |
integer |
No |
The health check interval. Unit: milliseconds. Recommended value: 2000. The interval between probe packets during a health check. If HcThreshold is 8 and HcRate is 2000, probe packets are sent from HealthCheckSourceIp to HealthCheckTargetIp every 2,000 seconds. If no response is returned eight consecutive times, the health check fails. |
2000 |
| DeleteHealthCheckIp |
boolean |
No |
Specifies whether to delete the health check IP addresses from the router interface. Valid values:
|
false |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The request ID. |
||
| RequestId |
string |
The request ID. |
4EC47282-1B74-4534-BD0E-403F3EE64CAF |
Examples
Success response
JSON format
{
"RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF"
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | Forbidden.FinancialLocked | This RouterInterface is financiel locked because of bills outstanding. | |
| 400 | InvalidName.Malformed | The attribute name is illegal. | |
| 400 | InvalidOppositeRouterType.ValueNotSupported | The specified OppositeRouterType is not valid. | The value of the OppositeRouterType parameter is invalid. |
| 400 | InvalidDescription.Malformed | The Description is illegal. | |
| 400 | Forbbiden | The Router instance owner error | |
| 400 | LinkRole.NotSupport | This linkrole is not supported | |
| 400 | Forbbiden.ModifyIdAndType | Opposite is VBR, cannot modify the ID and type | |
| 400 | InvalidParam.ModifyRouterInterface | Modify routerinterface param invalid | |
| 400 | INSTANCE_IN_PROCESSIONG | Instance is in processing,please wait and try again | |
| 400 | IllegalParam.HcThreshold | %s | |
| 400 | IllegalParam.HcRate | %s | |
| 400 | InvalidHealthCheckIP.Malformd | Healthcheck sourceip or targetip is not valid. | |
| 400 | IllegalParam.HcSourceIp | The specified healthCheck Ip is not valid. | The IP address used for health checks is invalid. |
| 400 | OperationFailed.OperationLocked | Operation failed because OperationLocked. | The operation failed because the instance is locked due to O&M. |
| 400 | IncorrectStatus.RouterInterface | This openeration would not be allowed because status of this RouterInterface is not correct. | |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | |
| 404 | InvalidRouterInterfaceId.NotFound | The specified RouterInterfaceId does not exist in our records. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.