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

ルートテーブル内のルートを照会します。

使用方法

DeleteRouteEntry 操作を呼び出してルートを削除する前に、この操作を呼び出して、削除するルートのネクストホップを照会できます。

デバッグ

OpenAPI Explorer は、署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
RegionId	String	Yes	cn-hangzhou	ルートテーブルのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。
RouteTableId	String	Yes	vtb-bp1r9pvl4xen8s9ju****	ルートテーブルの ID。
RouteEntryId	String	No	rte-bp1mnnr2al0naomnp****	照会するルートの ID。
DestinationCidrBlock	String	No	192.168.2.0/24	ルートの宛先 CIDR ブロック。 IPv4 および IPv6 CIDR ブロックがサポートされています。
RouteEntryName	String	No	abc	ルート名。名前は 1 ～ 128 文字で、`http://` または `https://` で始めることはできません。
IpVersion	String	No	ipv4	IP バージョン。有効な値： ipv4 ipv6
RouteEntryType	String	No	System	ルートタイプ。有効な値： Custom System BGP CEN
NextHopId	String	No	vpn-bp10zyaph5cc8b7c7****	ネクストホップの ID。
NextHopType	String	No	Instance	ネクストホップのタイプ。有効な値： Instance (デフォルト): Elastic Compute Service (ECS) インスタンス HaVip: 高可用性仮想 IP アドレス (HAVIP) VpnGateway: VPN ゲートウェイ NatGateway: NAT ゲートウェイ NetworkInterface: セカンダリ Elastic Network Interface (ENI) RouterInterface: ルーターインターフェース IPv6Gateway: IPv6 ゲートウェイ Attachment: 転送ルータ
MaxResult	Integer	No	10	各ページに返すエントリの数。有効な値: 1 ～ 100。デフォルト値: 10。
NextToken	String	No	FFmyTO70tTpLG6I3FmYAXGKPd****	次のリクエストで使用されるページネーショントークンで、新しいページの結果を取得するために使用されます。有効な値：最初のリクエストでは、このパラメーターを指定する必要はありません。次のクエリを送信する場合は、パラメーターを最後の呼び出しから返された NextToken の値に設定します。
Action	String	Yes	DescribeRouteEntryList	実行する操作。DescribeRouteEntryList に設定します。
ServiceType	String	No	TR	ルートがホストされているかどうかを指定します。パラメーターを空のままにすると、ルートはホストされません。 TR に設定すると、ルートは転送ルータによってホストされます。
DestCidrBlockList.N	String	No	192.168.0.0/24	ルートの宛先 CIDR ブロック。最大 20 個の宛先 CIDR ブロックを指定できます。

レスポンスパラメーター

パラメーター	タイプ	例	説明
NextToken	String	FFmyTO70tTpLG6I3FmYAXGKPd****	NextToken の戻り値はページネーショントークンで、次のリクエストで新しいページの結果を取得するために使用できます。有効な値： NextToken が空の場合、次のページは存在しません。 NextToken が空でない場合、NextToken の値を次のリクエストで使用して、新しいページの結果を取得できます。
RequestId	String	14A07460-EBE7-47CA-9757-12CC4761D47A	リクエスト ID。
RouteEntrys	Array of RouteEntry		ルートに関する情報。
RouteEntry
Status	String	Available	ルートのステータス。有効な値： Pending Available Modifying
Type	String	System	ルートタイプ。有効な値： Custom System BGP CEN
IpVersion	String	ipv4	IP バージョン。有効な値： ipv4 ipv6
Description	String	RouteEntryDescription	ルートの説明。
RouteEntryName	String	aaa	ルート名。
DestinationCidrBlock	String	192.168.2.0/24	ルートの宛先 CIDR ブロック。
RouteEntryId	String	rte-bp1mnnr2al0naomnp****	ルートの ID。
RouteTableId	String	vtb-bp15w5q90d2rk3bww****	ルートテーブルの ID。
GmtModified	String	2022-05-09T03:00:07Z	ルートが変更された時刻。時刻は UTC の `YYYY-MM-DDThh:mm:ssZ` 形式で表示されます。
NextHops	Array of NextHop		ネクストホップに関する情報。
NextHop
NextHopRegionId	String	cn-hangzhou	ネクストホップのリージョン ID。説明このパラメーターは、ネクストホップタイプが RouterInterface に設定されている場合に返されます。
Weight	Integer	100	ルートの重み。説明このパラメーターは、ネクストホップタイプが RouterInterface に設定されている場合に返されます。
NextHopId	String	vpn-bp10zyaph5cc8b7c7****	ネクストホップの ID。
Enabled	Integer	1	ルートが使用可能かどうかを示します。有効な値： 0: 使用不可 1: 使用可能説明このパラメーターは、ネクストホップタイプが RouterInterface に設定されている場合に返されます。
NextHopType	String	Instance	ネクストホップのタイプ。有効な値： Instance: ECS インスタンス HaVip: HAVIP VpnGateway: VPN ゲートウェイ NatGateway: NAT ゲートウェイ NetworkInterface: セカンダリ ENI RouterInterface: ルーターインターフェース IPv6Gateway: IPv6 ゲートウェイ Attachment: 転送ルータ
NextHopRelatedInfo	Object		ネクストホップに関する情報。
InstanceId	String	vpc-bp1t36rn9l53iwbsf****	ネクストホップに関連付けられているインスタンスの ID。
InstanceType	String	VPC	ネクストホップに関連付けられているインスタンスのタイプ。有効な値： VPC: VPC VBR: VBR PCONN: Express Connect 回線
RegionId	String	ch-hangzhou	ネクストホップに関連付けられているインスタンスのリージョン ID。
ServiceType	String	TR	ルートがホストされているかどうかを示します。パラメーターが空の場合、ルートはホストされていません。 TR が返された場合、ルートは転送ルータによってホストされています。

