DescribeEnsRouteTables API リファレンス - 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:DescribeEnsRouteTables

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	任意	ページ番号。	1
PageSize	integer	任意	1ページあたりのエントリ数。	30
RouteTableId	string	任意	ルートテーブルの ID。	vtb-5p1cifr72di****
NetworkId	string	任意	ネットワークの ID。	n-257gqcdfvx6n****
EnsRegionId	string	任意	ENSノードの ID。	cn-xian-unicom
EnsRegionIds	array	任意	エッジノードの ID。1～100個の ID を指定できます。
	string	任意	エッジノードの ID。	cn-chengdu-telecom-4
Type	string	任意	SNATタイプ。 FullCone: フルコーンNAT。	FullCone
AssociateType	string	任意	ルートテーブルが関連付けられているリソースのタイプ。有効な値: VSwitch Gateway	Gateway
RouteTableName	string	任意	ルートテーブルの名前。	tftest-nat04

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエストの ID。	DC51ACB0-460D-5CA0-BA2D-E1F3B5547AE9
PageNumber	integer	ページ番号。	1
TotalCount	integer	返されたエントリの総数。	10
PageSize	integer	1ページあたりのエントリ数。	30
RouteTables	array<object>	ルートテーブルに関する情報。
	object	ルートテーブルに関する情報。
CreationTime	string	ルートテーブルが作成された時刻。時刻は ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式に従います。時刻は協定世界時 (UTC) で表示されます。	2024-03-08T08:35:18Z
Status	string	ステータス。有効な値: Available: ルートテーブルは利用可能です。	Available
RouteTableId	string	ルートテーブルの ID。	rt-5xde2bit9****
NetworkId	string	ネットワークの ID。	n-5v9lufsezl4g****
VSwitchIds	array	ルートテーブルに関連付けられている VSwitch。
	string	ルートテーブルに関連付けられている VSwitch。	vsw-5f649tc4****
EnsRegionId	string	エッジノードの ID。	cn-beijing-15
Type	string	ルートテーブルのタイプ。例: Custom: カスタムルートテーブル。 System: システムルートテーブル。	System
RouteTableName	string	照会するルートテーブルの名前。名前は2～128文字の長さで、文字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。	test-tf-vtb7
AssociateType	string	ルートテーブルが関連付けられているリソースのタイプ。有効な値: VSwitch Gateway	VSwitch
Description	string	説明。	test
IsDefaultGatewayRouteTable	boolean	デフォルトのゲートウェイルートテーブルであるかどうかを指定します。	false

例

成功レスポンス

JSONJSON

{
  "RequestId": "DC51ACB0-460D-5CA0-BA2D-E1F3B5547AE9",
  "PageNumber": 1,
  "TotalCount": 10,
  "PageSize": 30,
  "RouteTables": [
    {
      "CreationTime": "2024-03-08T08:35:18Z",
      "Status": "Available",
      "RouteTableId": "rt-5xde2bit9****",
      "NetworkId": "n-5v9lufsezl4g****",
      "VSwitchIds": [
        "vsw-5f649tc4****"
      ],
      "EnsRegionId": "cn-beijing-15",
      "Type": "System",
      "RouteTableName": "test-tf-vtb7",
      "AssociateType": "VSwitch",
      "Description": "test",
      "IsDefaultGatewayRouteTable": false
    }
  ]
}

エラーコード

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

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

変更履歴

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