调用DescribeRouterInterfaceAttribute接口查看路由器接口的配置。

调试

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

请求参数

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

系统规定参数。取值：DescribeRouterInterfaceAttribute。

RegionId String 是 cn-qingdao

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

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

InstanceId String 是 ri-m5egfc10sednwk2yt****

要查询的路由器接口ID。

返回数据

名称 类型 示例值 描述
ReservationActiveTime String 2022-06-11T16:00:00Z

续费生效时间。
HealthCheckTargetIp String 2.2.XX.XX

健康检查目标IP。
Status String Active

路由器接口的状态。取值：

  • Idle：未连接
  • AcceptingConnecting：接受连接中
  • Connecting： 连接中
  • Activating：激活中
  • Active：已激活
  • Modifying： 修改中
  • Deactivating：冻结中
  • Inactive：已冻结
  • Deleting：删除中
CreationTime String 2022-04-14T08:57:24Z

路由器接口创建的时间。
ReservationOrderType String RENEW

续费订单类型。取值：RENEW，表示续费订单。

OppositeInterfaceId String ri-bp1xkrzttximaoxbl****

对端路由器接口ID。
Spec String Mini.2

路由器接口的规格。取值：

  • Mini.2：2 Mbps
  • Mini.5：5 Mbps
  • Small.1：10 Mbps
  • Small.2：20 Mbps
  • Small.5：50 Mbps
  • Middle.1：100 Mbps
  • Middle.2：200 Mbps
  • Middle.5：500 Mbps
  • Large.1：1000 Mbps
  • Large.2：2000 Mbps
  • Large.5：5000 Mbps
  • Xlarge.1：10000 Mbps
ChargeType String AfterPay

付费方式。取值：

  • AfterPay：后付费
  • PrePaid：预付费
RouterInterfaceId String ri-m5egfc10sednwk2yt****

路由器接口的ID。
Message String successful

返回信息。
HcThreshold Integer 8

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

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

  • VRouter：VPC路由器
  • VBR：边界路由器
GmtModified String 2022-04-28T10:02:12Z

路由器接口修改的时间点。
VpcInstanceId String vpc-bp1b49rqrybk45nio****

路由器接口所属的专有网络ID。
OppositeInterfaceOwnerId String 1321932713****

对端路由器接口的账号ID。
OppositeVpcInstanceId String vpc-bp1b49rqrybk45nio****

对端的VPC ID。
ReservationInternetChargeType String PayByBandwidth

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

CrossBorder Boolean false

是否是跨境连接。取值：

  • false：不是
  • true：是
RequestId String 01818199-04F6-47F4-9ADF-7CC824CF57A4

请求ID。
Bandwidth Integer 2

路由器接口带宽。单位：Mbps。
Description String 对端接口

路由器接口描述。
HcRate Integer 2

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

续费带宽。单位：Mbps。
Code String 200

HTTP返回码。
Name String 路由器接口1

路由器接口名称。
OppositeRouterId String vrt-bp11xvy6lb9photuu****

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

连接对端路由器接口的规格。取值：

  • Mini.2：2 Mbps
  • Mini.5：5 Mbps
  • Small.1：10 Mbps
  • Small.2：20 Mbps
  • Small.5：50 Mbps
  • Middle.1：100 Mbps
  • Middle.2：200 Mbps
  • Middle.5：500 Mbps
  • Large.1：1000 Mbps
  • Large.2：2000 Mbps
  • Large.5：5000 Mbps
  • Xlarge.1：10000 Mbps
  • Negative：不涉及规格
RouterId String vbr-m5ex0xf63xk8s5bob****

路由器接口所属的路由器ID。
Success Boolean true

是否调用成功。
OppositeInterfaceBusinessStatus String Normal

连接对端的路由器接口的业务状态。取值：

  • Normal：正常
  • FinancialLocked：欠费锁定
  • SecurityLocked：安全风控锁定
ConnectedTime String 2022-04-14T08:58:04Z

连接建立的时间。
HealthCheckSourceIp String 1.1.XX.XX

健康检查源IP。
OppositeInterfaceStatus String Active

连接对端的路由器接口的状态。取值：

  • Idle：未连接
  • AcceptingConnecting：接受连接中
  • Connecting： 连接中
  • Activating：激活中
  • Active：已激活
  • Modifying： 修改中
  • Deactivating：冻结中
  • Inactive：已冻结
  • Deleting：删除中
  • Deleted：已删除
EndTime String 2999-09-08T16:00:00Z

获取数据的结束时间点。
OppositeRegionId String cn-hangzhou

连接对端路由器接口的地域ID。
OppositeAccessPointId String ap-cn-qingdao-ls-B

对端接入点ID。
BusinessStatus String Normal

路由器接口状态。取值：

  • Normal：正常
  • FinancialLocked：欠费锁定
  • SecurityLocked：安全风控锁定
HealthCheckStatus String normal

健康检查状态。取值：

  • Abnormal：状态异常
  • Normal：正常
  • NoRedundantRoute：未配置冗余路由
  • NoHealthCheckConfig：未配置健康检查
OppositeBandwidth Integer 0

对端带宽。单位：Mbps。
RouterType String VRouter

路由表所在路由器的类型。取值：

  • VRouter：VPC路由器
  • VBR：边界路由器
Role String InitiatingSide

对等连接中的角色。
HasReservationData String false

是否有续费数据。取值：

  • false：没有
  • true：有
AccessPointId String ap-cn-qingdao-ls-A

接入点ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeRouterInterfaceAttribute
&RegionId=cn-qingdao
&InstanceId=ri-m5egfc10sednwk2yt****
&公共请求参数

