updatePolicy

Prev Next

Classic環境で利用できます。

Secure Zoneに適用するファイアウォールポリシーを変更します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /{type}/{zone}/updatePolicy

リクエストヘッダ

Secure Zone APIで共通して使用されるヘッダの詳細は、Secure Zoneのリクエストヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
type String Required Secure Zoneで提供するファイアウォールタイプ
  • szfw | psfw
    • szfw: Secure Zone Standard
    • psfw: Secure Zone Advanced
zone String Required Secure Zoneを構成したゾーン
  • kr1 | kr2
    • kr1: KR-1ゾーン
    • kr2: KR-2ゾーン

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
newPolicyName String Optional 変更後のポリシー名
  • 未入力時は既存の名前を維持
action String Required 許可するかどうか
  • allow | deny
description String Optional ポリシーの説明
destinationAddressGroupList[] Array Required 目的地に指定する Address Group情報
  • Address Groupは、あらかじめ作成した項目の中から選択
  • getAddressGroupListを通じて確認
  • 追加する Address Groupがなくても空状態のパラメータを入力
destinationAddressGroupList[].memberNo String Required ユーザーの NAVERクラウドプラットフォーム会員番号
destinationAddressGroupList[].instanceNo String Required インスタンス作成時に付与された契約番号
destinationAddressGroupList[].addressGroupNo Integer Required Address Groupに付与された固有番号
destinationAddressGroupList[].addressGroupName String Required 目的地 Address Groupの名前
destinationAddressGroupList[].addressList[] Array Optional Address Groupに属する Address情報
destinationAddressGroupList[].addressList[].memberNo String Optional ユーザーの NAVERクラウドプラットフォーム会員番号
destinationAddressGroupList[].addressList[].instanceNo String Optional インスタンス作成時に付与された契約番号
destinationAddressGroupList[].addressList[].addressNo Integer Required Addressに付与された固有番号
destinationAddressGroupList[].addressList[].addressZone String Required Addressが属するゾーンに関する情報
  • sz | os | vm | db | vpn | lb | kr1
    • sz: Secure Zone
    • os: Object Storage
    • vm: VM
    • db: Cloud DB
    • vpn: SSL VPNまたは IPsec VPN
    • lb: Load Balancer
    • kr1: KR-1ゾーン
destinationAddressGroupList[].addressList[].fqdn String Conditional 完全修飾ドメイン名(FQDN)
  • typefqdnの場合、必ず入力
destinationAddressGroupList[].addressList[].ip String Conditional IPアドレス
  • typeipmaskの場合、必ず入力
destinationAddressGroupList[].addressList[].maskBit Integer Optional サブネットマスクのビット値
  • Secure Zone Advancedタイプで使用可能
destinationAddressGroupList[].addressList[].name String Required 目的地 Addressの名前
destinationAddressGroupList[].addressList[].port String Optional ポート番号
  • addressZonedbtypefqdnの場合に入力
destinationAddressGroupList[].addressList[].type String Optional Addressタイプ情報
  • ipmask(デフォルト) | fqdn
    • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
    • fqdn: Fully qualified domain name(完全修飾ドメイン名)
destinationAddressGroupList[].addressZone String Required 目的地 Address Groupが属するゾーンに関する情報
destinationAddressGroupList[].description String Optional 目的地 Address Groupの説明
destinationAddressGroupList[].objectStorage Boolean Optional Object Storageの使用有無
  • true | false(デフォルト)
    • true: Object Storageを使用
    • false: Object Storageを使用しない
destinationAddressList[] Array Required 目的地に指定する個別 Address情報
  • 追加する Addressがなくても空状態のパラメータを入力
destinationAddressList[].memberNo String Optional ユーザーの NAVERクラウドプラットフォーム会員番号
destinationAddressList[].instanceNo String Optional インスタンス作成時に付与された契約番号
destinationAddressList[].addressNo Integer Optional Addressに付与された固有番号
destinationAddressList[].addressZone String Required Addressが属するゾーンに関する情報
  • sz | os | vm | db | vpn | lb | kr1
    • sz: Secure Zone
    • os: Object Storage
    • vm: VM
    • db: Cloud DB
    • vpn: SSL VPNまたは IPsec VPN
    • lb: Load Balancer
    • kr1: KR-1ゾーン
destinationAddressList[].fqdn String Conditional 完全修飾ドメイン名(FQDN)
  • typefqdnの場合、必ず入力
destinationAddressList[].ip String Conditional IPアドレス
  • typeipmaskの場合、必ず入力
destinationAddressList[].maskBit Integer Optional サブネットマスクのビット値
  • Secure Zone Advancedタイプで使用可能
destinationAddressList[].name String Required 目的地 Addressの名前
destinationAddressList[].port String Optional ポート番号
  • addressZonedbtypefqdnの場合に入力
destinationAddressList[].type String Optional Addressタイプ情報
  • ipmask(デフォルト) | fqdn
    • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
    • fqdn: Fully qualified domain name(完全修飾ドメイン名)
destinationAddressZone String Optional Addressが属するゾーンに関する情報
  • 未入力時は Address Groupまたは Addressといった下位情報で自動設定
memberNo String Required ユーザーの NAVERクラウドプラットフォーム会員番号
instanceNo String Required インスタンス作成時に付与された契約番号
policyNo String Required ポリシーに付与された固有番号
policyName String Required 既存のポリシー名
port String Optional ファイアウォールサービスのポート番号
protocol String Required ファイアウォールサービスのプロトコル
sourceAddressGroupList[] Array Required 出発地に指定する Address Group情報
  • Address Groupは、あらかじめ作成した項目の中から選択
  • getAddressGroupListを通じて確認
  • 追加する Address Groupがなくても空状態のパラメータを入力
