リージョン内の 1 つ以上のルーターインターフェイスを照会します。

次のフィルターを使用することで、結果を絞り込むことができます。 フィルターの値の関係は "or" です。 フィルターの条件が 1 つ満たされていれば、ルーターインターフェイスが返されます。 フィルター間の関係は ”and” です。 ルーターインターフェイスは、フィルターの条件がすべて満たされた場合にのみ返されます。

  • RouterInterfaceId：ルーターインターフェイスの ID。
  • RouterId ：ルーターのID。
  • RouterType ：ルーターのタイプ。 有効な値： VRouter | VBR 。
  • RouterInterfaceOwnerId ：ルーターインターフェイスが属するアカウントの ID。
  • OppositeInterfaceId：接続先ルーターインターフェイスの ID 。
  • OppositeRouterType ：接続先ルータインターフェイスのタイプ。 有効な値： VRouter | VBR 。
  • OppositeRouterId ：接続先ルーターインターフェイスの ID。
  • OppositeInterfaceOwnerId ：接続先ルーターインターフェイスが属するアカウントの ID。
  • Status：ルーターインターフェイスのステータス。
  • Name：ルーターインターフェイスの名前。

デバッグ

API Explorer を使用して、API のデバッグ、SDK コード例の自動生成、API の迅速な検索を簡単にすることができます。

リクエストパラメーター

パラメータ データ型 必須 値の例 説明
Action String 必須 DescribeRouterInterfaces

このアクションの名前。 値:

DescribeRouterInterfaces
RegionId String 必須 cn-hangzhou

1 つ以上のルーターインスタンスが属するリージョンの ID。

リージョン ID を照会するには、 DescribeRegions を呼び出します。

Filter.n.Key String 任意 Filter.1.status

Filter keys. 最大 5 つのフィルタがサポートされています。 N 値の範囲：1 から 5。

Filter.n.Value.m String 任意 Filter.1.Active

指定されたフィルターキーの対応する値。 m 値の範囲：1 から 5。

IncludeReservationData Boolean 任意 false

更新データが含まれるかどうかを示します。

PageNumber Integer No 0

返すページ数。 既定値：1
PageSize Integer No 10

1 ページあたりのエントリ数。 最大値：50。 既定値：10。

応答パラメーター

パラメーター データ型 値の例 説明
TotalCount Integer 10

照会されたエントリの数。

PageNumber Integer 10

現在のページ番号。

PageSize Integer 10

1 ページあたりのエントリ数。
RequestId String C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45

リクエストの ID。

RouterInterfaceSet N/A N/A

ルーターインターフェイスのリスト。
└AccessPointId String ap-cn-shanghaiSZ-pd-A

アクセスポイントの ID。

└Bandwidth Integer 10

ルーターインターフェイスの帯域幅。
└BusinessStatus String Normal

ルーターインターフェイスのビジネスステータス。

  • Normal：正常
  • FinancialLocked ：ルーターインターフェイスが期限切れのためロックされています。
  • SecurityLocked : セキュリティ保護のためロックされています。
└ChargeType String PayByTraffic

支払方法。

└ConnectedTime String 2017-06-08T12:20:55

接続が確立された時刻。

└CreationTime String 2017-06-08T12:20:55

ルートテーブルが作成された時刻。
└CrossBorder Boolean false

接続がクロスボーダー接続であるかどうかを示します。
└Description String これは自分のルーターインターフェイスです。

ルーターインターフェイスの説明。
└EndTime String 2017-06-08T12:20:55

データ取得の終了時刻。

└HasReservationData String false

更新データを取得するかどうか。

└HealthCheckSourceIp String 116.62.222.28

ヘルスチェックのソース IP。
└HealthCheckTargetIp String 116.62.222.28

ヘルスチェックの対象 IP。
└Name String test

ルーターインターフェイスの名前。
└OppositeAccessPointId String ap-cn-shanghaiSZ-pd-A

接続先アクセスポイントの ID。

└OppositeBandwidth Integer 12

接続先ルーターインターフェイスの帯域幅。

└OppositeInterfaceBusinessStatus String Normal

接続先ルーターインターフェイスのビジネスステータス。
└OppositeInterfaceId String ri-bp1itx13bwe6f2wfh3qpj

接続先ルーターインターフェイスの ID 。

└OppositeInterfaceOwnerId String 1231579085529123

接続先ルーターインターフェイスが属するアカウントの ID。

└OppositeInterfaceSpec String Large

接続先ルーターインターフェイスの仕様。
└OppositeInterfaceStatus String Normal

接続先ルーターインターフェイスのステータス。
└OppositeRegionId String cn-shanghai

