You can call this operation to query 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 ModifyRouterInterfaceAttribute.

InstanceId String Yes ri-bp19r6f6xxxx

The ID of the router interface.

RegionId String Yes cn-hangzhu

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

Response parameters

Parameter Type Example Description
AccessPointId String ap-cn-hangzhou-xs-B

The ID of the access point.

Bandwidth Integer 1000

The bandwidth of the router interface.

BusinessStatus String Normal

The operational status of the router interface. Valid values:

  • Normal: normal
  • FinancialLocked: locked due to overdue payments
  • SecurityLocked: locked for security protection
ChargeType String PayByTraffic

The billing method.

Code String 200

The returned HTTP status code.

ConnectedTime String 2018-05-28T08:16:03Z

The time when the connection was established.

CreationTime String 2018-05-28T08:15:00Z

The time when the router interface was created.

CrossBorder Boolean false

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

  • false: no
  • true: yes
Description String Peer router interface

The description of the router interface.

EndTime String 2999-09-08T16:00:00Z

The end of the time range where data is retrieved.

GmtModified String 2018-05-28T08:16:03Z

The time when the router interface was modified.

HasReservationData String false

Indicates whether renewal data is retrieved. Valid values:

  • false: no
  • true: yes
HcRate Integer 1

The rate of heath checks.

HcThreshold Integer 2

The health check threshold.

HealthCheckSourceIp String 1.1.1.1

The source IP address specified for health checks.

HealthCheckStatus String normal

The status of health checks.

HealthCheckTargetIp String 2.2.2.2

The destination IP address specified for health checks.

Message String successful

The message returned.

Name String Router interface 1

The name of the router interface.

OppositeAccessPointId String ap-cn-shanghaiSZ-xxxx

The ID of the peer access point.

OppositeBandwidth Integer 1000

The bandwidth of the peer router interface.

OppositeInterfaceBusinessStatus String Normal

The status of the peer router interface.

OppositeInterfaceId String ri-bp1itx13bwe6f2wfxxxx

The ID of the peer router interface.

OppositeInterfaceOwnerId String 123157908552xxx

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

OppositeInterfaceSpec String Negative

The specification of the peer router interface.

OppositeInterfaceStatus String Normal

The operational status of the peer router interface.

OppositeRegionId String cn-shanghai

The region where the peer router interface is located.

OppositeRouterId String vrt-bp1d3bxtdv68tfdxxxx

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

OppositeRouterType String VRouter

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

OppositeVpcInstanceId String vpc-bp1qpo0kug3a20qqxxxx

The ID of the Virtual Private Cloud (VPC) network to which the peer router interface belongs.

RequestId String 01818199-04F6-47F4-9ADF-7CC824CF57A4

The request ID.

ReservationActiveTime String 2019-03-11T16:00:00Z

The time when the renewal took effect.

ReservationBandwidth String 100

The bandwidth after the renewal takes effect.

ReservationInternetChargeType String PayByBandwidth

The billing method after the renewal takes effect.

ReservationOrderType String RENEWCHANGE

The type of the renewal order.

Role String InitiatingSide

The role of the router interface in the peering connection.

RouterId String vrt-bp1d3bxtdv68tfd7xxxx

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

RouterInterfaceId String ri-2zenfgfpyu3v93koxxxx

The ID of the router interface.

RouterType String VRouter

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

  • VRouter
  • VBR
Spec String Large

The specification of the router interface.

Status String active

The status of the router interface.

Success Boolean true

Indicates whether the request is successful.

VpcInstanceId String vpc-bp1btrvfk2zhg1fc2xxx

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

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeRouterInterfaceAttribute
&InstanceId=ri-bp19r6f6xxxx
&RegionId=cn-hangzhu
&<Common request parameters>

Sample success responses

XML format

