Cloud Enterprise Network (CEN) インスタンス配下のトランジットルーターインスタンスに関する情報を照会します。これには、インスタンスタイプ、インスタンスステータス、トランジットルーターインスタンス ID、およびマルチキャスト特徴が有効かどうかが含まれます。
操作説明
この操作を呼び出して CEN インスタンス配下のトランジットルーターインスタンスに関する情報をクエリする際、必要に応じて RegionId および TransitRouterId パラメーターを指定できます。これら 2 つのパラメーターの関係は以下の通りです。
RegionId または TransitRouterId を指定しない場合、CEN インスタンス配下のすべてのトランジットルーターインスタンスがクエリされます。
RegionId のみを指定した場合、CEN インスタンス配下の指定されたリージョンにあるトランジットルーターインスタンスがクエリされます。
TransitRouterId のみを指定した場合、CEN インスタンス配下の指定されたトランジットルーターインスタンスがクエリされます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cen:ListTransitRouters |
get |
CenInstance
*TransitRouter
TransitRouter
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| PageNumber |
integer |
任意 |
ページ番号。デフォルト値: 1。 |
1 |
| PageSize |
integer |
任意 |
ページングクエリにおける 1 ページあたりのエントリ数。有効な値: 1 ~ 50。デフォルト値: 10。ページングの詳細については、関連するパラメーターの説明をご参照ください。 |
10 |
| CenId |
string |
任意 |
CEN インスタンスの ID。 |
cen-j3jzhw1zpau2km**** |
| TransitRouterId |
string |
任意 |
トランジットルーターインスタンスの ID。 |
tr-uf654ttymmljlvh2x**** |
| RegionId |
string |
任意 |
トランジットルーターインスタンスのリージョン ID。 DescribeRegions 操作を呼び出してリージョン ID をクエリできます。 |
cn-hangzhou。 |
| Tag |
array<object> |
任意 |
タグ情報。 一度に最大 20 個のタグを指定できます。 |
|
|
object |
任意 |
タグ情報。 |
||
| Key |
string |
任意 |
リソースのタグキー。 タグキーは空文字列にできません。タグキーの長さは最大 64 文字で、 一度に最大 20 個のタグキーを指定できます。 |
TagKey。 |
| Value |
string |
任意 |
リソースのタグ値。 タグ値は空文字列、または最大 128 文字の長さにできます。 各タグキーは 1 つのタグ値に対応します。一度に最大 20 個のタグ値を指定できます。 |
TagValue。 |
| Status |
string |
任意 |
トランジットルーターインスタンスのステータス。有効な値:
|
Active。 |
| Type |
string |
任意 |
トランジットルーターインスタンスのタイプ。有効な値:
|
Enterprise。 |
| TransitRouterName |
string |
任意 |
トランジットルーターインスタンスの名前。 名前の長さは 1 ~ 128 文字で、 |
testname。 |
| FeatureFilter |
array<object> |
任意 |
トランジットルーターの特徴フィルター。 |
|
|
object |
任意 |
トランジットルーターの特徴フィルター。 |
||
| Key |
string |
任意 |
トランジットルーターの特徴フィルターのキー。現在サポートされているフィールド:
|
Multicast。 |
| Value |
array |
任意 |
トランジットルーターの特徴フィルターの値のリスト。キーが Multicast の場合、サポートされる値は 1 つだけです。有効な値:
|
|
|
string |
任意 |
トランジットルーターの特徴フィルターの値。キーが Multicast の場合の有効な値:
|
Enabled。 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答パラメーター。 |
||
| PageSize |
integer |
ページングクエリにおける 1 ページあたりのエントリ数。ページングの詳細については、関連するパラメーターの説明をご参照ください。 |
10 |
| RequestId |
string |
リクエスト ID。 |
68521297-5FA6-46CB-B4EB-658F1C68C8CC |
| PageNumber |
integer |
ページ番号。 |
1 |
| TotalCount |
integer |
返されたエントリの総数。 |
1 |
| TransitRouters |
array<object> |
トランジットルーターインスタンスのリスト。 |
|
|
array<object> |
トランジットルーターインスタンスの情報。 |
||
| CreationTime |
string |
トランジットルーターインスタンスが作成された時間。 時間は |
2021-03-15T09:39Z |
| Type |
string |
トランジットルーターインスタンスのタイプ。有効な値:
|
Enterprise。 |
| Status |
string |
トランジットルーターインスタンスのステータス。有効な値:
|
Active。 |
| TransitRouterId |
string |
トランジットルーターインスタンスの ID。 |
tr-bp1su1ytdxtataupl**** |
| TransitRouterDescription |
string |
トランジットルーターインスタンスの説明。 |
testdesc。 |
| TransitRouterName |
string |
トランジットルーターインスタンスの名前。 |
testname。 |
| CenId |
string |
CEN インスタンスの ID。 |
cen-j3jzhw1zpau2km**** |
| AliUid |
integer |
CEN インスタンスが属する Alibaba Cloud アカウントの ID。 |
1210123456123456 |
| RegionId |
string |
トランジットルーターインスタンスのリージョン ID。 |
cn-hangzhou。 |
| SupportMulticast |
boolean |
トランジットルーターインスタンスでマルチキャスト特徴が有効かどうかを示します。有効な値:
|
false。 |
| TransitRouterCidrList |
array<object> |
トランジットルーター CIDR ブロックのリスト。 |
|
|
object |
トランジットルーター CIDR ブロック。 |
||
| Cidr |
string |
トランジットルーターの CIDR ブロック。 |
192.168.1.0/24 |
| Name |
string |
CIDR ブロックの名前。 |
CIDRname |
| Description |
string |
CIDR ブロックの説明。 |
CIDRdesc |
| TransitRouterCidrId |
string |
CIDR ブロックの ID。 |
cidr-46p5ceg21e8152**** |
| PublishCidrRoute |
boolean |
システムがトランジットルーター CIDR ブロックのルートをトランジットルーターのルートテーブルに自動的に追加するかどうかを示します。
|
true |
| Tags |
array<object> |
タグのリスト。 |
|
|
object |
タグ情報。 |
||
| Key |
string |
タグキー。 |
TagKey |
| Value |
string |
タグ値。 |
TagValue |
例
成功レスポンス
JSONJSON
{
"PageSize": 10,
"RequestId": "68521297-5FA6-46CB-B4EB-658F1C68C8CC",
"PageNumber": 1,
"TotalCount": 1,
"TransitRouters": [
{
"CreationTime": "2021-03-15T09:39Z",
"Type": "Enterprise",
"Status": "Active",
"TransitRouterId": "tr-bp1su1ytdxtataupl****",
"TransitRouterDescription": "testdesc",
"TransitRouterName": "testname",
"CenId": "cen-j3jzhw1zpau2km****",
"AliUid": 1210123456123456,
"RegionId": "cn-hangzhou",
"SupportMulticast": false,
"TransitRouterCidrList": [
{
"Cidr": "192.168.1.0/24",
"Name": "CIDRname",
"Description": "CIDRdesc",
"TransitRouterCidrId": "cidr-46p5ceg21e8152****",
"PublishCidrRoute": true
}
],
"Tags": [
{
"Key": "TagKey",
"Value": "TagValue"
}
]
}
]
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidParameterCombination.TransitRouter | Region ID is required if no TransitRouterId or CenId specified. | Region、TransitRouterId、または CenId のいずれか 1 つ以上を指定する必要があります。 |
| 400 | InvalidOperation.UnsupportFilterValue | The specified FeatureFilter Value is not supported by this operation. | パラメーターに指定された FeatureFilter の Value が無効です。 |
| 400 | InvalidOperation.UnsupportFilter | The specified FeatureFilter is not supported by this operation. | パラメーターに指定された FeatureFilter が無効です。 |
| 400 | IllegalParam.TagValue | The tag values are not valid. | リクエストに指定されたタグ値が無効です。 |
| 400 | IllegalParam.TagKey | The tag keys are not valid. | リクエストに指定されたタグキーが無効です。 |
| 400 | InvalidParameter | Invalid parameter. | パラメーターが無効です。 |
| 400 | Unauthorized | The AccessKeyId is unauthorized. | アカウントにこの操作を実行する権限がありません。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。