接続先ルーターインターフェイスが設置されているリージョン。
└OppositeRouterId String vrt-bp1d3bxtdv68tfd7gfjkd

接続先ルーターインターフェイスが属するルーターの ID。
└OppositeRouterType String VRouter

接続先ルーターインターフェイスが属するルーターのタイプ。

└OppositeVpcInstanceId String vpc-bp1qpo0kug3a20qqe9h7v

接続先ルーターインターフェイスが属する VPC の ID。

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

更新が有効になる時刻。
└ReservationBandwidth String 10

更新後の帯域幅。

└ReservationInternetChargeType String PayByBandwidth

更新後の支払いタイプ。
└ReservationOrderType String RENEWCHANGE

更新のオーダータイプ。
└Role String InitiatingSide

ピアリング接続での役割。
└RouterId String vrt-bp1d3bxtdv68tfd7gfjkd

ルートエントリーが属するルーターの ID。

└RouterInterfaceId String ri-2zenfgfpyu3v93koa4sfo

ルーターインターフェイスの ID 。

└RouterType String VRouter

ルートテーブルが属するルーターのタイプ。 有効値:

  • VRouter: VRouter
  • VBR: VBR
└Spec String Large

ルーターインターフェイスの仕様を変更します。
└Status String active

ルーターインターフェイスのステータス。
└VpcInstanceId String vpc-2ze3tq4uxhysg717x7o4d

ピアリング接続のローカル VPC の ID。

例

要求の例


https://vpc.aliyuncs.com/?Action=DescribeRouterInterfaces
&RegionId= cn-hangzhou
&<CommonParameters>
戻り値の例

  • XML形式

    <?xml version="1.0" encoding="UTF-8" ?>
<DescribeRouterInterfacesResponse>
	<PageNumber>1</PageNumber>
	<TotalCount>2</TotalCount>
	<PageSize>10</PageSize>
	<RequestId>01818199-04F6-47F4-9ADF-7CC824CF57A4</RequestId>
	<RouterInterfaceSet>
		<RouterInterfaceType>
			<ChargeType>Prepaid</ChargeType>
			<HasReservationData>false</HasReservationData>
			<OppositeInterfaceBusinessStatus>Normal</OppositeInterfaceBusinessStatus>
			<RouterInterfaceId>ri-2zenfgfpyu3v93koa4sfo</RouterInterfaceId>
			<OppositeInterfaceStatus>Deleted</OppositeInterfaceStatus>
			<Spec>Small.5</Spec>
			<OppositeInterfaceOwnerId>1231579085529123</OppositeInterfaceOwnerId>
			<CrossBorder>false</CrossBorder>
			<OppositeInterfaceSpec>Negative</OppositeInterfaceSpec>
			<CreationTime>2017-12-27T06:34:30Z</CreationTime>
			<RouterType>VRouter</RouterType>
			<Status>Inactive</Status>
			<OppositeRouterType>VRouter</OppositeRouterType>
			<OppositeRouterId>vrt-bp1el837xkkakub7ci0tj</OppositeRouterId>
			<OppositeInterfaceId>ri-bp1itx13bwe6f2wfh3qpj</OppositeInterfaceId>
			<VpcInstanceId>vpc-2ze3tq4uxhysg717x7o4d</VpcInstanceId>
			<RouterId>vrt-2zeazning6tbzkm5c0jj2</RouterId>
			<ConnectedTime>2017-12-27T06:34:37Z</ConnectedTime>
			<OppositeRegionId>cn-hangzhou</OppositeRegionId>
			<BusinessStatus>Normal</BusinessStatus>
			<Role>InitiatingSide</Role>
			<OppositeVpcInstanceId>vpc-bp1iq3579f26c3gpkj92e</OppositeVpcInstanceId>
			<EndTime>2018-01-27T16:00:00Z</EndTime>
		</RouterInterfaceType>
		<RouterInterfaceType>
			<ChargeType>Prepaid</ChargeType>
			<HasReservationData>false</HasReservationData>
			 <OppositeInterfaceBusinessStatus>Normal</OppositeInterfaceBusinessStatus>
			<RouterInterfaceId>ri-2zegbp7nhj0mnwm6irnuo</RouterInterfaceId>
			<OppositeInterfaceStatus>Deleted</OppositeInterfaceStatus>
			<Spec>Small.1</Spec>
			<OppositeInterfaceOwnerId>1231579085529123</OppositeInterfaceOwnerId>
			<CrossBorder>false</CrossBorder>
			<OppositeInterfaceSpec>Negative</OppositeInterfaceSpec>
			<CreationTime>2017-12-27T06:31:30Z</CreationTime>
			<RouterType>VRouter</RouterType>
			<Status>Inactive</Status>
			<OppositeRouterType>VRouter</OppositeRouterType>
			<OppositeRouterId>vrt-bp1d3bxtdv68tfd7gfjkd</OppositeRouterId>
			<OppositeInterfaceId>ri-bp12dxgw8gmoma1h506qf</OppositeInterfaceId>
			<VpcInstanceId>vpc-2ze3tq4uxhysg717x7o4d</VpcInstanceId>
			<RouterId>vrt-2zeazning6tbzkm5c0jj2</RouterId>
			<ConnectedTime>2017-12-27T06:31:36Z</ConnectedTime>
			<OppositeRegionId>cn-hangzhou</OppositeRegionId>
			<BusinessStatus>Normal</BusinessStatus>
			<Role>InitiatingSide</Role>
			<OppositeVpcInstanceId>vpc-bp15k6sx6fhdz2jw4daz0</OppositeVpcInstanceId>
			<EndTime>2018-10-27T16:00:00Z</EndTime>
		</RouterInterfaceType>
	</RouterInterfaceSet>