<DescribeRouterInterfaceAttributeResponse>
    <HasReservationData>false</HasReservationData>
    <OppositeInterfaceStatus>Active</OppositeInterfaceStatus>
    <CrossBorder>false</CrossBorder>
    <Code>200</Code>
    <GmtModified>2018-05-28T08:16:03Z</GmtModified>
    <OppositeRouterId>vrt-bp1egep8g1jlfmez8xxxx</OppositeRouterId>
    <OppositeRouterType>VRouter</OppositeRouterType>
    <OppositeInterfaceId>ri-bp1w7qvb812vv1dicxxxx</OppositeInterfaceId>
    <RouterId>vbr-bp1qg7vzlr2kjeakxxxx</RouterId>
    <BusinessStatus>Normal</BusinessStatus>
    <OppositeRegionId>cn-hangzhou</OppositeRegionId>
    <OppositeBandwidth>0</OppositeBandwidth>
    <AccessPointId>ap-cn-hangzhou-xs-B</AccessPointId>
    <Bandwidth>1000</Bandwidth>
    <ChargeType>AfterPay</ChargeType>
    <OppositeInterfaceBusinessStatus>Normal</OppositeInterfaceBusinessStatus>
    <RouterInterfaceId>ri-bp19r6f6x3u092ma5xxx</RouterInterfaceId>
    <Message>successful</Message>
    <Spec>Large.1</Spec>
    <OppositeInterfaceOwnerId>195410512258xxxx</OppositeInterfaceOwnerId>
    <Success>true</Success>
    <CreationTime>2018-05-28T08:15:00Z</CreationTime>
    <OppositeInterfaceSpec>Negative</OppositeInterfaceSpec>
    <RouterType>VBR</RouterType>
    <Status>Active</Status>
    <ConnectedTime>2018-05-28T08:16:03Z</ConnectedTime>
    <HealthCheckStatus>NoHealthCheckConfig</HealthCheckStatus>
    <RequestId>9EFF1A02-5843-4E4B-95F5-7549F97447DB</RequestId>
    <Role>InitiatingSide</Role>
    <OppositeVpcInstanceId>vpc-bp1btrvfk2zhg1fcxxx</OppositeVpcInstanceId>
    <EndTime>2999-09-08T16:00:00Z</EndTime>
<DescribeRouterInterfaceAttributeResponse>

JSON format

{
	"HasReservationData": false,
	"OppositeInterfaceStatus": "Active",
	"CrossBorder": false,
	"Code": "200",
	"GmtModified": "2018-05-28T08:16:03Z",
	"OppositeRouterId": "vrt-bp1egep8g1jlfmez8xxxx",
	"OppositeRouterType": "VRouter",
	"OppositeInterfaceId": "ri-bp1w7qvb812vv1dicxxxx",
	"RouterId": "vbr-bp1qg7vzlr2kjeakxxxx",
	"BusinessStatus": "Normal",
	"OppositeRegionId": "cn-hangzhou",
	"OppositeBandwidth": 0,
	"AccessPointId": "ap-cn-hangzhou-xs-B",
	"Bandwidth": 1000,
	"ChargeType": "AfterPay",
	"OppositeInterfaceBusinessStatus": "Normal",
	"RouterInterfaceId": "ri-bp19r6f6x3u092ma5xxx",
	"Message": "successful",
	"Spec": "Large.1",
	"OppositeInterfaceOwnerId": "195410512258xxxx",
	"Success": true,
	"CreationTime": "2018-05-28T08:15:00Z",
	"OppositeInterfaceSpec": "Negative",
	"RouterType": "VBR",
	"Status": "Active",
	"ConnectedTime": "2018-05-28T08:16:03Z",
	"HealthCheckStatus": "NoHealthCheckConfig",
	"RequestId": "9EFF1A02-5843-4E4B-95F5-7549F97447DB",
	"Role": "InitiatingSide",
	"OppositeVpcInstanceId": "vpc-bp1btrvfk2zhg1fcxxx",
	"EndTime": "2999-09-08T16:00:00Z"
}

Error codes

HttpCode Error code Error message Description
400 InvalidParam.NotNull The parameter must not be null. The required parameters must not be empty.

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