Update firewall rule#
ファイアーウォールルールを更新します。
APIエンドポイント#
リージョン | APIエンドポイント |
---|---|
西日本リージョン3の場合 | https://networking.jp-west-3.cloud.global.fujitsu.com |
東日本リージョン3の場合 | https://networking.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
PUT
/v2.0/fw/firewall_rules/{firewall_rule_id}
HTTPステータスコード#
正常時:200
エラー時:400, 401, 404
リクエストパラメータの説明#
名前 | In | Type | デフォルト値 /必須指定 |
Description |
---|---|---|---|---|
firewall_rule_id | path | string | 必須 | ファイアーウォールルールのID |
firewall_rule | body | object | 必須 | ファイアーウォールルールのオブジェクト |
description | body | string | null 任意 |
リソースの説明 |
tenant_id | body | string | 任意 | リソースの所有者のプロジェクトID 管理者ユーザーだけは自分が所属するプロジェクト以外のプロジェクトIDを指定可能です。認証ポリシーでこのポリシーを変更することはできません。 |
enabled | body | boolean | 任意 | 「false」に設定されている場合、ファイアーウォールポリシー内でこのルールが無効化されます。ルールをファイアーウォールポリシーから分離することなく、選択的にルールを無効化することができます。 📒注: enabledがfalseのファイアーウォールルールは、ファイアーウォールポリシーへ追加できません。 |
ip_version | body | integer | 4 任意 |
IPプロトコルのバージョン |
destination_ip_address | body | string | 任意 | 宛先IPv4アドレスまたはCIDR |
source_ip_address | body | string | 任意 | 送信元IPアドレスまたはCIDR |
source_port | body | string | null 任意 |
送信元ポート番号または送信元ポートの範囲 範囲指定の場合、ポート番号はコロンで区切ってください。 例:80:90 |
action | body | string | deny 任意 |
ルールに一致するトラフィックに対して行うアクション 「allow」または「deny」です。 |
protocol | body | string | null 任意 |
ファイアーウォールルールに適用されるプロトコル 有効な値は、「null」、「tcp」、「udp」または「icmp」です。 ※大文字・小文字は区別しません。 |
destination_port | body | string | 任意 | 宛先ポート番号または宛先ポートの範囲 範囲指定の場合、ポート番号はコロンで区切ってください。 例:80:90 |
name | body | string | null 任意 |
リソース名 |
レスポンスボディ(正常系)の説明#
名前 | Type | Description |
---|---|---|
firewall_rule | object | ファイアーウォールルールのオブジェクト |
action | string | ルールに一致するトラフィックに対して行うアクション 「allow」または「deny」です。 |
description | string | リソースの説明 |
tenant_id | string | プロジェクトのID |
enabled | boolean | 「false」に設定されている場合、ファイアーウォールポリシー内でこのルールが無効化されます。ルールをファイアーウォールポリシーから分離することなく、選択的にルールを無効化することができます。 |
protocol | string | ファイアーウォールルールに適用されるプロトコル ファイアーウォールルールのプロトコルを指定する際は「null」を指定しないでください。「TCP」プロトコルと「UDP」プロトコルそれぞれに対して複数のルールを作成してください。 プロトコル名または数字で指定できます。 有効な値は、「null」、「tcp」、「udp」または「icmp」です。 |
ip_version | integer | IPプロトコルのバージョン |
destination_ip_address | string | 宛先IPv4アドレスまたはCIDR |
destination_port | string | 宛先ポート番号または宛先ポートの範囲 範囲の場合、ポート番号はコロンで区切られます。 例:80:90 |
enabled | boolean | 「false」に設定されている場合、ファイアーウォールポリシー内でこのルールが無効化されます。ルールをファイアーウォールポリシーから分離することなく、選択的にルールを無効化することができます。 |
firewall_policy_id | string | 読み取り専用の項目です。関連付けられたファイアーウォールポリシーIDが自動的に設定されます。1つのファイアーウォールルールは、1つのファイアーウォールポリシーにだけ関連付けることができます。ただし、別のファイアーウォールポリシーに変更可能です。どのファイアーウォールポリシーにも関連付けない場合は、本属性を「null」にします。 |
id | string | ファイアーウォールルールのID |
ip_version | integer | IPプロトコルのバージョン |
name | string | リソース名 |
position | integer | ファイアーウォールルールにファイアーウォールポリシーを関連付ける際に自動的に設定される、読み取り専用の項目です。関連付けたファイアーウォールポリシーにおけるこのルールの順番を示します。数値は1から始まります。どのファイアーウォールポリシーにも関連付けられていない場合は、この属性を「null」にします。 |
protocol | string | ファイアーウォールルールに設定するプロトコル 有効な値は、「null」、「tcp」、「udp」または「icmp」です。 |
shared | boolean | このファイアーウォールルールを全プロジェクトで共有するかどうかを表示します。この値は常に「false」です。 |
source_ip_address | string | 送信元IPアドレスまたはCIDR |
source_port | string | 送信元ポート番号または送信元ポートの範囲 範囲の場合、ポート番号はコロンで区切られます。 例:80:90 |
リクエスト例#
{ "firewall_rule": { "shared": "true" } }
レスポンス例#
{ "firewall_rule": { "action": "allow", "description": "", "destination_ip_address": null, "destination_port": "80", "enabled": true, "firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c", "id": "8722e0e0-9cc9-4490-9660-8c9a5732fbb0", "ip_version": 4, "name": "ALLOW_HTTP", "position": 1, "protocol": "tcp", "shared": true, "source_ip_address": null, "source_port": null, "tenant_id": "45977fa2dbd7482098dd68d0d8970117" } }