调用ModifyRouterInterfaceAttribute接口修改路由器接口的配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyRouterInterfaceAttribute

要执行的操作。

取值:ModifyRouterInterfaceAttribute

RegionId String cn-shanghai

路由器接口所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

RouterInterfaceId String ri-2zeo3xzyf38r4urz****

路由器接口ID。

Name String TEST

路由器接口的名称。

长度为2~128个字符,必须以字母或中文开头,可包含数字、下划线(_)和短划线(-)。

Description String 路由器接口

路由器接口的描述信息。

长度为2~256个字符,必须以字母或中文开头,但不能以http:// https://开头。

OppositeInterfaceId String ri-2zeo3xzyf38r4urz****

对端路由器接口ID。

OppositeRouterId String vrt-bp1jcg5cmxjbl9xgc****

对端路由器ID。

OppositeRouterType String VBR

要连接的对端路由器接口所属的路由器类型。取值:

  • VRouter:路由器。
  • VBR(默认值):边界路由器。
OppositeInterfaceOwnerId Long 28768383240243****

对端路由器接口的账号ID。

HealthCheckSourceIp String 116.62.XX.XX

健康检查源IP地址,必须是本端VPC内的一个未被使用的IP地址。

说明 物理专线接入场景下可指定该参数。
HealthCheckTargetIp String 116.62.XX.XX

健康检查目的IP地址。

说明 指定HealthCheckSourceIp后,该参数为必选。
HcThreshold Integer 8

健康检查阈值。单位:个。推荐值为8。表示指定健康检查时发送探测报文的个数。

HcRate Integer 2

健康检查速率。单位:秒。推荐值为2。表示指定健康检查时发送连续探测报文的时间间隔。

本示例HcThreshold设置为8HcRate设置为2,即在健康检查时每2秒从HealthCheckSourceIp(健康检查源IP地址)向HealthCheckTargetIp(健康检查目的IP地址)发送一次探测报文,如果连续8次探测报文都无响应,则健康检查失败。

DeleteHealthCheckIp Boolean false

是否删除该路由器接口上配置的健康检查IP。取值:

  • true:删除健康检查IP。
  • false(默认值):不删除健康检查IP。

返回数据

名称 类型 示例值 描述
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ModifyRouterInterfaceAttribute
&RegionId=cn-shanghai
&RouterInterfaceId=ri-2zeo3xzyf38r4urz****
&Name=TEST
&Description=路由器接口
&OppositeInterfaceId=ri-2zeo3xzyf38r4urz****
&OppositeRouterId=vrt-bp1jcg5cmxjbl9xgc****
&OppositeRouterType=VBR
&HealthCheckSourceIp=116.62.XX.XX
&HealthCheckTargetIp=116.62.XX.XX
&HcThreshold=8
&HcRate=2
&DeleteHealthCheckIp=false
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidName.Malformed The attribute name is illegal. 该名称格式不合法。
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 InvalidParam.ModifyRouterInterface Modify routerinterface param invalid 编辑路由器接口参数不合法。
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. 指定的路由器接口不存在,请您检查填写的路由器接口是否正确。

访问错误中心查看更多错误码。