例

リクエストの例

http(s)://[Endpoint]/?RegionId=cn-hangzhou
&RouteTableId=vtb-bp1r9pvl4xen8s9ju****
&RouteEntryId=rte-bp1mnnr2al0naomnp****
&DestinationCidrBlock=192.168.2.0/24
&RouteEntryName=abc
&IpVersion=ipv4
&RouteEntryType=System
&NextHopId=vpn-bp10zyaph5cc8b7c7****
&NextHopType=Instance
&MaxResult=10
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&Action=DescribeRouteEntryList
&ServiceType=TR
&DestCidrBlockList=["192.168.0.0/24"]
&共通リクエストパラメーター

正常なレスポンスの例

XML 形式

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

<DescribeRouteEntryListResponse>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>14A07460-EBE7-47CA-9757-12CC4761D47A</RequestId>
    <RouteEntrys>
        <Status>Available</Status>
        <Type>Custom</Type>
        <IpVersion>ipv4</IpVersion>
        <Description>RouteEntryDescription</Description>
        <RouteEntryName>aaa</RouteEntryName>
        <DestinationCidrBlock>192.168.2.0/24</DestinationCidrBlock>
        <RouteEntryId>rte-bp1mnnr2al0naomnp****</RouteEntryId>
        <RouteTableId>vtb-bp15w5q90d2rk3bww****</RouteTableId>
        <GmtModified>2022-05-09T03:00:07Z</GmtModified>
        <NextHops>
            <NextHopRegionId>cn-hangzhou</NextHopRegionId>
            <Weight>100</Weight>
            <NextHopId>vpn-bp10zyaph5cc8b7c7****</NextHopId>
            <Enabled>1</Enabled>
            <NextHopType>Instance</NextHopType>
            <NextHopRelatedInfo>
                <InstanceId>vpc-bp1t36rn9l53iwbsf****</InstanceId>
                <InstanceType>VPC</InstanceType>
                <RegionId>ch-hangzhou</RegionId>
            </NextHopRelatedInfo>
        </NextHops>
        <ServiceType>TR</ServiceType>
    </RouteEntrys>
</DescribeRouteEntryListResponse>

JSON 形式

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

{
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId" : "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "RouteEntrys" : [ {
    "Status" : "Available",
    "Type" : "Custom",
    "IpVersion" : "ipv4",
    "Description" : "RouteEntryDescription",
    "RouteEntryName" : "aaa",
    "DestinationCidrBlock" : "192.168.2.0/24",
    "RouteEntryId" : "rte-bp1mnnr2al0naomnp****",
    "RouteTableId" : "vtb-bp15w5q90d2rk3bww****",
    "GmtModified" : "2022-05-09T03:00:07Z",
    "NextHops" : [ {
      "NextHopRegionId" : "cn-hangzhou",
      "Weight" : 100,
      "NextHopId" : "vpn-bp10zyaph5cc8b7c7****",
      "Enabled" : 1,
      "NextHopType" : "Instance",
      "NextHopRelatedInfo" : {
        "InstanceId" : "vpc-bp1t36rn9l53iwbsf****",
        "InstanceType" : "VPC",
        "RegionId" : "ch-hangzhou"
      }
    } ],
    "ServiceType" : "TR"
  } ]
}

エラーコード

HttpCode	エラーコード	エラーメッセージ	説明
400	OperationFailed.QueryCenEntry	Operation is denied because getting CEN route entry has failed.	CEN ルートの照会に失敗しました。
400	OperationDenied.UseGatewayRouteEntryQueryInterface	Use listGatewayRouteTableEntries to describe gateway route entries.	ゲートウェイルートテーブルのルートを照会するには、listGatewayRouteTableEntries 操作を呼び出します。

エラーコードの一覧については、「サービスエラーコード」をご参照ください。