DescribeTransitRouteTableAggregation で集約ルートをクエリ - CEN

Enterprise Edition トランジットルーターのルートテーブル内の集約ルートをクエリします。

操作説明

TransitRouteTableId と TransitRouteTableAggregationCidr パラメーターを指定すると、特定のアグリゲートルートをクエリできます。 TransitRouteTableId パラメーターのみを指定した場合、デフォルトで 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:DescribeTransitRouteTableAggregation

get

*All Resource

*

なし

リクエストパラメーター

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

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object	返されるレスポンス。
Data	array<object>	集約ルートのリスト。
	object	集約ルートに関する情報。
Name	string	集約ルートの名前。	nametest
TransitRouteTableAggregationCidr	string	集約ルートの宛先 CIDR ブロック。	192.168.10.0/24
Scope	string	集約ルートの範囲。値は VPC に設定されます。これは、集約ルートが、Enterprise Edition トランジットルーターのルートテーブルに関連付けられ、ルート同期が有効になっているすべての VPC にアドバタイズされることを示します。	VPC
RouteType	string	集約ルートのタイプ。値は Static に設定されます。これは、ルートが静的ルートであることを示します。集約ルートが VPC にアドバタイズされると、デフォルトでカスタムルートエントリになります。	Static
Description	string	集約ルートの説明。	desctest
TrRouteTableId	string	Enterprise Edition トランジットルーターのルートテーブルの ID。	vtb-6ehgc262hr170qgyc****
Status	string	集約ルートのアドバタイズステータス。 AllConfigured: 集約ルートはすべての VPC にアドバタイズされます。 Configuring: 集約ルートはアドバタイズされています。 ConfigFailed: 集約ルートのアドバタイズに失敗しました。 PartialConfigured: 集約ルートは一部の VPC にアドバタイズされます。 Deleting: 集約ルートは削除されています。	AllConfigured
ScopeList	array	集約ルートの範囲のリスト。説明 Scope プロパティと ScopeList プロパティの少なくとも 1 つを指定する必要があります。 ScopeList を指定することをお勧めします。 ScopeList の要素は、Scope の値と同じにすることはできません。
	string	集約ルートの範囲のリスト。有効な値: VPC: 集約ルートは、Enterprise Edition トランジットルーターのルートテーブルに関連付けられ、ルート同期が有効になっているすべての VPC にアドバタイズされます。 VBR: 集約ルートは、Enterprise Edition トランジットルーターに接続されているすべての VBR にアドバタイズされます。 Peer: 集約ルートは、Enterprise Edition トランジットルーターとリージョン間接続を持つトランジットルーターにアドバタイズされます。 VPN: 集約ルートは、Enterprise Edition トランジットルーターに接続されているすべての VPN 接続にアドバタイズされます。 ECR: 集約ルートは、Enterprise Edition トランジットルーターに接続されているすべての ECR インスタンスにアドバタイズされます。	VPC
Count	integer	各ページに戻されるエントリの数。	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.
400	IllegalParam.NextToken	The nextToken is illegal.
400	InstanceNotExist.TransitRouterRouteTable	The transitRouter route table is not found.
400	InvalidCidrBlock	The transitRouteTableAggregationCidr is invalid.
400	InvalidParameter	Invalid parameter.
400	Unauthorized	The AccessKeyId is unauthorized.

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

変更履歴

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