Queries the configuration of a specified router interface.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeRouterInterfaceAttribute

The operation that you want to perform. Set the value to DescribeRouterInterfaceAttribute.

RegionId String Yes cn-qingdao

The ID of the region to which the router interface belongs.

You can call the DescribeRegions operation to query the most recent region list.

InstanceId String Yes ri-m5egfc10sednwk2yt****

The ID of the router interface.

Response parameters

Parameter Type Example Description
ReservationActiveTime String 2022-06-11T16:00:00Z

The time when the renewal takes effect.

HealthCheckTargetIp String 2.2.XX.XX

The destination IP address that is used for health checks.

Status String Active

The status of the router interface. Valid values:

  • Idle: not connected
  • AcceptingConnecting: accepting a connection
  • Connecting: connecting
  • Activating: being activated
  • Active: activated
  • Modifying: being modified
  • Deactivating: being disabled
  • Inactive: disabled
  • Deleting: being deleted
CreationTime String 2022-04-14T08:57:24Z

The time when the router interface was created.

ReservationOrderType String RENEW

The type of the renewal order. The value is set to RENEW, which indicates that the order is placed for service renewal.

OppositeInterfaceId String ri-bp1xkrzttximaoxbl****

The ID of the peer router interface.

Spec String Mini.2

The specification of the router interface. Valid values:

  • Mini.2: 2 Mbit/s
  • Mini.5: 5 Mbit/s
  • Small.1: 10 Mbit/s
  • Small.2: 20 Mbit/s
  • Small.5: 50 Mbit/s
  • Middle.1: 100 Mbit/s
  • Middle.2: 200 Mbit/s
  • Middle.5: 500 Mbit/s
  • Large.1: 1,000 Mbit/s
  • Large.2: 2,000 Mbit/s
  • Large.5: 5,000 Mbit/s
  • Xlarge.1: 10,000 Mbit/s
ChargeType String AfterPay

The billing method. Valid values:

  • AfterPay: pay-as-you-go
  • PrePaid: subscription
RouterInterfaceId String ri-m5egfc10sednwk2yt****

The ID of the router interface.

Message String successful

The message returned.

HcThreshold Integer 8

The health check threshold, which is the number of probe packets that are sent during a health check. Unit: packets.

OppositeRouterType String VRouter

The type of the router to which the peer router interface belongs. Valid values:

  • VRouter: a vRouter
  • VBR: a virtual border router (VBR)
GmtModified String 2022-04-28T10:02:12Z

The time when the router interface was modified.

VpcInstanceId String vpc-bp1b49rqrybk45nio****

The ID of the virtual private cloud (VPC) to which the router interface belongs.

OppositeInterfaceOwnerId String 1321932713****

The ID of the Alibaba Cloud account to which the peer router interface belongs.

OppositeVpcInstanceId String vpc-bp1b49rqrybk45nio****

The ID of the peer VPC.

ReservationInternetChargeType String PayByBandwidth

The metering method that is used after the renewal takes effect. The value is set to PayByBandwidth, which indicates the pay-by-bandwidth metering method.

CrossBorder Boolean false

Indicates whether the connection is a cross-border connection. Valid values:

  • false: no
  • true: yes
RequestId String 01818199-04F6-47F4-9ADF-7CC824CF57A4

The ID of the request.

Bandwidth Integer 2

The bandwidth of the router interface. Unit: Mbit/s.

Description String Peer interface

The description of the router interface.

HcRate Integer 2

The rate of health checks. Unit: seconds. The value indicates the interval at which probe packets are sent during a health check.

ReservationBandwidth String 100

The bandwidth after the renewal takes effect. Unit: Mbit/s.

Code String 200

The HTTP status code returned.

Name String Router interface 1

The name of the router interface.

OppositeRouterId String vrt-bp11xvy6lb9photuu****

The ID of the router to which the peer router interface belongs.

OppositeInterfaceSpec String Negative

The specification of the peer router interface. Valid values:

  • Mini.2: 2 Mbit/s
  • Mini.5: 5 Mbit/s
  • Small.1: 10 Mbit/s
  • Small.2: 20 Mbit/s
  • Small.5: 50 Mbit/s
  • Middle.1: 100 Mbit/s
  • Middle.2: 200 Mbit/s
  • Middle.5: 500 Mbit/s
  • Large.1: 1,000 Mbit/s
  • Large.2: 2,000 Mbit/s
  • Large.5: 5,000 Mbit/s
  • Xlarge.1: 10,000 Mbit/s
  • Negative: not applicable
RouterId String vbr-m5ex0xf63xk8s5bob****

The ID of the router to which the router interface belongs.

Success Boolean true

Indicates whether the operation is successful.

OppositeInterfaceBusinessStatus String Normal

The service status of the peer router interface. Valid values:

  • Normal: normal
  • FinancialLocked: locked due to overdue payments
  • SecurityLocked: locked due to security reasons
ConnectedTime String 2022-04-14T08:58:04Z

The time when the connection is established.

HealthCheckSourceIp String 1.1.XX.XX

The source IP address that is used for health checks.

OppositeInterfaceStatus String Active

The status of the peer router interface. Valid values:

  • Idle: not connected
  • AcceptingConnecting: accepting a connection
  • Connecting: connecting
  • Activating: being activated
  • Active: activated
  • Modifying: being modified
  • Deactivating: being disabled
  • Inactive: disabled
  • Deleting: being deleted
  • Deleted: deleted
EndTime String 2999-09-08T16:00:00Z

The end of the time range queried.

OppositeRegionId String cn-hangzhou

The region ID of the peer router interface.

OppositeAccessPointId String ap-cn-qingdao-ls-B

The ID of the peer access point.

BusinessStatus String Normal

The status of the router interface. Valid values:

  • Normal: normal
  • FinancialLocked: locked due to overdue payments
  • SecurityLocked: locked due to security reasons
HealthCheckStatus String normal

The health check status. Valid values:

  • Abnormal: abnormal.
  • Normal: normal.
  • NoRedundantRoute: No redundant route is configured.
  • NoHealthCheckConfig: No health check is configured.
OppositeBandwidth Integer 0

The bandwidth of the peer router interface. Unit: Mbit/s.

RouterType String VRouter

The type of the router to which the route table belongs. Valid values:

  • VRouter: a vRouter
  • VBR: a VBR
Role String InitiatingSide

Indicates whether the router interface is the requester or the acceptor of the peering connection.

HasReservationData String false

Indicates whether renewal data is included. Valid values:

  • false: no
  • true: yes
AccessPointId String ap-cn-qingdao-ls-A

The ID of the access point.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeRouterInterfaceAttribute
&RegionId=cn-qingdao
&InstanceId=ri-m5egfc10sednwk2yt****
&Common request parameters

Sample success responses

XML format 

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> Peer interface </Description>
    <HcRate>2</HcRate>
    <ReservationBandwidth>100</ReservationBandwidth>
    <Code>200</Code>
    <Name> Router interface 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 format 

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" : "peer interface",
  "HcRate" : 2,
  "ReservationBandwidth" : "100",
  "Code" : "200",
  "Name" : "Router interface 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"
}

Error codes

HttpCode Error code Error message Description
400 InvalidParam.NotNull The parameter must not be null. The error message returned because a required parameter is not set.

For a list of error codes, visit the API Error Center.