sourceAddressGroupList[].memberNo String Required ユーザーの NAVERクラウドプラットフォーム会員番号
sourceAddressGroupList[].instanceNo String Required インスタンス作成時に付与された契約番号
sourceAddressGroupList[].addressGroupNo Integer Required Address Groupに付与された固有番号
sourceAddressGroupList[].addressGroupName String Required 出発地 Address Groupの名前
sourceAddressGroupList[].addressList[] Array Optional Address Groupに属する Address情報
sourceAddressGroupList[].addressList[].memberNo String Optional ユーザーの NAVERクラウドプラットフォーム会員番号
sourceAddressGroupList[].addressList[].instanceNo String Optional インスタンス作成時に付与された契約番号
sourceAddressGroupList[].addressList[].addressNo Integer Required Addressに付与された固有番号
sourceAddressGroupList[].addressList[].addressZone String Required Addressが属するゾーンに関する情報
  • sz | os | vm | db | vpn | lb | kr1
    • sz: Secure Zone
    • os: Object Storage
    • vm: VM
    • db: Cloud DB
    • vpn: SSL VPNまたは IPsec VPN
    • lb: Load Balancer
    • kr1: KR-1ゾーン
sourceAddressGroupList[].addressList[].fqdn String Conditional 完全修飾ドメイン名(FQDN)
  • typefqdnの場合、必ず入力
sourceAddressGroupList[].addressList[].ip String Conditional IPアドレス
  • typeipmaskの場合、必ず入力
sourceAddressGroupList[].addressList[].maskBit Integer Optional サブネットマスクのビット値
  • Secure Zone Advancedタイプで使用可能
sourceAddressGroupList[].addressList[].name String Required 出発地 Addressの名前
sourceAddressGroupList[].addressList[].port String Optional ポート番号
  • addressZonedbtypefqdnの場合に入力
sourceAddressGroupList[].addressList[].type String Optional Addressタイプ情報
  • ipmask(デフォルト) | fqdn
    • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
    • fqdn: Fully qualified domain name(完全修飾ドメイン名)
sourceAddressGroupList[].addressZone String Required 出発地 Address Groupが属するゾーンに関する情報
sourceAddressGroupList[].description String Optional 出発地 Address Groupの説明
sourceAddressGroupList[].objectStorage Boolean Optional Object Storageの使用有無
  • true | false(デフォルト)
    • true: Object Storageを使用
    • false: Object Storageを使用しない
sourceAddressList[] Array Required 出発地に指定する個別 Address情報
  • 追加する Addressがなくても空状態のパラメータを入力
sourceAddressList[].memberNo String Optional ユーザーの NAVERクラウドプラットフォーム会員番号
sourceAddressList[].instanceNo String Optional インスタンス作成時に付与された契約番号
sourceAddressList[].addressNo Integer Optional Addressに付与された固有番号
sourceAddressList[].addressZone String Required Addressが属するゾーンに関する情報
  • sz | os | vm | db | vpn | lb | kr1
    • sz: Secure Zone
    • os: Object Storage
    • vm: VM
    • db: Cloud DB
    • vpn: SSL VPNまたは IPsec VPN
    • lb: Load Balancer
    • kr1: KR-1ゾーン
sourceAddressList[].fqdn String Conditional 完全修飾ドメイン名(FQDN)
  • typefqdnの場合、必ず入力
sourceAddressList[].ip String Conditional IPアドレス
  • typeipmaskの場合、必ず入力
sourceAddressList[].maskBit Integer Optional サブネットマスクのビット値
  • Secure Zone Advancedタイプで使用可能
sourceAddressList[].name String Required 出発地 Addressの名前
sourceAddressList[].port String Optional ポート番号
  • addressZonedbtypefqdnの場合に入力
sourceAddressList[].type String Optional Addressタイプ情報
  • ipmask(デフォルト) | fqdn
    • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
    • fqdn: Fully qualified domain name(完全修飾ドメイン名)
sourceAddressZone String Optional Addressが属するゾーンに関する情報
  • 未入力時は Address Groupまたは Addressといった下位情報で自動設定

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://securezonefirewall.apigw.ntruss.com/api/v2/szfw/kr2/updatePolicy'
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-mbr_no: {User number}' \
--header 'Content-Type: application/json' \
--data '{
  "newPolicyName": "testpolicy",
  "action": "deny",
  "description": "policy2",
  "destinationAddressGroupList": [
    {
      "addressGroupName": "Object Storage",
      "addressGroupNo": 5441,
      "description": "",
      "addressList": [],
      "addressZone": "vm",
      "objectStorage": true
    }
  ],
  "destinationAddressList": [],
  "destinationAddressZone": "os",
  "policyName": "pol2",
  "port": "443",
  "protocol": "TCP",
  "sourceAddressGroupList": [],
  "sourceAddressList": [
    {
      "addressNo": 3644,
      "addressZone": "sz",
      "ip": "***.***.***.***",
      "name": "s1906cf93f79",
      "type": "ipmask"
    }
  ],
  "sourceAddressZone": "sz"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
action String - リクエストタイプ
returnCode Integer - レスポンスコード
returnMessage String - レスポンスメッセージ

レスポンスステータスコード

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "action": "updatePolicy",
    "returnCode": 0,
    "returnMessage": "success"
}