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

AuthorizeFirewallRules

処理概要

指定したファイアウォールグループにルールを追加します。
許可するプロトコルがTCPの場合、許可ポートの指定が必要です。

リクエストURL

POST /v1/firewallGroups/{FirewallGroupName}/rules

指定するパラメーター

パスパラメーター

パラメーター	型	説明	必須
FirewallGroupName	string	ファイアウォールグループ名	○

リクエストボディ

パラメーター	型	説明	必須
rules[]	object[]
␣protocol	string	許可するプロトコル(TCP, ICMP) 値: TCP ICMP	○
␣port	integer	許可するport番号 値: 22 (SSH) 443 (HTTPS)	○ (protocol=TCPの場合)
␣cidrIp	string	許可するIPアドレス(IPv4のみ) 値: IPv4IP CIDR	○
␣description	string	メモ 使用可能文字: 40文字以内の全角半角

応答フィールド

フィールド (項目)	型	説明
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/gitlab1fw/rules
    -H 'X-Amz-Date: 20230401T000000Z'
    -H 'Authorization: AWS4-HMAC-SHA256 ...'
    -H 'content-type:application/json'
    -d '
{
    "rules":[
        {
            "cidrIp":"x.x.x.x",
            "protocol":"TCP",
            "port":443,
            "description":"TCPRule"
        },
        {
            "cidrIp":"x.x.x.x",
            "protocol":"ICMP",
            "description":"ICMPRule"
        }
    ]
}'

  

応答サンプル

    {
    "region":"jp-east-1",
    "availabilityZone":"east-11",
    "description":"production_fw",
    "firewallGroupName":"gitlab1fw",
    "rules":[
        {
            "id":"FirewallRuleId1234567890abcdefgH",
            "cidrIp":"x.x.x.x",
            "protocol":"TCP",
            "port":443,
            "description":"TCPRule",
            "state":"AUTHORIZED"
        },
        {
            "id":"FirewallRuleId1234567890abcdefg2",
            "cidrIp":"x.x.x.x",
            "protocol":"ICMP",
            "description":"ICMPRule",
            "state":"AUTHORIZED"
        }
    ],
    "state":"PROCESSING"
}