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

GetFirewallGroup

処理概要

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

リクエストURL

GET /v1/firewallGroups/{FirewallGroupName}

指定するパラメーター

パスパラメーター

パラメーター	型	説明	必須
FirewallGroupName	string	情報を取得したいファイアウォールグループ名、もしくはNRN	○

応答フィールド

フィールド (項目)	型	説明
firewallGroup	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/testfw
  -H "X-Amz-Date: 20190724T000000Z"
  -H "Authorization: AWS4-HMAC-SHA256 ..."

  

応答サンプル

    {
  "firewallGroup": {
    "name": "testfw",
    "description": "",
    "rules": [
      {
        "protocol": "TCP",
        "direction": "IN",
        "fromPort": 8080,
        "toPort": 8080,
        "cidrIp": "0.0.0.0/0",
        "description": "hogehoge",
        "status": "AUTHORIZED",
        "id": "796231cb-6cec-42f4-95ce-b6d1d97f024d"
      }
    ],
    "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"
      }
    ]
  }
}