Enterprise Edition トランジットルーターのルートテーブルにあるルートの詳細をクエリ - CEN - Alibaba Cloud - Cloud Enterprise Network

Enterprise Edition トランジットルーターのルートテーブル内のルートエントリの詳細を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cen:ListTransitRouterRouteEntries

get

TransitRouterRouteEntry

acs:cen:*:{#accountId}:centransitrouterroutentry/{#centransitrouterroutentryId}

TransitRouterRouteTable

acs:cen:*:{#accountId}:centransitrouterroutetable/{#centransitrouterroutetableId}

TransitRouterRouteEntry

acs:cen:*:{#accountId}:centransitrouterroutentry/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
MaxResults	integer	任意	ページネーションでエントリが返される場合の 1 ページあたりのエントリ数。有効な値: 1 ～ 100。デフォルト値: 20。	20
TransitRouterRouteEntryDestinationCidrBlock `deprecated`	string	任意	ルートエントリの送信先 CIDR ブロック (このパラメーターは非推奨となります。代わりに RouteFilter パラメーターを使用してください)。	192.168.0.0/24
TransitRouterRouteEntryStatus	string	任意	ルートエントリのステータス。有効な値: All: すべてのステータスのルートエントリを照会します。 Active (default): アクティブなステータスのルートエントリのみを照会します。 Rejected: ルートの競合により拒否されたルートエントリのみを照会します。 Prohibited: ルーティングポリシーに一致するため禁止されたルートエントリのみを照会します。 Standby: スタンバイルートとして機能するルートエントリのみを照会します。 Candidate: 候補ルートとして機能するルートエントリのみを照会します。このパラメーターを指定しない場合、アクティブなステータスのルートエントリのみが照会されます。	Active
TransitRouterRouteTableId	string	必須	Enterprise Edition トランジットルーターのルートテーブルの ID。	vtb-bp1dudbh2d5na6b50****
NextToken	string	任意	クエリの開始ポイントを決定するトークン。有効な値: 最初のクエリの場合、または後続のクエリを送信しない場合は、このパラメーターを指定する必要はありません。後続のクエリを送信する場合は、前の API 呼び出しで返された NextToken の値をセットします。	fce19****
TransitRouterRouteEntryNames	array	任意	ルートエントリの名前。	testname
	string	任意	ルートエントリの名前。名前は空、または 1～128 文字の長さにできますが、http:// または https:// で始めることはできません。説明システムは、このパラメーターを使用して現在のルートテーブルに設定された静的ルートエントリを照会することのみをサポートしており、TransitRouterRouteEntryIds 以外のクエリ条件とは互換性がありません。	testname
TransitRouterRouteEntryIds	array	任意	ルートエントリの ID。	rte-oklkgwmj97z6dn****
	string	任意	ルートエントリの ID。説明システムは、このパラメーターを使用して現在のルートテーブルに設定された静的ルートエントリを照会することのみをサポートしており、TransitRouterRouteEntryNames 以外のクエリ条件とは互換性がありません。	rte-oklkgwmj97z6dn****
TransitRouterRouteEntryType	string	任意	ルートエントリのタイプ。有効な値: Propagated: 現在のルートテーブルでの自動学習によって生成されます。 Static: 現在のルートテーブルでの静的構成によって生成されます。	Propagated
TransitRouterRouteEntryNextHopType	string	任意	ネクストホップのタイプ。有効な値: BlackHole: ルートエントリがブラックホールルートであることを示します。 Attachment: ルートエントリのネクストホップがネットワークインスタンス接続であることを示します。	Attachment
TransitRouterRouteEntryNextHopId	string	任意	ルートエントリのネクストホップに関連付けられたネットワークインスタンス接続の ID。	tr-attach-nls9fzkfat8934****
TransitRouterRouteEntryNextHopResourceId	string	任意	ルートエントリのネクストホップのインスタンス ID。	vpc-m5ent6du8deaq5*****
TransitRouterRouteEntryNextHopResourceType	string	任意	ルートエントリのネクストホップインスタンスのタイプ。有効な値: VPC: Virtual Private Cloud (VPC) インスタンス。 VBR: Virtual Border Router (VBR) インスタンス。 TR: トランジットルーターインスタンス。 VPN: IPsec 接続インスタンス。	VPC
TransitRouterRouteEntryOriginResourceId	string	任意	ルートエントリのオリジンのインスタンス ID。	vpc-m5ent6du8deaq5*****
TransitRouterRouteEntryOriginResourceType	string	任意	ルートエントリのオリジンインスタンスのタイプ。有効な値: VPC: Virtual Private Cloud (VPC) インスタンス。 VBR: Virtual Border Router (VBR) インスタンス。 TR: トランジットルーターインスタンス。 VPN: IPsec 接続インスタンス。	VPC
PrefixListId	string	任意	プレフィックスリストの ID。	pl-6ehtn5kqxgeyy08fi****
RouteFilter	array<object>	任意	ルートエントリ CIDR ブロックのフィルター条件。
	object	任意	ルートエントリ CIDR ブロックのフィルター条件。
Key	string	任意	フィルター条件。有効な値: PrefixExactMatchCidrs: 完全に一致。 LongestPrefixMatchCidrs: 最長プレフィックスマッチ。IP アドレスおよび CIDR ブロックがサポートされています。 SubnetOfMatchCidrs: サブネットマッチ。指定された CIDR ブロック自体を含む、指定された CIDR ブロックのサブネットに一致します。 SupernetOfMatchCidrs: スーパーネットマッチ。指定された CIDR ブロック自体を含む、指定された CIDR ブロックのスーパーネットに一致します。複数のフィルター条件はデフォルトで AND 関係にあり、ルートエントリが一致とみなされるにはすべてのフィルター条件を満たす必要があります。同じフィルター条件を複数回指定することはできません。	PrefixExactMatchCidrs
Value	array	任意	フィルター条件の値のリスト。
	string	任意	Key パラメーターに基づいてフィルター値を指定します。単一の Key に対して複数のフィルター値を指定できます。複数のフィルター値は OR 関係にあり、ルートエントリがいずれかのフィルター値を満たせば一致とみなされます。単一のフィルター条件に対して最大値 500 個のフィルター値を指定できます。 IPv4 アドレス、IPv6 アドレス、および CIDR ブロックがサポートされています。	192.168.1.0/24

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
NextToken	string	次のクエリの開始ポイントを示すトークン。有効な値: NextToken が空の場合、後続のクエリは送信されません。 NextToken が返された場合、その値は次のクエリのトークンを示します。	fce19****
RequestId	string	リクエスト ID。	C3835E5E-1504-4344-B1BB-98A4110F1079
TotalCount	integer	エントリの総数。	6
MaxResults	integer	ページネーションでエントリが返される場合の 1 ページあたりのエントリ数。	20
TransitRouterRouteEntries	array<object>	ルートエントリのリスト。
	array<object>	ルートエントリ情報。フォーマットは以下の通りです。
TransitRouterRouteEntryId	string	ルートエントリの ID。API 呼び出し時に使用します。説明このパラメーターは、静的に設定されたルートに対してのみ返されます。	rte-oklkgwmj97z6dn****
TransitRouterRouteEntryDestinationCidrBlock	string	ルートエントリの送信先 CIDR ブロック。IPv4 CIDR ブロックまたは IPv6 CIDR ブロックが返されます。	192.168.0.0/24
TransitRouterRouteEntryType	string	ルートエントリのタイプ。API 呼び出し時に使用します。 Static: 静的に設定されたルートエントリ。 Propagated: 自動学習によって生成されたルートエントリ。	Static
CreateTime	string	ルートエントリが作成された時間。API 呼び出し時に使用します。時間は YYYY-MM-DDThh:mmZ フォーマットの協定世界時 (UTC) で表示されます。説明このパラメーターは、静的に設定されたルートに対してのみ返されます。	2021-06-15T07:01Z
TransitRouterRouteEntryName	string	ルートエントリの名前。API 呼び出し時に使用します。説明このパラメーターは、静的に設定されたルートに対してのみ返されます。	testname
TransitRouterRouteEntryStatus	string	ルートエントリのステータス。 Active: アクティブな。 Rejected: ルートの競合により拒否。 Prohibited: ルーティングポリシーにより禁止。 Standby: スタンバイ。 Candidate: 候補。 Creating: 作成中。 Deleting: 削除中。	Active
TransitRouterRouteEntryNextHopType	string	ルートエントリのネクストホップタイプ。 BlackHole: ルートエントリがブラックホールルートであることを示します。送信先 CIDR ブロック宛てのすべてのトラフィックが破棄されます。 Attachment: ルートエントリのネクストホップがネットワークインスタンス接続であることを示します。送信先 CIDR ブロック宛てのすべてのトラフィックが指定されたネットワークインスタンス接続に転送されます。	BlackHole
TransitRouterRouteEntryNextHopId	string	ルートエントリのネクストホップ ID。ブラックホールルートの場合はこのパラメーターは返されません。	tr-attach-vx6iwhjr1x1j78****
TransitRouterRouteEntryDescription	string	ルートエントリの説明。API 呼び出し時に使用します。説明このパラメーターは、静的に設定されたルートに対してのみ返されます。	CidrRoute
OperationalMode	boolean	現在のルートエントリが変更済みかどうかを示します。API 呼び出し時に使用します。 true: ルートエントリを変更できます。ルートエントリを削除できます。 false: ルートエントリを変更できません。ルートエントリはシステムによって自動的に生成され、編集はサポートされていません。	false
Tag	string	ルートエントリのタグ。唯一の有効な値は PermitVbr で、現在のルートエントリがトランジットルーターインスタンス配下の VBR インスタンスのルートテーブルにのみ伝播されることを示します。説明このパラメーターは、トランジットルーター CIDR ブロックのシステム生成ルートに対してのみ返されます。	PermitVbr
TransitRouterRouteEntryNextHopResourceId	string	ルートエントリのネクストホップのインスタンス ID。	vpc-m5ent6du8deaq5*****
TransitRouterRouteEntryNextHopResourceType	string	ルートエントリのネクストホップインスタンスのタイプ。 VPC: Virtual Private Cloud (VPC) インスタンス。 VBR: Virtual Border Router (VBR) インスタンス。 TR: トランジットルーターインスタンス。 VPN: IPsec 接続インスタンス。	VPC
TransitRouterRouteEntryOriginResourceType	string	ルートエントリのオリジンインスタンスのタイプ。 VPC: Virtual Private Cloud (VPC) インスタンス。 VBR: Virtual Border Router (VBR) インスタンス。 TR: トランジットルーターインスタンス。 VPN: IPsec 接続インスタンス。	VPC
TransitRouterRouteEntryOriginResourceId	string	ルートエントリのオリジンのインスタンス ID。	vpc-m5ent6du8deaq5*****
PrefixListId	string	プレフィックスリストの ID。	pl-k1ainl66z3527773d****
PathAttributes	object	ルートのパス属性。
Communities	array	ルートエントリの Community 属性のリスト。
	string	ルートエントリの Community 属性値。	65501:1
AsPaths	array	ルートエントリの AS Path 属性のリスト。
	string	ルートエントリの AS Path 属性値。	65501
OriginInstanceId	string	ルートエントリのオリジンである元のインスタンスのインスタンス ID。	vbr-m5ent6du8deaq5*****
OriginInstanceType	string	ルートのオリジンであるインスタンスのタイプ。 VPC: Virtual Private Cloud (VPC) インスタンス。 VBR: Virtual Border Router (VBR) インスタンス。 TR: トランジットルーターインスタンス。 VPN: IPsec 接続インスタンス。 CCN: Cloud Connect Network (CCN) インスタンス。	VBR
OriginRouteType	string	ルート生成時の元のルートタイプ。 System: システムルート。 Custom: カスタムルート。 Static: 静的ルート。 BGP: BGP ルート。 BlackHole: ブラックホールルート。	BGP
Preference	integer	ルートエントリの優先度。値が小さいほど優先度が高くなります。	50

例

成功レスポンス

JSONJSON

{
  "NextToken": "fce19****",
  "RequestId": "C3835E5E-1504-4344-B1BB-98A4110F1079",
  "TotalCount": 6,
  "MaxResults": 20,
  "TransitRouterRouteEntries": [
    {
      "TransitRouterRouteEntryId": "rte-oklkgwmj97z6dn****",
      "TransitRouterRouteEntryDestinationCidrBlock": "192.168.0.0/24",
      "TransitRouterRouteEntryType": "Static",
      "CreateTime": "2021-06-15T07:01Z",
      "TransitRouterRouteEntryName": "testname",
      "TransitRouterRouteEntryStatus": "Active",
      "TransitRouterRouteEntryNextHopType": "BlackHole",
      "TransitRouterRouteEntryNextHopId": "tr-attach-vx6iwhjr1x1j78****",
      "TransitRouterRouteEntryDescription": "CidrRoute",
      "OperationalMode": false,
      "Tag": "PermitVbr",
      "TransitRouterRouteEntryNextHopResourceId": "vpc-m5ent6du8deaq5*****",
      "TransitRouterRouteEntryNextHopResourceType": "VPC",
      "TransitRouterRouteEntryOriginResourceType": "VPC",
      "TransitRouterRouteEntryOriginResourceId": "vpc-m5ent6du8deaq5*****",
      "PrefixListId": "pl-k1ainl66z3527773d****",
      "PathAttributes": {
        "Communities": [
          "65501:1"
        ],
        "AsPaths": [
          "65501"
        ],
        "OriginInstanceId": "vbr-m5ent6du8deaq5*****\n",
        "OriginInstanceType": "VBR",
        "OriginRouteType": "BGP",
        "Preference": 50
      }
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	IllegalParam.TransitRouterRouteTableId	TransitRouterRouteTableId is illegal.	リクエストで指定された TransitRouterRouteTableId が無効です。
400	IllegalParam.TransitRouterRouteEntryStatus	TransitRouterRouteEntryStatus is illegal.	リクエストで指定された TransitRouterRouteEntryStatus が無効です。
400	IllegalParam.NextToken	NextToken is illegal.	リクエストで指定された NextToken が無効です。
400	ParamExclusive.RouteEntryIdsAndStatus	TransitRouterRouteEntryIds and TransitRouterRouteEntryStatus is mutually exclusive.	TransitRouterRouteEntryIds パラメーターと TransitRouterRouteEntryStatus パラメーターは相互排他です。
400	InvalidTransitRouterRouteTableId.NotFound	TransitRouterRouteTableId is not found.	トランジットルーターのルートテーブルインスタンス ID が見つかりませんでした。
400	FilterKeyDuplicated.RouteFilter	The keys in RouteFilter are duplicated.	RouteFilter のキー値が重複しています。
400	InvalidFilterKey	The key in filter is invalid.	フィルター内のキーが無効です。
400	IllegalParam.TransitRouterRouteEntryNextHopType	TransitRouterRouteEntryNextHopType is invalid.	TransitRouterRouteEntryNextHopType パラメーターが無効です。
400	IllegalParam.TransitRouterRouteEntryNextHopAttachmentId	TransitRouterRouteEntryNextHopAttachmentId is invalid.	TransitRouterRouteEntryNextHopAttachmentId パラメーターが無効です。
400	IllegalParam.TransitRouterRouteEntryNextHopResourceId	TransitRouterRouteEntryNextHopResourceId is invalid.	TransitRouterRouteEntryNextHopResourceId ソースパラメーターが無効です。
400	IllegalParam.TransitRouterRouteEntryNextHopResourceType	TransitRouterRouteEntryNextHopResourceType is invalid.	TransitRouterRouteEntryNextHopResourceType ソースパラメーターが無効です。
400	IllegalParam.TransitRouterRouteEntryOriginResourceId	TransitRouterRouteEntryOriginResourceId is invalid.	TransitRouterRouteEntryOriginResourceId ソースパラメーターが無効です。
400	IllegalParam.TransitRouterRouteEntryOriginResourceType	TransitRouterRouteEntryOriginResourceType is invalid.	TransitRouterRouteEntryOriginResourceType ソースパラメーターが無効です。
400	IllegalParam.TransitRouterRouteEntryType	TransitRouterRouteEntryType is invalid.	TransitRouterRouteEntryType パラメーターが無効です。
400	IllegalParam.PrefixExactMatchCidr	PrefixExactMatchCidr is invalid.	PrefixExactMatchCidr パラメーターが無効です。
400	IllegalParam.LongestPrefixMatchCidr	LongestPrefixMatchCidr is invalid.	LongestPrefixMatchCidr パラメーターが無効です。
400	IllegalParam.SubnetOfMatchCidr	SubnetOfMatchCidr is invalid.	SubnetOfMatchCidr パラメーターが無効です。
400	IllegalParam.SupernetOfMatchCidr	SupernetOfMatchCidr is invalid.	SupernetOfMatchCidr パラメーターが無効です。
400	InvalidName	Name is invalid.	名前が無効です。
400	IllegalParam.TextMatchCidr	The TextMatchCidr specified in the parameter is illegal.	リクエストに指定された TextMatchCidr が無効です。
400	ResourceNotFound.PrefixlistAssociation	The prefix list is not associated with this route table.	プレフィックスリストがルートテーブルに関連付けられていません。
400	InvalidParameter	Invalid parameter.	パラメーターが無効です。
400	Unauthorized	The AccessKeyId is unauthorized.	アカウントにこの操作を実行する権限がありません。
404	InvalidRouteTableId.NotFound	The specified RouteTableId is not found.	RouteTableId が存在しません。

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

変更履歴

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