调用ModifyRouterInterfaceAttribute接口修改路由器接口的配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vpc:ModifyRouterInterfaceAttribute | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 路由器接口所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-shanghai |
RouterInterfaceId | string | 是 | 路由器接口 ID。 | ri-2zeo3xzyf38r4urz**** |
Name | string | 否 | 路由器接口的名称。 长度为 2~128 个字符,必须以字母或中文开头,可包含数字、下划线(_)和短划线(-)。 | TEST |
Description | string | 否 | 路由器接口的描述信息。 长度为 2~256 个字符,必须以字母或中文开头,但不能以 | 路由器接口 |
OppositeInterfaceId | string | 否 | 对端路由器接口 ID。 | ri-2zeo3xzyf38r4urz**** |
OppositeRouterId | string | 否 | 对端路由器 ID。 | vrt-bp1jcg5cmxjbl9xgc**** |
OppositeRouterType | string | 否 | 要连接的对端路由器接口所属的路由器类型。取值:
| VBR |
OppositeInterfaceOwnerId | long | 否 | 对端路由器接口的账号 ID。 | 28768383240243**** |
HealthCheckSourceIp | string | 否 | 健康检查源 IP 地址,必须是本端 VPC 内的一个未被使用的 IP 地址。 说明
物理专线接入场景下可指定该参数。
| 116.62.XX.XX |
HealthCheckTargetIp | string | 否 | 健康检查目的 IP 地址。 说明
指定 HealthCheckSourceIp 后,该参数为必选。
| 116.62.XX.XX |
HcThreshold | integer | 否 | 健康检查阈值。单位:个。推荐值为 8。表示指定健康检查时发送探测报文的个数。 | 8 |
HcRate | integer | 否 | 健康检查速率。单位:毫秒。推荐值为 2000。表示指定健康检查时发送连续探测报文的时间间隔。 本示例 HcThreshold 设置为 8、HcRate 设置为 2000,即在健康检查时每 2000 毫秒从 HealthCheckSourceIp(健康检查源 IP 地址)向 HealthCheckTargetIp(健康检查目的 IP 地址)发送一次探测报文,如果连续 8 次探测报文都无响应,则健康检查失败。 | 2000 |
DeleteHealthCheckIp | boolean | 否 | 是否删除该路由器接口上配置的健康检查 IP。取值:
| false |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | 参数OppositeRouterType的值不合法。 |
400 | InvalidDescription.Malformed | The Description is illegal. | 指定的资源描述格式不合法。长度为2-256个字符,不能以http://和https://开头。 |
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 | InvalidParam.ModifyRouterInterface | Modify routerinterface health check source ip invalid | - |
400 | InvalidParam.ModifyRouterInterface | healthCheck Ip is conflicted with DeleteHealthCheckIp option | - |
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. | 健康检查IP不合法。 |
400 | OperationFailed.OperationLocked | Operation failed because OperationLocked. | 操作失败因为实例已经被运维锁定。 |
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. | 指定的RegionId不存在。 |
404 | InvalidRouterInterfaceId.NotFound | The specified RouterInterfaceId does not exist in our records. | 指定的路由器接口不存在,请您检查填写的路由器接口是否正确。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-06-13 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-12-21 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更 | 查看变更详情 |
2021-11-17 | OpenAPI 错误码发生变更 | 查看变更详情 |
2021-11-17 | OpenAPI 错误码发生变更 | 查看变更详情 |