DescribeRouterInterfaces - - Alibaba Cloud ドキュメントセンター

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 parameter

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeRouterInterfaces	The operation that you want to perform. Set the value to DescribeRouterInterfaces.
RegionId	String	Yes	cn-hangzhou	The region ID of the router interface. You can call the DescribeRegions operation to query the most recent region list.
IncludeReservationData	Boolean	No	false	Specifies whether renewal data is included. Valid values: true false
PageNumber	Integer	No	1	The number of the page to return. Default value: 1.
PageSize	Integer	No	10	The number of entries to return on each page. Maximum value: 50. Default value: 10.
Filter.N.Key	String	No	Filter.1.Status	The filter conditions. You can specify up to five filter conditions. The following filter conditions are supported: RouterInterfaceId: the ID of the router interface. RouterId: the ID of the router. RouterType: the router type. Valid values: VRouter and VBR. RouterInterfaceOwnerId: the ID of the Alibaba Cloud account to which the router interface belongs. OppositeInterfaceId: the ID of the peer router interface. OppositeRouterType: the type of the peer router interface. Valid values: VRouter and VBR. OppositeRouterId: the ID of the peer router. OppositeInterfaceOwnerId: the ID of the Alibaba Cloud account to which the peer router interface belongs. Status: the status of the router interface. Name: the name of the router interface. Note The logical operator between multiple values in the filter condition is OR. In this case, the filter condition is met if one of the values is matched. The logical operator between filter conditions is AND, which means that a result is returned only when all conditions are met.
Filter.N.Value.N	String	No	test	Specifies the value in the filter condition based on the key. You can specify multiple filter values for one key. The logical operator between filter values is OR. If one filter value is matched, the filter condition is matched.
ResourceGroupId	String	No	rg-acfmxazb4ph6aiy****	The ID of the resource group. For more information about resource groups, see What is a resource group?.
Tags.N.Key	String	No	FinanceDept	The key of tag N to add to the resource. You must enter at least one tag key and at most 20 tag keys. The tag key cannot be an empty string. A tag key can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.
Tags.N.Value	String	No	FinanceJoshua	The value of tag N to add to the resource. You can specify at most 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag value cannot contain `http://` or `https://`.

Response parameters

