本文へジャンプします。

ニフティクラウド APIリファレンス

DescribeSecurityGroups

処理概要

指定したファイアウォールグループの設定情報を取得します。

ファイアウォールグループを指定するためには、ファイアウォールグループ名が必要です。指定しない場合は、取得可能なすべてのファイアウォールグループの設定情報を取得します。

指定するパラメーター

パラメーター 説明 必須 サンプル値
GroupName.n ファイアウォールグループ名
Type : String
  group01
Filter.n.Name 絞り込み条件の項目名
Type : String
値 : description (グループのメモ) | group-name (ファイアウォールグループ名)
   
Filter.n.Value.m 絞り込み条件の値 (前方一致)
Type : String
   

応答フィールド

フィールド(項目) 説明 サンプル値
DescribeSecurityGroups
Response
DescribeSecurityGroups レスポンス
Type : DescribeSecurityGroupsResponseType
Ancestor : なし
Children : requestId, securityGroupInfo
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : DescribeSecurityGroupsResponse
Children : なし
f6dd8353-eb6b-6b4fd32e4f05
securityGroupInfo ファイアウォールグループ情報セット
Type : SecurityGroupSetType
Ancestor : DescribeSecurityGroupsResponse
Children : item
 
item ファイアウォールグループ情報
Type : SecurityGroupItemType
Ancestor : securityGroupInfo
Children : ownerId, groupName, groupDescription, groupStatus, ipPermissions, InstancesSet, instanceUniqueIdsSet, instancesNetworkInterfaceSet, routerSet,routerNetworkInterfaceSet,vpnGatewaySet,vpnGatewayNetworkInterfaceSet,groupRuleLimit, groupLogLimit, groupLogFilterNetBios, groupLogFilterBroadcast,availabilityZone, description
 
ownerId ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
groupName ファイアウォールグループ名
Type : xsd:string
Ancestor : item
Children : なし
group01
groupDescription ファイアウォールグループのメモ
Type : xsd:string
Ancestor : item
Children : なし
 
groupStatus ファイアウォールグループのステータス
Type : xsd:string
値 : processing (適用中) | applied (適用済み)
Ancestor : item
Children : なし
applied
ipPermissions 許可ルール情報セット
Type : IpPermissionSetType
Ancestor : item
Children : item
 
item 許可ルール情報
Type : IpPermissionType
Ancestor : ipPermissions
Children : ipProtocol, fromPort, toPort, inOut, groups, ipRanges, description, addDatetime
 
ipProtocol 許可プロトコル名
Type : xsd:string
値 : ANY | TCP | UDP | ICMP | SSH | HTTP | HTTPS | RDP | GRE | ESP | AH | VRRP | L2TP | ICMPv6-all
Ancestor : item
Children : なし
TCP
fromPort 許可開始ポート
Type : xsd:integer
Ancestor : item
Children : なし
80
toPort 許可終了ポート
Type : xsd:integer
Ancestor : item
Children : なし
81
inOut Incoming/Outgoing指定
Type : xsd: string
値 : IN (Incoming) | OUT (Outgoing)
Ancestor : item
Children : なし
IN
groups 許可するファイアウォールグループ
Type : UserIdGroupPairSetType
Ancestor : item
Children : item
 
item 許可するファイアウォールグループの指定
Type : UserIdGroupPairType
Ancestor : groups
Children : userId, groupName
 
userId ※返却値なし
Type : xsd: string
Ancestor : item
Children : なし
 
groupName 許可するファイアウォールグループ名
Type : xsd:string
Ancestor : item
Children : なし
 
ipRanges 許可するIPアドレス
Type : IpRangeSetType
Ancestor : item
Children : item
 
item 許可するIPアドレスの指定
Type : IpRangeItemType
Ancestor : ipRanges
Children : cidrIp
 
cidrIp 許可するIPアドレス(IPv4, IPv6)
Type : xsd:string
Ancestor : item
Children : なし
111.171.200.1/22
description 許可ルールのメモ
Type : xsd:string
Ancestor : item
Children : なし
 
addDatetime 許可ルールをファイアウォールグループに追加した日時
Type: xsd:dateTime
Ancestor: item
Children : なし
 
instancesSet 適用しているサーバー情報セット
Type : InstanceIdSetType
Ancestor : item
Children : item
 
item 適用しているサーバー情報
Type : InstanceIdType
Ancestor : InstancesSet
Children : InstanceId
 
instanceId サーバー名
Type : xsd:string
Ancestor : item
Children : なし
server03
instanceUniqueIdsSet 適用しているサーバーユニークID情報セット
Type : InstanceUniqueIdSetType
Ancestor : item
Children : item
 
item 適用しているサーバーユニークID情報
Type : InstanceUniqueIdType
Ancestor : InstanceUniqueIdsSet
Children : instanceUniqueId
 
instanceUniqueId サーバーユニークID
Type : xsd:string
Ancestor : item
Children : なし
i-hrfg1234
instancesNetworkInterfaceSet ネットワークインターフェースごとにFW適用しているサーバー情報セット
Type : InstancesNetworkInterfaceSetType
Ancestor : item
Children : item
 
item ネットワークインターフェースごとにFW適用しているサーバー情報
Type : InstancesNetworkInterfaceType
Ancestor : instancesNetworkInterfaceSet
Children : instanceId, instanceUniqueId, networkId, deviceIndex, ipAddress
 
instanceId サーバー名
Type : xsd:string
Ancestor : item
Children : なし
 