正常返回示例

XML格式 

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

<DescribeRouterInterfaceAttributeResponse>
    <ReservationActiveTime>2022-06-11T16:00:00Z</ReservationActiveTime>
    <HealthCheckTargetIp>2.2.XX.XX</HealthCheckTargetIp>
    <Status>Active</Status>
    <CreationTime>2022-04-14T08:57:24Z</CreationTime>
    <ReservationOrderType>RENEW</ReservationOrderType>
    <OppositeInterfaceId>ri-bp1xkrzttximaoxbl****</OppositeInterfaceId>
    <Spec>Mini.2</Spec>
    <ChargeType>AfterPay</ChargeType>
    <RouterInterfaceId>ri-m5egfc10sednwk2yt****</RouterInterfaceId>
    <Message>successful</Message>
    <HcThreshold>8</HcThreshold>
    <OppositeRouterType>VRouter</OppositeRouterType>
    <GmtModified>2022-04-28T10:02:12Z</GmtModified>
    <VpcInstanceId>vpc-bp1b49rqrybk45nio****</VpcInstanceId>
    <OppositeInterfaceOwnerId>1321932713****</OppositeInterfaceOwnerId>
    <OppositeVpcInstanceId>vpc-bp1b49rqrybk45nio****</OppositeVpcInstanceId>
    <ReservationInternetChargeType>PayByBandwidth</ReservationInternetChargeType>
    <CrossBorder>false</CrossBorder>
    <RequestId>01818199-04F6-47F4-9ADF-7CC824CF57A4</RequestId>
    <Bandwidth>2</Bandwidth>
    <Description>对端接口</Description>
    <HcRate>2</HcRate>
    <ReservationBandwidth>100</ReservationBandwidth>
    <Code>200</Code>
    <Name>路由器接口1</Name>
    <OppositeRouterId>vrt-bp11xvy6lb9photuu****</OppositeRouterId>
    <OppositeInterfaceSpec>Negative</OppositeInterfaceSpec>
    <RouterId>vbr-m5ex0xf63xk8s5bob****</RouterId>
    <Success>true</Success>
    <OppositeInterfaceBusinessStatus>Normal</OppositeInterfaceBusinessStatus>
    <ConnectedTime>2022-04-14T08:58:04Z</ConnectedTime>
    <HealthCheckSourceIp>1.1.XX.XX</HealthCheckSourceIp>
    <OppositeInterfaceStatus>Active</OppositeInterfaceStatus>
    <EndTime>2999-09-08T16:00:00Z</EndTime>
    <OppositeRegionId>cn-hangzhou</OppositeRegionId>
    <OppositeAccessPointId>ap-cn-shanghaiSZ-xxxx</OppositeAccessPointId>
    <BusinessStatus>Normal</BusinessStatus>
    <HealthCheckStatus>normal</HealthCheckStatus>
    <OppositeBandwidth>0</OppositeBandwidth>
    <RouterType>VRouter</RouterType>
    <Role>InitiatingSide</Role>
    <HasReservationData>false</HasReservationData>
    <AccessPointId>ap-cn-qingdao-ls-A</AccessPointId>
</DescribeRouterInterfaceAttributeResponse>

JSON格式 

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

{
  "ReservationActiveTime" : "2022-06-11T16:00:00Z",
  "HealthCheckTargetIp" : "2.2.XX.XX",
  "Status" : "Active",
  "CreationTime" : "2022-04-14T08:57:24Z",
  "ReservationOrderType" : "RENEW",
  "OppositeInterfaceId" : "ri-bp1xkrzttximaoxbl****",
  "Spec" : "Mini.2",
  "ChargeType" : "AfterPay",
  "RouterInterfaceId" : "ri-m5egfc10sednwk2yt****",
  "Message" : "successful",
  "HcThreshold" : 8,
  "OppositeRouterType" : "VRouter",
  "GmtModified" : "2022-04-28T10:02:12Z",
  "VpcInstanceId" : "vpc-bp1b49rqrybk45nio****",
  "OppositeInterfaceOwnerId" : "1321932713****",
  "OppositeVpcInstanceId" : "vpc-bp1b49rqrybk45nio****",
  "ReservationInternetChargeType" : "PayByBandwidth",
  "CrossBorder" : false,
  "RequestId" : "01818199-04F6-47F4-9ADF-7CC824CF57A4",
  "Bandwidth" : 2,
  "Description" : "对端接口",
  "HcRate" : 2,
  "ReservationBandwidth" : "100",
  "Code" : "200",
  "Name" : "路由器接口1",
  "OppositeRouterId" : "vrt-bp11xvy6lb9photuu****",
  "OppositeInterfaceSpec" : "Negative",
  "RouterId" : "vbr-m5ex0xf63xk8s5bob****",
  "Success" : true,
  "OppositeInterfaceBusinessStatus" : "Normal",
  "ConnectedTime" : "2022-04-14T08:58:04Z",
  "HealthCheckSourceIp" : "1.1.XX.XX",
  "OppositeInterfaceStatus" : "Active",
  "EndTime" : "2999-09-08T16:00:00Z",
  "OppositeRegionId" : "cn-hangzhou",
  "OppositeAccessPointId" : "ap-cn-shanghaiSZ-xxxx",
  "BusinessStatus" : "Normal",
  "HealthCheckStatus" : "normal",
  "OppositeBandwidth" : 0,
  "RouterType" : "VRouter",
  "Role" : "InitiatingSide",
  "HasReservationData" : "false",
  "AccessPointId" : "ap-cn-qingdao-ls-A"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParam.NotNull The parameter must not be null. 参数不能为空。

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