Create firewall rule

ファイアーウォールルールを作成します。

URI

/v2.0/fw/firewall_rules

HTTPメソッド

POST

リクエストパラメタ

キー 説明 型 必須/省略可
action ルールに一致するトラフィックに対して行うアクション (allowまたはdeny). xsd:string Optional
description ファイアーウォールルールの説明 (1024文字以内) xsd:string Optional
destination_ip_address 宛先IPアドレスまたはCIDR xsd:string Optional
destination_port 宛先ポート番号または宛先ポートの範囲

範囲の場合、以下の形式で指定してください。

 "<開始ポート番号>:<終了ポート番号>"

※「 <終了ポート番号>」は「<開始ポート番号>」より大きい値を指定してください。

例："80:82"

注意:
宛先ポートの範囲を上記以外の形式で指定した場合、ファイアーウォールルールを有効にできません。
 xsd:string Optional
enabled Falseに設定されている場合、ファイアーウォールポリシー内でこのルールが無効化されます。ルールをファイアーウォールポリシーから分離することなく、選択的にルールを無効化することができます。 xsd:bool Optional
name ファイアーウォールポリシー名 (255文字以内)

一意である必要はありません。

 xsd:string Optional
protocol ファイアーウォールルールに適用されるプロトコル

有効な値は、null、tcp、udp、icmpです。

値を省略、またはnullを指定した場合は、ファイアーウォールルールに全てのプロトコルが適用されます。

ファイアーウォールルールにsource_portまたはdestination_portを指定する際は、本パラメタにtcpまたはudpを指定してください。

tcpプロトコルとudpプロトコルそれぞれに、複数のルールを作成してください。

注意:
本パラメタにnullまたはicmpを指定した場合、source_port、destination_portの指定は有効になりません。
 xsd:string Optional
source_ip_address 発信元IPアドレスまたはCIDR xsd:string Optional
source_port 発信元ポート番号または発信元ポートの範囲

範囲の場合、以下の形式で指定してください。

 "<開始ポート番号>:<終了ポート番号>"

※「 <終了ポート番号>」は「<開始ポート番号>」より大きい値を指定してください。

例："80:82"

注意:
発信元ポートの範囲を上記以外の形式で指定した場合、ファイアーウォールルールを有効にできません。
 xsd:string Optional
availability_zone アベイラビリティゾーン名

指定しなかった場合、リソースはデフォルトのアベイラビリティゾーンに作成されます。

 xsd:string Optional

リクエスト例


{
    "firewall_rule": {
        "action": "allow",
        "destination_port": "80",
        "enabled": true,
        "name": "ALLOW_HTTP",
        "protocol": "tcp",
        "availability_zone": "AZ1"
    }
}

レスポンスステータス

ステータスコード 説明
201 Normal response codes
Unauthorized (401) Error response codes
Bad Request (400) Error response codes

レスポンスボディ(正常系)


{
    "firewall_rule": {
        "action": "allow",
        "description": "",
        "destination_ip_address": null,
        "destination_port": "80",
        "enabled": true,
        "firewall_policy_id": null,
        "id": "8722e0e0-9cc9-4490-9660-8c9a5732fbb0",
        "ip_version": 4,
        "name": "ALLOW_HTTP",
        "position": null,
        "protocol": "tcp",
        "shared": false,
        "source_ip_address": null,
        "source_port": null,
        "tenant_id": "45977fa2dbd7482098dd68d0d8970117",
        "availability_zone": "AZ1"
    }
}

レスポンスボディ(正常系)の説明

要素名 説明
action ルールに一致するトラフィックに対して行うアクション (allowまたはdeny)
description ファイアーウォールルールの説明 (1024文字以内)
destination_ip_address 宛先IPアドレスまたはCIDR
destination_port 宛先ポート番号または宛先ポートの範囲
enabled Falseに設定されている場合、ファイアーウォールポリシー内でこのルールが無効化されます。ルールをファイアーウォールポリシーから分離することなく、選択的にルールを無効化することができます。
firewall_policy_id 読み取り専用の項目です。関連付けられたファイアーウォールポリシーIDが自動的に設定されます。1つのファイアーウォールルールは、1つのファイアーウォールポリシーにだけ関連付けることができます。ただし、別のファイアーウォールポリシーに変更可能です。どのファイアーウォールポリシーにも関連付けない場合は、本属性を「null」にします。
id ファイアーウォールルールID
ip_version IPプロトコルのバージョン
name ファイアーウォールポリシー名 (255文字以内)。一意である必要はありません。
position ファイアーウォールルールにファイアーウォールポリシーを関連付ける際に自動的に設定される、読み取り専用の項目です。関連付けたファイアーウォールポリシーにおけるこのルールの順番を示します。数値は1から始まります。どのファイアーウォールポリシーにも関連付けられていない場合は、この属性を「null」にします。
protocol ファイアーウォールルールを適用するプロトコル。有効な値は、null、tcp、udp、icmpです。
shared このファイアーウォールルールを全プロジェクトで共有するかどうかを示します。この値は常に"False"です。
source_ip_address 発信元IPアドレスまたはCIDR
source_port 送信元ポート番号または送信元ポートの範囲
availability_zone アベイラビリティゾーン名