instanceUniqueId サーバーユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
networkId ネットワークユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
deviceIndex デバイス番号
Type : xsd:string
Ancestor : item
Children : なし
 
ipAddress IPアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
routerSet VM全体にFW適用しているルーター情報セット
Type : RouterSetType
Ancestor : item
Children : item
 
item VM全体にFW適用しているルーター情報
Type : RouterType
Ancestor : routerSet
Children : routerId, routerName
 
routerId ルーターユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
routerName ルーター名
Type : xsd:string
Ancestor : item
Children : なし
 
routerNetworkInterfaceSet ネットワークインターフェイスごとにFW適用しているルーター情報セット
Type : RouterNetworkInterfaceSetType
Ancestor : item
Children : item
 
item ネットワークインターフェイスごとにFW適用しているルーター情報
Type : RouterNetworkInterfaceType
Ancestor : routerNetworkInterfaceSet
Children : routerId, routerName, networkId, deviceIndex, ipAddress
 
routerId ルーターユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
routerName ルーター名
Type : xsd:string
Ancestor : item
Children : なし
 
networkId ネットワークユニークID名
Type : xsd:string
Ancestor : item
Children : なし
 
deviceIndex デバイス番号
Type : xsd:string
Ancestor : item
Children : なし
 
ipAddress IPアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
vpnGatewaySet 適用しているVPNゲートウェイ情報セット
Type : VpnGatewaySetType
Ancestor : item
Children : item
 
item 適用しているVPNゲートウェイ情報
Type : VpnGatewayType
Ancestor : vpnGatewaySet
Children : vpnGatewayId, niftyVpnGatewayName
 
vpnGatewayId VPNゲートウェイユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
niftyVpnGatewayName VPNゲートウェイ名
Type : xsd:string
Ancestor : item
Children : なし
 
vpnGatewayNetworkInterfaceSet ネットワークインターフェイスごとにFW適用しているVPNゲートウェイ情報セット
Type : VpnGatewayNetworkInterfaceSetType
Ancestor : item
Children : item
 
item ネットワークインターフェイスごとにFW適用しているVPNゲートウェイ情報
Type : VpnGatewayNetworkInterfaceType
Ancestor : vpnGatewayNetworkInterfaceSet
Children : vpnGatewayId, niftyVpnGatewayName, networkId, deviceIndex, ipAddress
 
vpnGatewayId VPNゲートウェイユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
niftyVpnGatewayName VPNゲートウェイ名
Type : xsd:string
Ancestor : item
Children : なし
 
networkId ネットワークユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
deviceIndex デバイス番号
Type : xsd:string
Ancestor : item
Children : なし
 
ipAddress IPアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
groupRuleLimit ルール数の上限
Type : xsd: int
Ancestor : item
Children : なし
10
groupLogLimit ログ取得件数
Type : xsd:int
Ancestor : item
Children : なし
1000
groupLogFilterNetBios WindowsサーバのBroadcast通信ログの抑止状態
Type : xsd:boolean
Ancestor : item
Children : なし
 
groupLogFilterBroadcast ブロードキャスト通信ログの抑止状態
Type:xsd:boolean
Ancestor : item
Children : なし
 
availabilityZone ゾーン情報
Type: xsd:string
Ancestor: item
Children: なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=DescribeSecurityGroups&GroupName.1=group01&CommonParams

応答サンプル

<DescribeSecurityGroupsResponse xmlns="https://cp.cloud.nifty.com/api/">
 <requestId>320fc738-a1c7-4a2f-abcb-20813a4e997c</requestId>
 <securityGroupInfo>
  <item>
   <ownerId />
   <groupName>group1</groupName>
   <groupDescription>Security Group memo.</groupDescription>
   <groupStatus>applied</groupStatus>
   <ipPermissions>
    <item>
     <ipProtocol>TCP</ipProtocol>
     <fromPort>80</fromPort>
     <toPort>81</toPort>
     <inOut>IN</inOut>
     <groups />
     <ipRanges>
      <item>
       <cidrIp>0.0.0.0/0</cidrIp>
      </item>
      <item>
       <cidrIp>1:1:1:1:1:1:1:1/64</cidrIp>
      </item>
     </ipRanges>
     <description>GroupMemoUpdate</description>
     <addDateTime>2016-01-27T11:11:39+09:00</addDateTime>
    </item>
   </ipPermissions>
   <instancesSet>
    <item>
     <instanceId>server03</instanceId>
    </item>
   </instancesSet>
   <instanceUniqueIdsSet>
    <item>
     <instanceUniqueId>i-hrfg1234</instanceUniqueId>
    </item>
   </instanceUniqueIdsSet>
   <routerSet>
    <item>
     <routerId>rt-8db04f81</routerId>
     <routerName>router01</routerName>
    </item>
   </routerSet>
   <vpnGatewaySet>
    <item>
     <vpnGatewayId>vgw-cdj1124w</vpnGatewayId>
     <niftyVpnGatewayName>vpn1</niftyVpnGatewayName>
    </item>
   </vpnGatewaySet>
   <groupRuleLimit>10</groupRuleLimit>
   <groupLogLimit>1000</groupLogLimit>
   <groupLogFilterNetBios>true</groupLogFilterNetBios>
   <groupLogFilterBroadcast>false</groupLogFilterBroadcast>
   <availabilityZone>east-11</availabilityZone>
  </item>
 </securityGroupInfo>
</DescribeSecurityGroupsResponse>

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフティクラウド公式フェイスブックページ

推奨画面サイズ 1024×768 以上