<DescribeRouterInterfacesResponse>

  • JSON 形式

    {
	"PageNumber":1,
	"TotalCount":2,
	"PageSize":10,
	"RequestId":"01818199-04F6-47F4-9ADF-7CC824CF57A4",
	"RouterInterfaceSet":{
		"RouterInterfaceType":[
			{
				"ChargeType":"Prepaid",
				"HasReservationData":false,
				"OppositeInterfaceBusinessStatus":"Normal",
				"RouterInterfaceId":"ri-2zenfgfpyu3v93koa4sfo",
				"OppositeInterfaceStatus":"Deleted",
				"Spec":"Small.5",
				"OppositeInterfaceOwnerId":"1231579085529123",
				"CrossBorder":false,
				"OppositeInterfaceSpec":"Negative",
				"CreationTime":"2017-12-27T06:34:30Z",
				"RouterType":"VRouter",
				"Status":"Inactive",
				"OppositeRouterId":"vrt-bp1el837xkkakub7ci0tj",
				"OppositeRouterType":"VRouter",
				"OppositeInterfaceId":"ri-bp1itx13bwe6f2wfh3qpj",
				"ConnectedTime":"2017-12-27T06:34:37Z",
				"RouterId":"vrt-2zeazning6tbzkm5c0jj2",
				"VpcInstanceId":"vpc-2ze3tq4uxhysg717x7o4d",
				"BusinessStatus":"Normal",
				"OppositeRegionId":"cn-hangzhou",
				"Role":"InitiatingSide",
				"EndTime":"2018-01-27T16:00:00Z",
				"OppositeVpcInstanceId":"vpc-bp1iq3579f26c3gpkj92e"
			},
			{
				"ChargeType":"Prepaid",
				"HasReservationData":false,
				"OppositeInterfaceBusinessStatus":"Normal",
				"RouterInterfaceId":"ri-2zegbp7nhj0mnwm6irnuo",
				"OppositeInterfaceStatus":"Deleted",
				"Spec":"Small.1",
				"OppositeInterfaceOwnerId":"1231579085529123",
				"CrossBorder":false,
				"OppositeInterfaceSpec":"Negative",
				"CreationTime":"2017-12-27T06:31:30Z",
				"RouterType":"VRouter",
				"Status":"Inactive",
				"OppositeRouterId":"vrt-bp1d3bxtdv68tfd7gfjkd",
				"OppositeRouterType":"VRouter",
				"OppositeInterfaceId":"ri-bp12dxgw8gmoma1h506qf",
				"ConnectedTime":"2017-12-27T06:31:36Z",
				"RouterId":"vrt-2zeazning6tbzkm5c0jj2",
				"VpcInstanceId":"vpc-2ze3tq4uxhysg717x7o4d",
				"BusinessStatus":"Normal",
				"OppositeRegionId":"cn-hangzhou",
				"Role":"InitiatingSide",
				"EndTime":"2018-10-27T16:00:00Z",
				"OppositeVpcInstanceId":"vpc-bp15k6sx6fhdz2jw4daz0"
			}
		]
	}
}

Error codes

HTTP ステータスコード エラーコード エラーメッセージ 説明
404 InvalidFilterKey.ValueNotSupported 指定されたフィルタキーはサポートされていません: Filter.X.key 指定されたフィルタキーはサポートされていません。
400 InvalidParam.NotNull パラメーターは null であってはなりません。 パラメーターを null にすることはできません。

一般的なエラーコードをご参照ください。