Parameter	Type	Example	Description
RequestId	String	C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45	The request ID.
PageNumber	Integer	1	The page number of the returned page. Default value: 1.
PageSize	Integer	10	The number of entries returned per page. Maximum value: 50. Default value: 10.
TotalCount	Integer	1	The number of entries returned.
RouterInterfaceSet	Array of RouterInterfaceType		The details of the router interface.
RouterInterfaceType
ReservationActiveTime	String	2021-03-11T16:00:00Z	The time when the renewal takes effect. The time follows the ISO8601 standard in the `YYYY-MM-DDThh:mmZ` format. The time is displayed in UTC.
HealthCheckTargetIp	String	116.62.XX.XX	The destination IP address that is used for the health check.
Status	String	active	The status of the router interface.
CreationTime	String	2021-06-08T12:20:55	The time when the route table was created. The time follows the ISO8601 standard in the `YYYY-MM-DDThh:mmZ` format. The time is displayed in UTC.
ReservationOrderType	String	RENEWCHANGE	The type of the renewal order. Valid values:
OppositeInterfaceId	String	ri-bp1itx13bwe6f2wfh****	The ID of the peer router interface.
Spec	String	Large	The specification of the router interface.
ChargeType	String	PayByTraffic	The metering method.
RouterInterfaceId	String	ri-2zenfgfpyu3v93koa****	The ID of the router interface.
HcThreshold	Integer	2	The health check threshold.
OppositeRouterType	String	VRouter	The type of the router to which the peer router interface belongs.
VpcInstanceId	String	vpc-2ze3tq4uxhysg717x****	The ID of the local virtual private cloud (VPC) in the peering connection.
OppositeInterfaceOwnerId	String	271598332402530847	The ID of the Alibaba Cloud account to which the peer router interface belongs.
OppositeVpcInstanceId	String	vpc-bp1qpo0kug3a20qqe****	The ID of the peer VPC.
ReservationInternetChargeType	String	PayByBandwidth	The metering method that is used after the renewal takes effect. Valid values:
CrossBorder	Boolean	false	Indicates whether the connection is a cross-border connection.
Bandwidth	Integer	10	The bandwidth of the router interface. Unit: Mbit/s.
Description	String	The description of the router interface.	The description of the router interface.
HcRate	Integer	1	The rate of heath checks.
ReservationBandwidth	String	10	The maximum bandwidth after the renewal takes effect. Unit: Mbit/s.
Name	String	test	The custom name.
OppositeRouterId	String	vrt-bp1d3bxtdv68tfd7g****	The ID of the router to which the peer router interface belongs.
OppositeInterfaceSpec	String	Large	The specification of the peer router interface.
RouterId	String	vrt-bp1d3bxtdv68tfd7g****	The ID of the router to which the route entry belongs.
OppositeInterfaceBusinessStatus	String	Normal	The service status of the peer router interface.
ConnectedTime	String	2021-06-08T12:20:55	The time when the connection was established. The time follows the ISO8601 standard in the `YYYY-MM-DDThh:mmZ` format. The time is displayed in UTC.
HealthCheckSourceIp	String	116.62.XX.XX	The source IP address that is used for the health check.
OppositeInterfaceStatus	String	Normal	The status of the peer router interface.
EndTime	String	2021-06-08T12:20:55	The end of the time range to query. The time follows the ISO8601 standard in the `YYYY-MM-DDThh:mmZ` format. The time is displayed in UTC.
OppositeRegionId	String	cn-shanghai	The region ID of the peer router interface.
OppositeAccessPointId	String	ap-cn-shanghaiSZ-****	The ID of the peer access point.
BusinessStatus	String	Normal	The service status of the router interface. Valid values: Normal FinancialLocked SecurityLocked
OppositeBandwidth	Integer	12	The maximum 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 VBR
Role	String	InitiatingSide	Indicates whether the router interface is the initiator or acceptor of the peering connection.
HasReservationData	String	false	Indicates whether renewal data is included.
AccessPointId	String	ap-cn-shanghaiSZ-****	The ID of the access point.
Ipv6Status	String	on	Indicates whether protection against malicious IPv6 traffic is enabled. Valid values: on off unsupport
FastLinkMode	Boolean	false	Indicates whether the VBR that is created in the Fast Link mode is uplinked to the router interface. The Fast Link mode helps automatically connect router interfaces that are created for the VBR and its peer VPC. Valid values: true false
ResourceGroupId	String	rg-acfmxazb4ph6aiy****	The ID of the resource group. For more information about resource groups, see What is a resource group?.
Tags	Array of Tags		The tags of the resource.
Tags
Key	String	FinanceDept	The key of tag N.
Value	String	FinanceJoshua	The value of tag N.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeRouterInterfaces
&RegionId= cn-hangzhou
&IncludeReservationData=false
&PageNumber=1
&PageSize=10
&Filter=[{"Key":"Filter.1.Status","Value":["test"]}]
&ResourceGroupId=rg-acfmxazb4ph6aiy****
&Tags=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&Common request parameters

Sample success responses

XML format

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

<DescribeRouterInterfacesResponse>
    <RequestId>C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <TotalCount>1</TotalCount>
    <RouterInterfaceSet>
        <ReservationActiveTime>2021-03-11T16:00:00Z</ReservationActiveTime>
        <HealthCheckTargetIp>116.62.XX.XX</HealthCheckTargetIp>
        <Status>active</Status>
        <CreationTime>2021-06-08T12:20:55</CreationTime>
        <ReservationOrderType>RENEWCHANGE</ReservationOrderType>
        <OppositeInterfaceId>ri-bp1itx13bwe6f2wfh****</OppositeInterfaceId>
        <Spec>Large</Spec>
        <ChargeType>PayByTraffic</ChargeType>
        <RouterInterfaceId>ri-2zenfgfpyu3v93koa****</RouterInterfaceId>
        <HcThreshold>2</HcThreshold>
        <OppositeRouterType>VRouter</OppositeRouterType>
        <VpcInstanceId>vpc-2ze3tq4uxhysg717x****</VpcInstanceId>
        <OppositeInterfaceOwnerId>271598332402530847</OppositeInterfaceOwnerId>
        <OppositeVpcInstanceId>vpc-bp1qpo0kug3a20qqe****</OppositeVpcInstanceId>
        <ReservationInternetChargeType>PayByBandwidth</ReservationInternetChargeType>
        <CrossBorder>false</CrossBorder>
        <Bandwidth>10</Bandwidth>
        <Description>RouterInterfaceDescription</Description>
        <HcRate>1</HcRate>
        <ReservationBandwidth>10</ReservationBandwidth>
        <Name>test</Name>
        <OppositeRouterId>vrt-bp1d3bxtdv68tfd7g****</OppositeRouterId>
        <OppositeInterfaceSpec>Large</OppositeInterfaceSpec>
        <RouterId>vrt-bp1d3bxtdv68tfd7g****</RouterId>
        <OppositeInterfaceBusinessStatus>Normal</OppositeInterfaceBusinessStatus>
        <ConnectedTime>2021-06-08T12:20:55</ConnectedTime>
        <HealthCheckSourceIp>116.62.XX.XX</HealthCheckSourceIp>
        <OppositeInterfaceStatus>Normal</OppositeInterfaceStatus>
        <EndTime>2021-06-08T12:20:55</EndTime>
        <OppositeRegionId>cn-shanghai</OppositeRegionId>
        <OppositeAccessPointId>ap-cn-shanghaiSZ-****</OppositeAccessPointId>
        <BusinessStatus>Normal</BusinessStatus>
        <OppositeBandwidth>12</OppositeBandwidth>
        <RouterType>VRouter</RouterType>
        <Role>InitiatingSide</Role>
        <HasReservationData>false</HasReservationData>
        <AccessPointId>ap-cn-shanghaiSZ-****</AccessPointId>
        <Ipv6Status>on</Ipv6Status>
        <FastLinkMode>false</FastLinkMode>
        <ResourceGroupId>rg-acfmxazb4ph6aiy****</ResourceGroupId>
        <Tags>
            <Key>FinanceDept</Key>
            <Value>FinanceJoshua</Value>
        </Tags>
    </RouterInterfaceSet>
