computing / Client / nifty_describe_routers
nifty_describe_routers
- computing.Client.nifty_describe_routers(**kwargs)
指定したルーターの情報の取得をします。
ルーターを指定するためには、ルーターユニークIDまたはルーター名が必要です。
ルーターを指定しない場合、取得できるすべてのルーター情報を取得します。
絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字(曖昧検索)指定可能です。「∗」は0 個以上任意文字、「?」は1 個任意文字、「¥」はエスケープ変換文字(「¥∗niftycloud¥?¥¥ 」は「∗niftycloud?¥」を検索)となります。曖昧検索が指定可能な絞り込み条件の項目名、router-name、description になります。
See also: NIFCLOUD API Documentation
Request Syntax
response = client.nifty_describe_routers( Filter=[ { 'ListOfRequestValue': [ 'string', ], 'Name': 'availability-zone'|'state'|'router-id'|'router-name'|'description'|'accountingType'|'type'|'ip-address'|'version'|'latest-version-information' }, ], RouterId=[ 'string', ], RouterName=[ 'string', ] )
- Parameters:
Filter (list) –
(dict) –
ListOfRequestValue (list) –
(string) –
Name (string) –
RouterId (list) –
(string) –
RouterName (list) –
(string) –
- Return type:
dict
- Returns:
Response Syntax
{ 'RequestId': 'string', 'RouterSet': [ { 'AccountingType': 'string', 'AvailabilityZone': 'string', 'BackupInformation': { 'ExpirationDate': datetime(2015, 1, 1), 'IsBackup': True|False }, 'CreatedTime': datetime(2015, 1, 1), 'Description': 'string', 'GroupSet': [ { 'GroupId': 'string' }, ], 'NatTableAssociationId': 'string', 'NatTableId': 'string', 'NetworkInterfaceSet': [ { 'CidrBlock': 'string', 'Description': 'string', 'DeviceIndex': 'string', 'Dhcp': True|False, 'DhcpConfigId': 'string', 'DhcpOptionsId': 'string', 'IpAddress': 'string', 'NetworkId': 'string', 'NetworkName': 'string' }, ], 'NextMonthAccountingType': 'string', 'RouteTableAssociationId': 'string', 'RouteTableId': 'string', 'RouterId': 'string', 'RouterName': 'string', 'State': 'string', 'TagSet': [ { 'Key': 'string', 'Value': 'string' }, ], 'Type': 'string', 'VersionInformation': { 'IsLatest': True|False, 'Version': 'string' } }, ] }
Response Structure
(dict) –
RequestId (string) –
RouterSet (list) –
(dict) –
AccountingType (string) –
AvailabilityZone (string) –
BackupInformation (dict) –
ExpirationDate (datetime) –
IsBackup (boolean) –
CreatedTime (datetime) –
Description (string) –
GroupSet (list) –
(dict) –
GroupId (string) –
NatTableAssociationId (string) –
NatTableId (string) –
NetworkInterfaceSet (list) –
(dict) –
CidrBlock (string) –
Description (string) –
DeviceIndex (string) –
Dhcp (boolean) –
DhcpConfigId (string) –
DhcpOptionsId (string) –
IpAddress (string) –
NetworkId (string) –
NetworkName (string) –
NextMonthAccountingType (string) –
RouteTableAssociationId (string) –
RouteTableId (string) –
RouterId (string) –
RouterName (string) –
State (string) –
TagSet (list) –
(dict) –
Key (string) –
Value (string) –
Type (string) –
VersionInformation (dict) –
IsLatest (boolean) –
Version (string) –