ニフクラAPI (DevOps with Gitlab: CreateFirewallGroup)

CreateFirewallGroup

処理概要

ファイアウォールグループを新規作成します。

リクエストURL

POST /v1/firewallGroups

指定するパラメーター

リクエストボディ

パラメーター	型	説明	必須
firewallGroupName	string	ファイアウォールグループ名 使用可能文字: 63文字以内の半角英数小文字と-ハイフンが利用可能(先頭と末尾の-は禁止)	○
availabilityZone	string	ファイアウォールグループを作成するゾーン(リージョンとゾーンの対応についてはゾーン別機能対応表を参照) デフォルト値:作成するリージョンに依存(jp-east-1：east-11／jp-east-3：east-31／jp-west-1：west-12／jp-west-2：jp-west-21) 値: east-11 east-12 east-13 east-14 east-31 west-12 west-13 jp-west-21
description	string	メモ 使用可能文字: 255文字以内の全角半角

応答フィールド

フィールド (項目)	型	説明
firewallGroup	object
␣region	string	ファイアウォールグループが稼働しているリージョン名
␣availabilityZone	string	ファイアウォールグループが稼働しているゾーン名
␣description	string	メモ
␣firewallGroupName	string	ファイアウォールグループ名
␣rules[]	object[]
␣␣id	string	ファイアウォールルールID
␣␣protocol	string	許可プロトコル 値: TCP ICMP
␣␣port	integer	許可ポート(ICMPの場合はnull)
␣␣cidrIp	string	許可IPアドレス 値: IPv4IP CIDR
␣␣description	string	メモ
␣␣state	string	ファイアウォールルールのステータス 値: AUTHORIZED (有効) AUTHORIZING (追加中(操作リクエストNG)) REVOKING (削除中(操作リクエストNG)) AUTH_FAILED (追加エラー(削除リクエストOK)) REVOKE_FAILED (削除エラー(削除リクエストOK))
␣state	string	ファイアウォールグループのステータス 値: APPLIED (適用済み(リクエストOK)) PROCESSING (処理中(操作リクエストNG)) FAILED (異常あり(**FAILEDのルールが存在する場合の表示)(削除リクエストOK))

リクエストサンプル

    curl -XPOST https://jp-east-1.devops.api.nifcloud.com/v1/firewallGroups
    -H 'X-Amz-Date: 20230401T000000Z'
    -H 'Authorization: AWS4-HMAC-SHA256 ...'
    -H 'content-type:application/json'
    -d '
{
    "firewallGroupName":"gitlab1fw",
    "availabilityZone":"east-11",
    "description":"production_fw"
}'

  

応答サンプル

    {
    "firewallGroup":{
        "region":"jp-east-1",
        "availabilityZone":"east-11",
        "description":"production_fw",
        "firewallGroupName":"gitlab1fw",
        "rules":[],
        "state":"CREATING"
    }
}