DescribeTransitRouteTableAggregation で集約ルートをクエリ - CEN - Alibaba Cloud - Cloud Enterprise Network

Enterprise エディションのトランジットルーターのルートテーブル内の集約ルートを照会します。

操作説明

TransitRouteTableId および TransitRouteTableAggregationCidr パラメーターを指定して、特定の集約ルートに関する情報をクエリできます。TransitRouteTableId パラメーターのみを指定した場合、システムは指定された Enterprise エディションのトランジットルーターのルートテーブル内のすべての集約ルートに関する情報をクエリします。

今すぐお試しください

この 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:DescribeTransitRouteTableAggregation

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TransitRouteTableId	string	必須	Enterprise エディションのトランジットルーターのルートテーブルの ID。	vtb-6ehgc262hr170qgyc****
TransitRouteTableAggregationCidr	string	任意	集約ルートの送信先 CIDR ブロック。	192.168.10.0/24
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを使用できます。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として自動的に使用します。RequestId は各 API 呼び出しで異なる場合があります。	02fb3da4-130e-11e9-8e44-001****
MaxResults	integer	任意	ページングクエリの 1 ページあたりのエントリ数。デフォルト値: 20。	20
NextToken	string	任意	次のリクエストで新しいページの結果を取得するために使用されるページネーショントークン。有効な値: 最初のリクエストの場合、または次のクエリが存在しない場合は、このパラメーターを指定する必要はありません。次のクエリが存在する場合は、前の API 呼び出しで返された NextToken の値を設定します。	FFmyTO70tTpLG6I3FmYAXGKPd****

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
Data	array<object>	集約ルート情報のリスト。
	object	集約ルート情報。
Name	string	集約ルートの名前。	nametest
TransitRouteTableAggregationCidr	string	集約ルートの送信先 CIDR ブロック。	192.168.10.0/24
Scope	string	集約ルートの伝播範囲。値は VPC のみで、集約ルートが、現在の Enterprise エディションのトランジットルーターのルートテーブルとの関連付けられた転送関係を確立しており、かつルート同期特徴が有効になっているすべての VPC 接続インスタンスに伝播されることを示します。	VPC
RouteType	string	集約ルートのルーティングタイプ。値は Static のみで、静的ルートを示します。集約ルートが VPC 接続インスタンスに伝播されると、デフォルトでカスタムルートエントリになります。	Static
Description	string	集約ルートの説明。	desctest
TrRouteTableId	string	Enterprise エディションのトランジットルーターのルートテーブルの ID。	vtb-6ehgc262hr170qgyc****
Status	string	集約ルートの伝播ステータス。 AllConfigured: 集約ルーティングがすべての VPC 接続インスタンスに伝播されました。 Configuring: 集約ルーティングを伝播中です。 ConfigFailed: 集約ルーティングの伝播に失敗しました。 PartialConfigured: 一部の VPC 接続インスタンスへの集約ルーティングの伝播に失敗しました。 Deleting: 集約ルーティングを削除中です。	AllConfigured
ScopeList	array	集約ルートの伝播範囲リスト。説明集約ルートに対して、伝播範囲または伝播範囲リストの少なくとも一方を指定する必要があります。伝播範囲リストの使用を推奨します。伝播範囲リスト内の要素は、伝播範囲の値と重複できません。
	string	集約ルートの伝播範囲リスト。有効な値: VPC: 集約ルートを、現在の Enterprise エディションのトランジットルーターのルートテーブルとの関連付けられた転送関係を確立しており、かつルート同期特徴が有効になっているすべての VPC 接続インスタンスに伝播します。 VBR: 集約ルートを、現在の Enterprise エディションのトランジットルーターにロードされている VBR インスタンスに伝播します。 Peer: 集約ルートを、現在の Enterprise エディションのトランジットルーターとのリージョン間接続を確立しているトランジットルーターに伝播します。 VPN: 集約ルートを、現在の Enterprise エディションのトランジットルーターにロードされている VPN インスタンスに伝播します。 ECR: 集約ルートを、現在の Enterprise エディションのトランジットルーターにロードされている ECR インスタンスに伝播します。	VPC
Count	integer	ページングクエリの 1 ページあたりのエントリ数。	20
NextToken	string	次のリクエストで新しいページの結果を取得するために使用されるページネーショントークン。有効な値: NextToken が空の場合、次のクエリは存在しません。 NextToken が返された場合、その値は次のクエリのトークンを示します。	FFmyTO70tTpLG6I3FmYAXGKPd****
Total	integer	返されたエントリの総数。	1
RequestId	string	リクエスト ID。	0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50

例

成功レスポンス

JSONJSON

{
  "Data": [
    {
      "Name": "nametest",
      "TransitRouteTableAggregationCidr": "192.168.10.0/24",
      "Scope": "VPC",
      "RouteType": "Static",
      "Description": "desctest",
      "TrRouteTableId": "vtb-6ehgc262hr170qgyc****",
      "Status": "AllConfigured",
      "ScopeList": [
        "VPC"
      ]
    }
  ],
  "Count": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "Total": 1,
  "RequestId": "0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	MissingParam.transitRouterRouteTableId	Missing the parameter transitRouter route table id.	TransitRouterRouteTableId パラメーターが指定されていません。
400	IllegalParam.NextToken	The nextToken is illegal.	リクエストで指定された NextToken が無効です。
400	InstanceNotExist.TransitRouterRouteTable	The transitRouter route table is not found.	指定された Enterprise Edition トランジットルーターのルートテーブルが見つかりませんでした。
400	InvalidCidrBlock	The transitRouteTableAggregationCidr is invalid.	TransitRouteTableAggregationCidr パラメーターが無効です。
400	InvalidParameter	Invalid parameter.	パラメーターが無効です。
400	Unauthorized	The AccessKeyId is unauthorized.	アカウントにこの操作を実行する権限がありません。

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

変更履歴

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