DescribeEnsRouteEntryList でルートエントリを查询 - ENS

ルートエントリを照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:DescribeEnsRouteEntryList

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RouteTableId	string	任意	照会するルートテーブルの ID。	vtb-hp3wdhynneo7fsclox8hs
RouteEntryId	string	任意	照会するルートの ID。	rte-8vbdw66evgv44u2u7v3hx
DestinationCidrBlock	string	任意	ルートエントリの宛先 CIDR (Classless Inter-Domain Routing) ブロック。	11.0.0.0/16
RouteEntryType	string	任意	ルートタイプ。有効値： Custom：カスタムルート System：システムルート	Custom
NextHopType	string	任意	カスタムルートエントリーのネクストホップのタイプ。有効値： Instance (デフォルト)：ENS インスタンス。 HaVip：高可用性仮想 IP アドレス (HAVIP)。 NetworkPeer：VPC ピアリング接続。	Instance
NextHopId	string	任意	ネクストホップの ID。	i-2zecshuv3axtr2gc4noa
RouteEntryName	string	任意	ルートの名前。	test0
PageNumber	integer	任意	返されるページのページ番号。有効値：0 より大きい整数。デフォルト値：1。	1
PageSize	integer	任意	1 ページあたりのエントリ数。デフォルト値：10。有効値：10～100。	10

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
RouteEntrys	array<object>	ルートに関する情報。
	array<object>	ルートに関する情報。
Status	string	ルートエントリのステータス。有効値：	Available
Type	string	ルートエントリのタイプ。	Custom
Description	string	ルートの説明を入力します。	测试
RouteEntryName	string	ルートの名前。	test0
DestinationCidrBlock	string	ルートの宛先 CIDR ブロック。	101.0.45.0/24
RouteEntryId	string	ルートの ID。	rte-2zeksx7h436f5unk349m1
RouteTableId	string	ルートテーブルの ID。	vtb-uf62p9o5cn35fi8xgurnm
NextHops	array<object>	ネクストホップに関する情報。
	object	ネクストホップ。
NextHopId	string	ネクストホップの ID。	i-bp1111yup9991890woxq
NextHopType	string	ネクストホップのタイプ。有効値：	Instance
NextHopName	string	ネクストホップのインスタンス ID。	testInstance
SourceCidrBlock	string	送信元 CIDR ブロック。このフィールドは、ゲートウェイルートテーブルでルートエントリを設定する場合に使用されます。vSwitch ルートテーブルではサポートされていません。	10.XXX.XXX.0/24
CreationTime	string	IP アドレスが作成された時刻。時刻は協定世界時 (UTC) で表示されます。	2023-02-16T03:50:05Z
PageNumber	integer	返されるページのページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。	10
TotalCount	integer	返されたエントリの数。	7

例

成功レスポンス

JSONJSON

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "RouteEntrys": [
    {
      "Status": "Available",
      "Type": "Custom",
      "Description": "测试",
      "RouteEntryName": "test0",
      "DestinationCidrBlock": "101.0.45.0/24",
      "RouteEntryId": "rte-2zeksx7h436f5unk349m1",
      "RouteTableId": "vtb-uf62p9o5cn35fi8xgurnm",
      "NextHops": [
        {
          "NextHopId": "i-bp1111yup9991890woxq",
          "NextHopType": "Instance",
          "NextHopName": "testInstance"
        }
      ],
      "SourceCidrBlock": "10.XXX.XXX.0/24",
      "CreationTime": "2023-02-16T03:50:05Z"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 7
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Invalid%s	The specified parameter %s is invalid.
400	Missing%s	You must specify the parameter %s.
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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

変更履歴

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