</DescribeRouterInterfacesResponse>

JSON format

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

{
  "RequestId" : "C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45",
  "PageNumber" : 1,
  "PageSize" : 10,
  "TotalCount" : 1,
  "RouterInterfaceSet" : [ {
    "ReservationActiveTime" : "2021-03-11T16:00:00Z",
    "HealthCheckTargetIp" : "116.62.XX.XX",
    "Status" : "active",
    "CreationTime" : "2021-06-08T12:20:55",
    "ReservationOrderType" : "RENEWCHANGE",
    "OppositeInterfaceId" : "ri-bp1itx13bwe6f2wfh****",
    "Spec" : "Large",
    "ChargeType" : "PayByTraffic",
    "RouterInterfaceId" : "ri-2zenfgfpyu3v93koa****",
    "HcThreshold" : 2,
    "OppositeRouterType" : "VRouter",
    "VpcInstanceId" : "vpc-2ze3tq4uxhysg717x****",
    "OppositeInterfaceOwnerId" : "271598332402530847",
    "OppositeVpcInstanceId" : "vpc-bp1qpo0kug3a20qqe****",
    "ReservationInternetChargeType" : "PayByBandwidth",
    "CrossBorder" : false,
    "Bandwidth" : 10,
    "Description" : "RouterInterfaceDescription",
    "HcRate" : 1,
    "ReservationBandwidth" : "10",
    "Name" : "test",
    "OppositeRouterId" : "vrt-bp1d3bxtdv68tfd7g****",
    "OppositeInterfaceSpec" : "Large",
    "RouterId" : "vrt-bp1d3bxtdv68tfd7g****",
    "OppositeInterfaceBusinessStatus" : "Normal",
    "ConnectedTime" : "2021-06-08T12:20:55",
    "HealthCheckSourceIp" : "116.62.XX.XX",
    "OppositeInterfaceStatus" : "Normal",
    "EndTime" : "2021-06-08T12:20:55",
    "OppositeRegionId" : "cn-shanghai",
    "OppositeAccessPointId" : "ap-cn-shanghaiSZ-****",
    "BusinessStatus" : "Normal",
    "OppositeBandwidth" : 12,
    "RouterType" : "VRouter",
    "Role" : "InitiatingSide",
    "HasReservationData" : "false",
    "AccessPointId" : "ap-cn-shanghaiSZ-****",
    "Ipv6Status" : "on",
    "FastLinkMode" : false,
    "ResourceGroupId" : "rg-acfmxazb4ph6aiy****",
    "Tags" : [ {
      "Key" : "FinanceDept",
      "Value" : "FinanceJoshua"
    } ]
  } ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParam.NotNull	The parameter must not be null.	The error message returned because a required parameter is not specified.
400	Parameter.Illegal	The parameter is illegal.	The error message returned because a parameter is set to an invalid value.
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key	The error message returned because Filter.X.key is not supported.
404	InvalidRegionId.NotFound	The parameter wrong, pageNum or pageSize.	One or more parameters are invalid.

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