DescribeNetworks を呼び出し、ネットワークの一覧を取得します。
操作説明
API 呼び出し頻度:1 秒あたり 100 回。
ユーザーごとの呼び出し頻度:1 秒あたり 10 回。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ens:DescribeNetworks |
list |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| NetworkId |
string |
任意 |
ネットワーク ID。 |
n-5*** |
| EnsRegionId |
string |
任意 |
ENS エッジゾーン ID。 |
cn-beijing-telecom |
| NetworkName |
string |
任意 |
ネットワーク名。 |
example |
| PageNumber |
integer |
任意 |
ページ番号。デフォルト値: 1。 |
1 |
| PageSize |
integer |
任意 |
ページングクエリにおける1ページあたりのエントリ数。最大値: 50。デフォルト値: 10。 |
10 |
| EnsRegionIds |
array |
任意 |
ENS エッジゾーン ID の配列。配列の長さ: 1~100。 |
|
|
string |
任意 |
ENS エッジゾーン ID。 |
cn-chengdu-telecom-4 |
|
| NetworkIds |
array |
任意 |
ネットワーク ID の配列。配列の長さ: 1~100。 |
|
|
string |
任意 |
ネットワーク ID。 |
n-5***9iu |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスのスキーマ |
||
| RequestId |
string |
リクエスト ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| TotalCount |
integer |
エントリの総数。 |
3 |
| PageSize |
integer |
現在のクエリにおけるページあたりのエントリ数。 |
2 |
| PageNumber |
integer |
現在のページ番号。 |
1 |
| Networks |
object |
||
| Network |
array<object> |
ネットワークのリスト。 |
|
|
array<object> |
ネットワークの詳細。 |
||
| EnsRegionId |
string |
ENS エッジゾーン ID。 |
cn-beijing |
| NetworkId |
string |
ネットワーク ID。 |
n-5*** |
| NetworkName |
string |
ネットワーク名。 |
example |
| CidrBlock |
string |
ネットワークの IPv4 CIDR ブロック。 |
10.0.xx.xx/24 |
| Status |
string |
ネットワークのステータス。有効な値:
|
Available |
| Description |
string |
ネットワークの説明。 |
exampleDescription |
| CreatedTime |
string |
作成時刻。ミリ秒単位の UNIX タイムスタンプです。 |
1653620630000 |
| VSwitchIds |
object |
||
| VSwitchId |
array |
ネットワーク内の vSwitch のリスト。 |
|
|
string |
vSwitch ID。 |
vsw-bp1nhbnpv2blyz8dl**** |
|
| RouterTableId |
string |
ルートテーブル ID。 |
rtb-5** |
| NetworkAclId |
string |
ネットワーク ACL ID。 |
nacl-a2do9e413e0spxscd**** |
| RouteTableIds |
object |
||
| RouteTableId |
array |
ルートテーブル ID のリスト。 |
|
|
string |
ルートテーブル ID。 |
rt-5*****pks |
|
| RouteTableId |
string |
Route table ID. |
rt-5*****pks |
| GatewayRouteTableId |
string |
ゲートウェイルートテーブル ID。 |
rt-5*****tbs |
| Tags |
object |
||
| Tag |
array<object> |
タグのコレクション。 |
|
|
object |
タグの詳細。 |
||
| Value |
string |
タグ値。 |
TestValue |
| Key |
string |
タグキー。 |
TestKey |
TagValue
deprecated
|
string |
タグ値。 |
TestValue |
TagKey
deprecated
|
string |
タグキー。 |
TestKey |
| SecondaryCidrBlocks |
object |
||
| SecondaryCidrBlock |
array |
セカンダリ CIDR ブロックに関する情報。 |
|
|
string |
セカンダリ CIDR ブロック。 |
172.XX.XX.0/12 |
|
| Ipv6CidrBlocks |
object |
||
| Ipv6CidrBlock |
array<object> |
||
|
object |
|||
| Ipv6Isp |
string |
telecom |
|
| Ipv6CidrBlock |
string |
2408:XXXX:0:a600::/110 |
|
| Type |
string |
system |
例
成功レスポンス
JSONJSON
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"TotalCount": 3,
"PageSize": 2,
"PageNumber": 1,
"Networks": {
"Network": [
{
"EnsRegionId": "cn-beijing",
"NetworkId": "n-5***",
"NetworkName": "example",
"CidrBlock": "10.0.xx.xx/24",
"Status": "Available",
"Description": "exampleDescription",
"CreatedTime": "1653620630000",
"VSwitchIds": {
"VSwitchId": [
"vsw-bp1nhbnpv2blyz8dl****"
]
},
"RouterTableId": "rtb-5**",
"NetworkAclId": "nacl-a2do9e413e0spxscd****",
"RouteTableIds": {
"RouteTableId": [
"rt-5*****pks"
]
},
"RouteTableId": "rt-5*****pks",
"GatewayRouteTableId": "rt-5*****tbs",
"Tags": {
"Tag": [
{
"Value": "TestValue",
"Key": "TestKey",
"TagValue": "TestValue",
"TagKey": "TestKey"
}
]
},
"SecondaryCidrBlocks": {
"SecondaryCidrBlock": [
"172.XX.XX.0/12"
]
},
"Ipv6CidrBlocks": {
"Ipv6CidrBlock": [
{
"Ipv6Isp": "telecom",
"Ipv6CidrBlock": "2408:XXXX:0:a600::/110",
"Type": "system"
}
]
}
}
]
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | ens.interface.error | Failed to call API. | |
| 400 | NoPermission | Permission denied. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。