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

UpdateFirewallGroup

処理概要

指定したファイアウォールグループの設定を更新します。
リクエストボディパラメーターのいずれか(changedFirewallGroupName,description)は指定必須です。

リクエストURL

PUT /v1/firewallGroups/{FirewallGroupName}

指定するパラメーター

パスパラメーター

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

リクエストボディ

パラメーター	型	説明	必須
changedFirewallGroupName	string	更新するファイアウォールグループ名 使用可能文字: 63文字以内の半角英数小文字と-ハイフンが利用可能(先頭と末尾の-は禁止)
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 -XPUT https://jp-east-1.devops.api.nifcloud.com/v1/firewallGroups/gitlab1fw
    -H 'X-Amz-Date: 20230401T000000Z'
    -H 'Authorization: AWS4-HMAC-SHA256 ...'
    -H 'content-type:application/json'
    -d '
{
    "firewallGroupName":"gitlab1fw",
    "description":"production_fw"
}'

  

応答サンプル

    {
    "firewallGroup":{
        "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":"APPLIED"
    }
}