DescribeRouterInterfaceAttribute_专有网络_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为300/60(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
vpc:DescribeRouterInterfaceAttribute
Get
RouterInterface
acs:vpc:{#regionId}:{#accountId}:routerinterface/{#RouterInterfaceId}

请求参数

字段名称字段详情
RegionIdstring

路由器接口所属的地域 ID。展开详情

示例值:cn-qingdao参考取值来源:
    DescribeRegions
InstanceIdstring

要查询的路由器接口 ID。

示例值:ri-m5egfc10sednwk2yt****参考取值来源:
    CreateRouterInterface

返回参数

字段名称字段详情
ReservationActiveTimestring

续费生效时间。

示例值:2022-06-11T16:00:00Z
HealthCheckTargetIpstring

健康检查目标 IP。

示例值:2.2.XX.XX
Statusstring

路由器接口的状态。取值:展开详情

示例值:Active
CreationTimestring

路由器接口创建的时间。

示例值:2022-04-14T08:57:24Z
ReservationOrderTypestring

续费订单类型。取值:RENEW,表示续费订单。

示例值:RENEW
OppositeInterfaceIdstring

对端路由器接口 ID。

示例值:ri-bp1xkrzttximaoxbl****
Specstring

路由器接口的规格。取值:展开详情

示例值:Mini.2
ChargeTypestring

付费方式。取值:展开详情

示例值:AfterPay
RouterInterfaceIdstring

路由器接口的 ID。

示例值:ri-m5egfc10sednwk2yt****
Messagestring

返回信息。

示例值:successful
HcThresholdinteger<int32>

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

示例值:8
OppositeRouterTypestring

连接对端的路由器接口所属的路由器类型。取值:展开详情

示例值:VRouter
GmtModifiedstring

路由器接口修改的时间点。

示例值:2022-04-28T10:02:12Z
VpcInstanceIdstring

路由器接口所属的专有网络 ID。

示例值:vpc-bp1b49rqrybk45nio****
OppositeInterfaceOwnerIdstring

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

示例值:1321932713****
OppositeVpcInstanceIdstring

对端的 VPC ID。

示例值:vpc-bp1b49rqrybk45nio****
ReservationInternetChargeTypestring

续费付费类型。取值:PayByBandwidth,表示按使用带宽付费。

示例值:PayByBandwidth
CrossBorderboolean

是否是跨境连接。取值:展开详情

示例值:false
RequestIdstring

请求 ID。

示例值:01818199-04F6-47F4-9ADF-7CC824CF57A4
Bandwidthinteger<int32>

路由器接口带宽。单位:Mbps。

示例值:2
Descriptionstring

路由器接口描述。

示例值:对端接口
HcRateinteger<int32>

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

示例值:2
ReservationBandwidthstring

续费带宽。单位:Mbps。

示例值:100
Codestring

HTTP 返回码。

示例值:200
Namestring

路由器接口名称。

示例值:路由器接口1
OppositeRouterIdstring

连接对端的路由器接口所属的路由器 ID。

示例值:vrt-bp11xvy6lb9photuu****
OppositeInterfaceSpecstring

连接对端路由器接口的规格。取值:展开详情

示例值:Negative
RouterIdstring

路由器接口所属的路由器 ID。

示例值:vbr-m5ex0xf63xk8s5bob****
Successboolean

是否调用成功。

示例值:true
OppositeInterfaceBusinessStatusstring

连接对端的路由器接口的业务状态。取值:展开详情

示例值:Normal
ConnectedTimestring

连接建立的时间。

示例值:2022-04-14T08:58:04Z
HealthCheckSourceIpstring

健康检查源 IP。

示例值:1.1.XX.XX
OppositeInterfaceStatusstring

连接对端的路由器接口的状态。取值:展开详情

示例值:Active
EndTimestring

获取数据的结束时间点。

示例值:2999-09-08T16:00:00Z
OppositeRegionIdstring

连接对端路由器接口的地域 ID。

示例值:cn-hangzhou
OppositeAccessPointIdstring

对端接入点 ID。

示例值:ap-cn-qingdao-ls-B
BusinessStatusstring

路由器接口状态。取值:展开详情

示例值:Normal
HealthCheckStatusstring

健康检查状态。取值:展开详情

示例值:normal
OppositeBandwidthinteger<int32>

对端带宽。单位:Mbps。

示例值:0
RouterTypestring

路由表所在路由器的类型。取值:展开详情

示例值:VRouter
Rolestring

对等连接中的角色。

示例值:InitiatingSide
HasReservationDatastring

是否有续费数据。取值:展开详情

示例值:false
AccessPointIdstring

接入点 ID。

示例值:ap-cn-qingdao-ls-A
ResourceGroupIdstring

资源组 ID。展开详情

示例值:rg-acfmxazb4ph6aiy****
Tagsobject
FastLinkModestring

是否为使用快速连接模式创建的 VBR 上联路由器接口,快速连接模式可实现 VBR 和 VPC 两端路由器接口创建完毕后自动完成连接。取值:展开详情

示例值:false

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidParam.NotNull
The parameter must not be null.诊断

变更历史

变更时间变更内容概要操作
2023-07-24
变更错误码400
删除错误码404
变更返回参数
2023-07-20
变更返回参数

相关示例

RouterInterface相关操作
2021-12-09