ニフクラAPI (コンピューティング: DescribeSecurityGroups)

DescribeSecurityGroups

処理概要

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

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

指定するパラメーター

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

応答フィールド

フィールド (項目)	型	説明
DescribeSecurityGroupsResponse	-	DescribeSecurityGroups レスポンス Ancestor: なし Children: requestId | securityGroupInfo
requestId	string	リクエスト識別子 Ancestor: DescribeSecurityGroupsResponse Children: なし
securityGroupInfo	-	ファイアウォールグループ情報セット Ancestor: DescribeSecurityGroupsResponse Children: item
item	-	ファイアウォールグループ情報 Ancestor: securityGroupInfo Children: ownerId | groupName | groupDescription | groupStatus | ipPermissions | instancesSet | instanceUniqueIdsSet | routerSet | vpnGatewaySet | groupRuleLimit | groupLogLimit | groupLogFilterNetBios | groupLogFilterBroadcast | availabilityZone
ownerId	string	※空を返却 Ancestor: item Children: なし
groupName	string	ファイアウォールグループ名 Ancestor: item Children: なし
groupDescription	string	ファイアウォールグループのメモ Ancestor: item Children: なし
groupStatus	string	ファイアウォールグループのステータス 値: processing(適用中) | applied(適用済み) Ancestor: item Children: なし
ipPermissions	-	許可ルール情報セット Ancestor: item Children: item
item	-	許可ルール情報 Ancestor: ipPermissions Children: ipProtocol | fromPort | toPort | inOut | groups | ipRanges | description | addDatetime
ipProtocol	string	許可プロトコル名 値: ANY | TCP | UDP | ICMP | SSH | HTTP | HTTPS | RDP | GRE | ESP | AH | VRRP | L2TP | ICMPv6-all Ancestor: item Children: なし
fromPort	integer	許可開始ポート Ancestor: item Children: なし
toPort	integer	許可終了ポート Ancestor: item Children: なし
inOut	string	Incoming/Outgoing指定 値: IN(Incoming) | OUT(Outgoing) Ancestor: item Children: なし
groups	-	許可するファイアウォールグループ Ancestor: item Children: item
item	-	許可するファイアウォールグループの指定 Ancestor: groups Children: userId | groupName
userId	string	※空を返却 Ancestor: item Children: なし
groupName	string	許可するファイアウォールグループ名 Ancestor: item Children: なし
ipRanges	-	許可するIPアドレス Ancestor: item Children: item
item	-	許可するIPアドレスの指定 Ancestor: ipRanges Children: cidrIp
cidrIp	string	許可するIPアドレス（IPv4, IPv6） Ancestor: item Children: なし
description	string	許可ルールのメモ Ancestor: item Children: なし
addDatetime	timestamp	許可ルールをファイアウォールグループに追加した日時 Ancestor: item Children: なし
instancesSet	-	適用しているサーバー情報セット Ancestor: item Children: item
item	-	適用しているサーバー情報 Ancestor: instancesSet Children: instanceId
instanceId	string	サーバー名 Ancestor: item Children: なし
instanceUniqueIdsSet	-	適用しているサーバーユニークID情報セット Ancestor: item Children: item
item	-	適用しているサーバーユニークID情報 Ancestor: InstanceUniqueIdsSet Children: instanceUniqueId
instanceUniqueId	string	サーバーユニークID Ancestor: item Children: なし
routerSet	-	VM全体にFW適用しているルーター情報セット Ancestor: item Children: item
item	-	VM全体にFW適用しているルーター情報 Ancestor: routerSet Children: routerId | routerName
routerId	string	ルーターユニークID Ancestor: item Children: なし
routerName	string	ルーター名 Ancestor: item Children: なし
vpnGatewaySet	-	適用している拠点間VPNゲートウェイ情報セット Ancestor: item Children: item
item	-	適用している拠点間VPNゲートウェイ情報 Ancestor: vpnGatewaySet Children: vpnGatewayId | niftyVpnGatewayName
vpnGatewayId	string	拠点間VPNゲートウェイユニークID Ancestor: item Children: なし
niftyVpnGatewayName	string	拠点間VPNゲートウェイ名 Ancestor: item Children: なし
groupRuleLimit	integer	ルール数の上限 Ancestor: item Children: なし
groupLogLimit	integer	ログ取得件数 Ancestor: item Children: なし
groupLogFilterNetBios	boolean	WindowsサーバのBroadcast通信ログの抑止状態 Ancestor: item Children: なし
groupLogFilterBroadcast	boolean	ブロードキャスト通信ログの抑止状態 Ancestor: item Children: なし
availabilityZone	string	ゾーン情報 Ancestor: item Children: なし

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=DescribeSecurityGroups
  &GroupName.1=group01
  &CommonParams

  

応答サンプル

    <DescribeSecurityGroupsResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</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>
          <ipRanges>
            <item>
              <cidrIp>0.0.0.0/0</cidrIp>
            </item>
          </ipRanges>
          <description>GroupMemoUpdate</description>
          <addDatetime>2016-01-27T11:11:39+09:00</addDatetime>
        </item>
        <item>
          <ipProtocol>TCP</ipProtocol>
          <fromPort>80</fromPort>
          <toPort>81</toPort>
          <inOut>IN</inOut>
          <groups>
            <item>
              <userId></userId>
              <groupName>group</groupName>
            </item>
          </groups>
          <description>GroupMemo</description>
          <addDatetime>2016-01-27T11:12: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>false</groupLogFilterNetBios>
      <groupLogFilterBroadcast>true</groupLogFilterBroadcast>
      <availabilityZone>east-11</availabilityZone>
    </item>
  </securityGroupInfo>
</DescribeSecurityGroupsResponse>