Update firewall
ステータスがPENDING_*でなければ、ファイアーウォールを更新します。
URI
/v2.0/fw/firewalls/{firewall-id}
HTTPメソッド
PUT
リクエストパラメタ
キー | 説明 | 型 | 必須/省略可 |
---|---|---|---|
admin_state_up | ファイアーウォールの管理状態。"false"(停止中)の場合、ファイアーウォールはパケット転送を行わず、ファイアーウォールの内側にある仮想マシンに対する全送受信トラフィックを破棄します。 | xsd:bool | Optional |
firewall_policy_id | このファイアーウォールに関連付けさられているファイアーウォールポリシーID。ここで指定したファイアーウォールポリシーに含まれるルールを実装することになります。 | csapi:uuid | Optional |
router_id | このファイアーウォールが適用されている仮想ルータのID
このパラメータを指定しない場合、プロジェクト内のすべての仮想ルータに対してファイアーウォールが作成されます。 なお、router_idsが既に指定されている場合は、router_idは指定できません。 |
xsd:string | Optional (非推奨) |
router_ids | このファイアーウォールが適用される仮想ルータのIDのリスト
router_idsとrouter_idの両方を指定した場合、router_idsで指定されたすべての仮想ルータに対してファイアーウォールが作成されます。 |
xsd:string | Optional |
description | ファイアーウォールの説明 (1024文字以内) | xsd:string | Optional |
name | ファイアーウォール名(255文字以内)
一意である必要はありません。 |
xsd:string | Optional |
注意:
「router_id」は推奨されないパラメータです。新しいパラメータ「router_ids」への円滑な移行のために残されています。「router_ids」を使用してください。将来的に削除される可能性があります。
注意:
router_id 属性を有効になっている firewall は router_ids 属性をリクエストパラメタに指定して更新することで、router_id 属性は無効となり、router_ids 属性だけが有効になります。
リクエスト例
{
"firewall": {
"admin_state_up": "false"
}
}
レスポンスステータス
ステータスコード | 説明 |
---|---|
200 | Normal response codes |
Bad Request (400) | Error response codes |
Unauthorized (401) | Error response codes |
Not Found (404) | Error response codes |
conflict (409) | Error response codes |
レスポンスボディ(正常系)
{
"firewall": {
"status": "PENDING_UPDATE",
"router_ids": [
"fe00194c-d73c-4b46-b94a-622bf28fc9e2"
],
"name": "",
"admin_state_up": false,
"tenant_id": "45977fa2dbd7482098dd68d0d8970117",
"firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
"id": "3b0ef8f4-82c7-44d4-a4fb-6177f9a21977",
"description": "",
"availability_zone": "AZ1"
}
}
レスポンスボディ(正常系)の説明
要素名 | 説明 |
---|---|
admin_state_up | ファイアーウォールの管理状態
"false"(停止中)の場合、ファイアーウォールはパケット転送を行わず、ファイアーウォールの内側にある仮想マシンに対する全送受信トラフィックを破棄します。 |
description | ファイアーウォールの説明 (1024文字以内) |
firewall_policy_id | このファイアーウォールに関連付けさられているファイアーウォールポリシーID
ここで指定したファイアーウォールポリシーに含まれるルールを実装することになります。 |
id | ファイアーウォールID |
name | ファイアーウォールポリシー名 (255文字以内) 一意である必要はありません。 |
status | ファイアーウォールのステータス
値は次のいずれかです: ACTIVE, INACTIVE, DOWN, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. |
tenant_id | ファイアーウォールの所有者 自分のプロジェクト以外のプロジェクト識別子を指定できるユーザーは管理者だけです。 |
router_id(非推奨) | このファイアーウォールが適用されている仮想ルータのID |
router_ids | このファイアーウォールが適用される仮想ルータのIDのリスト |
availability_zone | アベイラビリティゾーン名 |
注意:
「router_id」は推奨されないパラメータです。新しいパラメータ「router_ids」への円滑な移行のために残されています。「router_ids」を使用してください。将来的に削除される可能性があります。
注意:
レスポンスの router_id 属性と router_ids 属性は当該 firewall のどちらか有効になっているものだけが含まれます。