ルートテーブルを照会します。
この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに Vpc(2016-04-28) - DescribeRouteTableList への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
vpc:DescribeRouteTables |
list |
*RouteTable
|
|
なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
ルートテーブルが属する VPC のリージョン ID。 DescribeRegions 操作を呼び出してリージョン ID をクエリできます。 |
ap-southeast-6 |
| VRouterId |
string |
任意 |
クエリする vRouter の ID。 説明
次のパラメーターのうち、少なくとも 1 つを指定する必要があります: VRouterId、RouteTableId、RouterId、RouteTableName。VRouterId と RouterId の両方を同時に指定することはできません。 |
vrt-bp1lhl0taikrteen**** |
| RouteTableId |
string |
任意 |
クエリするルートテーブルの ID。 説明
次のパラメーターのうち、少なくとも 1 つを指定する必要があります: VRouterId、RouteTableId、RouterId、RouteTableName。VRouterId と RouterId の両方を同時に指定することはできません。 |
vtb-bp145q7glnuzdvzu2**** |
| RouterType |
string |
任意 |
ルートテーブルが属するルーターのタイプ。有効な値:
|
VRouter |
| RouterId |
string |
任意 |
ルートテーブルが属するルーターの ID。 説明
次のパラメーターのうち、少なくとも 1 つを指定する必要があります: VRouterId、RouteTableId、RouterId、RouteTableName。VRouterId と RouterId の両方を同時に指定することはできません。 |
vrt-bp1lhl0taikrteen8**** |
| Type |
string |
任意 |
クエリするルートエントリのタイプ。有効な値:
|
Custom |
| RouteTableName |
string |
任意 |
クエリするルートテーブルの名前。 名前は 2~128 文字で、英字または漢字で始まる必要があります。数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。 説明
次のパラメーターのうち、少なくとも 1 つを指定する必要があります: VRouterId、RouteTableId、RouterId、RouteTableName。VRouterId と RouterId の両方を同時に指定することはできません。 |
doctest |
| ResourceGroupId |
string |
任意 |
ルートテーブルが属するリソースグループの ID。 |
rg-acfmxazb4ph**** |
| PageNumber |
integer |
任意 |
ページ番号。デフォルト値: 1。 |
1 |
| PageSize |
integer |
任意 |
ページングにおける 1 ページあたりのエントリ数。最大値: 50。デフォルト値: 10。 |
10 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
1 ページあたりのエントリ数。 |
||
| PageSize |
integer |
1 ページあたりのエントリ数。 |
10 |
| RequestId |
string |
リクエスト ID。 |
DC668356-BCB4-42FD-9BC3-FA2B2E04B634 |
| PageNumber |
integer |
現在のページ番号。 |
1 |
| TotalCount |
integer |
返されたエントリの総数。 |
1 |
| RouteTables |
object |
||
| RouteTable |
array<object> |
ルートテーブルの詳細。 |
|
|
array<object> |
ルートテーブルが作成された時間。 |
||
| CreationTime |
string |
ルートテーブルが作成された時間。 時間は協定世界時 (UTC) で |
2022-08-22T10:40:25Z |
| Status |
string |
ルートテーブルのステータス。有効な値:
|
Available |
| VRouterId |
string |
vRouter の ID。 |
vrt-bp1lhl0taikrteen**** |
| RouteTableType |
string |
ルートテーブルのタイプ。有効な値:
|
Custom |
| ResourceGroupId |
string |
ルートテーブルが属するリソースグループの ID。 |
rg-acfmxazb4ph**** |
| RouteTableId |
string |
ルートテーブルの ID。 |
vtb-bp145q7glnuzdvzu2**** |
| RouteEntrys |
object |
||
| RouteEntry |
array<object> |
ルート情報。 |
|
|
array<object> |
ルート情報。 |
||
| Type |
string |
ルートの送信先タイプ。有効な値:
|
Custom |
| Status |
string |
ルートのステータス。有効な値:
|
Available |
| NextHopType |
string |
ネクストホップのタイプ。有効な値:
|
Instance |
| RouteEntryName |
string |
ルートの名前。 名前は 2~128 文字で、英字または中国語の文字で始まる必要があります。数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。 |
name |
| RouteEntryId |
string |
ルートの ID。 |
rte-bp1mnnr2al0naomnp**** |
| InstanceId |
string |
ネクストホップに関連付けられたインスタンスのインスタンス ID。 |
vpc-bp1t36rn9l53iwbsf**** |
| RouteTableId |
string |
ルートテーブルの ID。 |
vtb-bp15w5q90d2rk3bww**** |
| Description |
string |
ルートの説明。
説明は 2~256 文字で、英字または中国語の文字で始まる必要があります。 |
RouteEntryDescription |
| DestinationCidrBlock |
string |
ルートの送信先 CIDR ブロック。IPv4 と IPv6 の両方の送信先 CIDR ブロックがサポートされています。以下の要件を満たす必要があります:
|
192.168.2.0/24 |
| NextHops |
object |
||
| NextHop |
array<object> |
ネクストホップ情報。 |
|
|
object |
ネクストホップ情報。 |
||
| NextHopId |
string |
ネクストホップのインスタンス ID。 |
vpn-bp10zyaph5cc8b7c7**** |
| Weight |
integer |
ルートの重み。 |
100 |
| NextHopType |
string |
ネクストホップのタイプ。有効な値:
|
Instance |
| Enabled |
integer |
ルートが利用可能かどうかを示します。有効な値:
|
1 |
| VSwitchIds |
object |
||
| VSwitchId |
array |
vSwitch の ID。 |
|
|
string |
vSwitch の ID。 |
vsw-bp12mw1f8k3jgygk9**** |
例
成功レスポンス
JSONJSON
{
"PageSize": 10,
"RequestId": "DC668356-BCB4-42FD-9BC3-FA2B2E04B634",
"PageNumber": 1,
"TotalCount": 1,
"RouteTables": {
"RouteTable": [
{
"CreationTime": "2022-08-22T10:40:25Z",
"Status": "Available",
"VRouterId": "vrt-bp1lhl0taikrteen****",
"RouteTableType": "Custom",
"ResourceGroupId": "rg-acfmxazb4ph****",
"RouteTableId": "vtb-bp145q7glnuzdvzu2****",
"RouteEntrys": {
"RouteEntry": [
{
"Type": "Custom",
"Status": "Available",
"NextHopType": "Instance",
"RouteEntryName": "name",
"RouteEntryId": "rte-bp1mnnr2al0naomnp****",
"InstanceId": "vpc-bp1t36rn9l53iwbsf****",
"RouteTableId": "vtb-bp15w5q90d2rk3bww****",
"Description": "RouteEntryDescription",
"DestinationCidrBlock": "192.168.2.0/24",
"NextHops": {
"NextHop": [
{
"NextHopId": "vpn-bp10zyaph5cc8b7c7****",
"Weight": 100,
"NextHopType": "Instance",
"Enabled": 1
}
]
}
}
]
},
"VSwitchIds": {
"VSwitchId": [
"vsw-bp12mw1f8k3jgygk9****"
]
}
}
]
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidVRouterId.NotFound | Specified virtual router does not exist. | |
| 400 | OperationFailed.DescribeCenRoute | An error occurred while querying the CEN route entry. | CEN ルートのクエリ中にエラーが発生しました。 |
| 400 | OperationFailed.VRouterNotExist | Operation failed because the VRouter does not exist. | vRouter が存在しないため、操作は失敗しました。 |
| 400 | IllegalParam.Type | The parameter of Type is illegal. | Type パラメーターが無効です。 |
| 400 | OperationFailed.InvalidRouterType | The operation is failed because of %s. | ルータータイプが無効です。 |
| 400 | InvalidParam.RouterInstanceOrRouterId | The parameters routerInstanceId and routerId are mutually exclusive. Please use either routerInstanceId alone, or routerType with routerId. | リクエストに競合するパラメーターが含まれています。routerInstanceId のみを指定するか、routerType と routerId の両方を指定する必要があります。リクエストから競合するパラメーターの組み合わせを削除してください。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。