すべてのプロダクト
Search

このプロダクト

    Virtual Private Cloud:DescribeRouteEntryList

    ドキュメントセンター

    Virtual Private Cloud:DescribeRouteEntryList

    最終更新日:Jul 13, 2026

    ルートのリストを照会します。

    操作説明

    DeleteRouteEntry を呼び出してルートを削除する前に、この操作を呼び出して削除対象のルートのネクストホップ情報を取得できます。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    vpc:DescribeRouteEntryList

    get

    *RouteTable

    acs:vpc:{#regionId}:{#accountId}:routetable/{#RouteTableId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    ルートが属するルートテーブルのリージョン ID。

    DescribeRegions を呼び出して最新のリージョンリストを取得できます。

    cn-hangzhou
    RouteTableId

    string

    必須

    クエリするルートテーブルの ID。

    vtb-bp1r9pvl4xen8s9ju****
    RouteEntryId

    string

    任意

    クエリするルートの ID。

    rte-bp1mnnr2al0naomnp****
    DestinationCidrBlock

    string

    任意

    ルートの送信先 CIDR ブロック。IPv4 および IPv6 CIDR ブロックがサポートされています。

    192.168.2.0/24
    RouteEntryName

    string

    任意

    ルートの名前。

    名前は 1～128 文字で、http:// または https:// で始まることはできません。

    abc
    IpVersion

    string

    任意

    IP プロトコルのバージョン。有効な値:

    • ipv4: IPv4。

    • ipv6: IPv6。

    ipv4
    RouteEntryType

    string

    任意

    ルートエントリのタイプ。有効な値:

    • Custom: カスタムルートエントリ。

    • System: システムルートエントリ。

    • BGP: BGP ルート。

    • CEN: Cloud Enterprise Network (CEN) ルート。

    • ECR: Express Connect Router (ECR) ルート。

    System
    NextHopId

    string

    任意

    ネクストホップのインスタンス ID。

    vpn-bp10zyaph5cc8b7c7****
    NextHopType

    string

    任意

    ネクストホップタイプ。有効な値:

    • Instance (デフォルト): ECS インスタンス。

    • HaVip: 高可用性仮想 IP アドレス。

    • VpnGateway: VPN ゲートウェイ。

    • NatGateway: NAT Gateway。

    • NetworkInterface: セカンダリネットワークインターフェース (ENI)。

    • RouterInterface: vRouter インターフェイス。

    • IPv6Gateway: IPv6 ゲートウェイ。

    • Attachment: トランジットルーター。

    • Ipv4Gateway: IPv4 ゲートウェイ。

    • GatewayEndpoint: ゲートウェイエンドポイント。

    • Ecr: Express Connect Router (ECR)。

    Instance
    MaxResult

    integer

    任意

    ページングクエリの 1 ページあたりのエントリ数。有効な値: 1～100。デフォルト値: 10。

    10
    NextToken

    string

    任意

    次のリクエストで結果の新しいページを取得するために使用されるページネーショントークン。有効な値:

    • 最初のリクエスト、または後続のリクエストが存在しない場合、このパラメーターを指定する必要はありません。

    • 次のリクエストが存在する場合、前の API 呼び出しで返された NextToken の値を設定します。

    FFmyTO70tTpLG6I3FmYAXGKPd****
    RegionId

    string

    必須

    ルートホスティングのタイプ。このフィールドが空の場合、ルートはホストされていません。

    有効な値: TR。ホスティングタイプがトランジットルーターであることを示します。

    cn-hangzhou
    ServiceType

    string

    任意

    ルートの送信先 CIDR ブロックのリスト。

    TR
    DestCidrBlockList

    array

    任意

    ルートエントリの送信先 CIDR ブロックのリスト。

    string

    任意

    ルートエントリの送信先 CIDR ブロックリスト情報。最大 20 個の送信先 CIDR ブロックを指定できます。

    192.168.0.0/24

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    ルートの詳細。

    NextToken

    string

    次のリクエストで結果の新しいページを取得するために使用されるページネーショントークン。有効な値:

    • NextToken が空の場合、次のリクエストは存在しません。

    • NextToken が返された場合、その値は次のクエリのトークンを示します。

    FFmyTO70tTpLG6I3FmYAXGKPd****
    RequestId

    string

    リクエスト ID。

    14A07460-EBE7-47CA-9757-12CC4761D47A
    RouteEntrys

    object

    RouteEntry

    array<object>

    ルート情報のフォーマット。

    array<object>

    ルート情報のフォーマット。

    Status

    string

    ルートエントリのステータス。有効な値:

    • Pending: 設定中。

    • Available: 利用可能。

    • Modifying: 変更中。

    • Deleting: 削除中。

    Available
    Type

    string

    ルートエントリのタイプ。有効な値:

    • Custom: カスタムルート。

    • System: システムルート。

    • BGP: BGP ルート。

    • CEN: Cloud Enterprise Network (CEN) ルート。

    • ECR: Express Connect Router ルート。

    System
    IpVersion

    string

    IP プロトコルのバージョン。有効な値:

    • ipv4: IPv4 プロトコル。

    • ipv6: IPv6 プロトコル。

    ipv4
    Description

    string

    ルートエントリの説明。

    RouteEntryDescription
    RouteEntryName

    string

    ルートエントリの名前。

    aaa
    DestinationCidrBlock

    string

    ルートエントリの送信先 CIDR ブロック。

    192.168.2.0/24
    RouteEntryId

    string

    ルートエントリの ID。

    rte-bp1mnnr2al0naomnp****
    RouteTableId

    string

    ルートテーブルの ID。

    vtb-bp15w5q90d2rk3bww****
    GmtModified

    string

    ルートエントリが変更された時間。時間は協定世界時 (UTC) で、YYYY-MM-DDThh:mm:ssZ のフォーマットで表示されます。

    2022-05-09T03:00:07Z
    NextHops

    object

    NextHop

    array<object>

    ネクストホップ情報。

    array<object>

    ネクストホップ情報。

    NextHopRegionId

    string

    ネクストホップインスタンスのリージョン ID。

    説明

    このパラメーターは、ネクストホップタイプが RouterInterface の場合にのみ返されます。

    cn-hangzhou
    Weight

    integer

    ルートエントリの重み。

    説明

    このパラメーターは、ネクストホップタイプが RouterInterface の場合にのみ返されます。

    100
    NextHopId

    string

    ネクストホップインスタンスの ID。

    vpn-bp10zyaph5cc8b7c7****
    Enabled

    integer

    ルートが利用可能かどうかを示します。有効な値:

    • 0: 利用不可。

    • 1: 利用可能。

    説明

    このパラメーターは、ネクストホップタイプが RouterInterface の場合にのみ返されます。

    1
    NextHopType

    string

    ネクストホップのタイプ。有効な値:

    • Instance: ECS インスタンス。

    • HaVip: 高可用性仮想 IP アドレス (HAVIP)。

    • VpnGateway: VPN ゲートウェイ。

    • NatGateway: NAT ゲートウェイ。

    • NetworkInterface: セカンダリ Elastic ネットワークインターフェース。

    • RouterInterface: ルーターインターフェイス。

    • IPv6Gateway: IPv6 ゲートウェイ。

    • Attachment: トランジットルーター。

    • Ipv4Gateway: IPv4 ゲートウェイ。

    • GatewayEndpoint: ゲートウェイエンドポイント。

    • Ecr: Express Connect ルーター。

    Instance
    NextHopRelatedInfo

    object

    ネクストホップに関連する情報。

    InstanceId

    string

    ネクストホップに関連付けられたインスタンスのインスタンス ID。

    vpc-bp1t36rn9l53iwbsf****
    InstanceType

    string

    ネクストホップに関連付けられたインスタンスのインスタンスタイプ。有効な値:

    • VPC: 仮想プライベートクラウド。

    • VBR: 仮想ボーダールーター。

    • PCONN: 物理接続。

    VPC
    RegionId

    string

    ネクストホップに関連付けられたインスタンスのリージョン ID。

    ch-hangzhou
    ServiceType

    string

    ルートサービスのタイプ。このフィールドが空の場合、ルートは管理されていないことを示します。

    有効な値: TR。管理タイプがトランジットルーターであることを示します。

    TR
    Origin

    string

    ルートのオリジン。有効な値:

    • RoutePropagation: 動的ルート伝播によって作成。

    • SystemCreate: システムによって作成。

    • CustomCreate: カスタム作成。

    RoutePropagation

    例

    成功レスポンス

    JSONJSON

    {
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "RouteEntrys": {
    "RouteEntry": [
      {
        "Status": "Available",
        "Type": "System",
        "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": {
          "NextHop": [
            {
              "NextHopRegionId": "cn-hangzhou",
              "Weight": 100,
              "NextHopId": "vpn-bp10zyaph5cc8b7c7****",
              "Enabled": 1,
              "NextHopType": "Instance",
              "NextHopRelatedInfo": {
                "InstanceId": "vpc-bp1t36rn9l53iwbsf****",
                "InstanceType": "VPC",
                "RegionId": "ch-hangzhou"
              }
            }
          ]
        },
        "ServiceType": "TR",
        "Origin": "RoutePropagation"
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 IllegalParam.NextToken User nextToken is illegal.
    400 InvalidNextHop.NotFound The specified route entry nexthop does not exist in our records.
    400 OperationFailed.QueryCenEntry Operation is denied because getting CEN route entry has failed. Cloud Enterprise Network (CEN) のルートが一時的に利用できないため、クエリは失敗した。
    400 OperationDenied.UseGatewayRouteEntryQueryInterface Use listGatewayRouteTableEntries to describe gateway route entries. ゲートウェイルートテーブルのルートエントリをクエリするには、ListGatewayRouteTableEntries 操作を使用してください。
    400 InvalidRouteTable.NotFound The specified RouteTable was not found. 指定されたルートテーブルが見つかりませんでした。
    400 IllegalParam.RouteEntryType The parameter of RouteEntryType is illegal. RouteEntryType パラメーターが無効です。
    400 MissingParam.context The param of context is missing. context パラメーターが不足しています。
    400 MissingParam.aliUid The param of aliUid is missing.
    400 MissingParam.bid The param of bid is missing. bid パラメーターが不足しています。
    400 IllegalParam.IpVersion Param IpVersion illegal.
    400 OperationFailed.FilterParamUnderWrongRouteType Operation failed because only custom type support filter by routeEntryId or routeEntryName 操作は失敗しました。ルートエントリ ID またはルートエントリ名によるフィルターをサポートするのはカスタムルートエントリのみです。
    400 IllegalParam.NextTokenExpired The parameter of NextTokenExpired is illegal. パラメーター NextTokenExpired が無効です。

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。