ニフクラAPI (Kubernetes Service Hatoba: ListFirewallGroups)

ListFirewallGroups

処理概要

ファイアウォールグループの情報一覧を取得します。
1回のリクエストで複数のファイアウォールグループ情報を取得できます。

リクエストURL

GET /v1/firewallGroups

指定するパラメーター

クエリパラメーター

パラメーター	型	説明	必須
filters	string	取得対象のファイアウォールグループのフィルター。タグのキーと値の組み合わせによってフィルタリング可能。 例) tags.owner=user01 AND tags.owner=user02

応答フィールド

フィールド (項目)	型	説明
firewallGroups[]	object[]
␣name	string	ファイアウォールグループ名
␣description	string	ファイアウォールグループのメモ
␣rules[]	object[]
␣␣protocol	string	許可プロトコル名 値: ANY TCP UDP ICMP SSH HTTP HTTPS RDP GRE ESP AH VRRP L2TP
␣␣direction	string	Incoming/Outgoing指定 値: IN (Incoming) OUT (Outgoing)
␣␣fromPort	integer	許可開始ポート
␣␣toPort	integer	許可終了ポート
␣␣cidrIp	string	許可するIPアドレス
␣␣description	string	許可ルールのメモ
␣␣status	string	ファイアウォールルールのステータス 値: AUTHORIZED (有効) AUTHORIZING (追加中) REVOKING (削除中) AUTH_FAILED (追加エラー) REVOKE_FAILED (削除エラー)
␣␣id	string	ファイアウォールルールID
␣nrn	string	NRN
␣tags[]	object[]
␣␣id	string	タグID
␣␣key	string	タグキー
␣␣value	string	タグ値

リクエストサンプル

    curl https://jp-east-1.hatoba.api.nifcloud.com/v1/firewallGroups
  -H "X-Amz-Date: 20190724T000000Z"
  -H "Authorization: AWS4-HMAC-SHA256 ..."

  

応答サンプル

    {
  "firewallGroups": [
    {
      "name": "testfw01",
      "description": "",
      "rules": [
        {
          "protocol": "TCP",
          "direction": "IN",
          "fromPort": 8081,
          "toPort": 8081,
          "cidrIp": "0.0.0.0/0",
          "description": "hogehoge",
          "status": "AUTHORIZED",
          "id": "00a3c298-3157-4b94-a1ee-1e893f51fa6e"
        }
      ],
      "nrn": "nrn:nifcloud:hatoba:jp-east-1:xxxxxxxx:firewall-group:69d38e60-a522-4e1a-a413-a5024e9b2aba",
      "tags": [
        {
          "id": "31fac2be-013e-4702-b5ba-5d49b7d8e7b7",
          "key": "key01",
          "value": "value01"
        }
      ]
    },
    {
      "name": "testfw02",
      "description": "",
      "rules": [
        {
          "protocol": "TCP",
          "direction": "IN",
          "fromPort": 8082,
          "toPort": 8082,
          "cidrIp": "0.0.0.0/0",
          "description": "fugafuga",
          "status": "AUTHORIZED",
          "id": "0c441024-56a0-4993-ba57-a3cd9fcd38d6"
        }
      ],
      "nrn": "nrn:nifcloud:hatoba:jp-east-1:xxxxxxxx:firewall-group:d96f43e0-d080-4abf-a2c5-7f29d2493c3d",
      "tags": []
    }
  ]
}