addPolicy
    • PDF

    addPolicy

    • PDF

    記事の要約

    Classic環境で利用できます。

    Secure Zoneに適用するファイアウォールポリシー(Policy)を追加します。

    リクエスト

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

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

    リクエストヘッダ

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

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

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

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

    リクエストボディ

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

    フィールドタイプ必須の有無説明
    actionStringRequired許可するかどうか
    • allow | deny
    descriptionStringOptionalポリシーの説明
    destinationAddressGroupList[]ArrayRequired目的地に指定する Address Group情報
    • Address Groupは、あらかじめ作成した項目の中から選択
    • getAddressGroupListを通じて確認
    • 追加する Address Groupがなくても空状態のパラメータを入力
    destinationAddressGroupList[].addressGroupNameStringOptional目的地 Address Groupの名前
    destinationAddressGroupList[].addressGroupNoIntegerOptionalAddress Groupに付与された固有番号
    destinationAddressGroupList[].descriptionStringOptional目的地 Address Groupの説明
    destinationAddressGroupList[].addressList[]ArrayRequiredAddress Groupに属する Address情報
    destinationAddressGroupList[].addressList[].addressNoIntegerOptionalAddressに付与された固有番号
    destinationAddressGroupList[].addressList[].addressZoneStringOptionalAddressが属するゾーンに関する情報
    • 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[].fqdnStringOptional完全修飾ドメイン名(FQDN)
    • typefqdnの場合、必ず入力
    destinationAddressGroupList[].addressList[].ipStringOptionalIPアドレス
    • typeipmaskの場合、必ず入力
    destinationAddressGroupList[].addressList[].maskBitIntegerOptionalサブネットマスクのビット値
    • Secure Zone Advancedタイプで使用可能
    destinationAddressGroupList[].addressList[].nameStringOptional目的地 Addressの名前
    destinationAddressGroupList[].addressList[].portStringOptionalポート番号
    • addressZonedbtypefqdnの場合に入力
    destinationAddressGroupList[].addressList[].typeStringOptionalAddressタイプ情報
    • ipmask(デフォルト) | fqdn
      • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
      • fqdn: Fully qualified domain name(完全修飾ドメイン名)
    destinationAddressGroupList[].addressZoneStringOptional目的地 Address Groupが属するゾーンに関する情報
    destinationAddressGroupList[].objectStorageBooleanOptionalObject Storageの使用有無
    • true | false(デフォルト)
      • true: Object Storageを使用
      • false: Object Storageを使用しない
    destinationAddressList[]ArrayRequired目的地に指定する個別 Address情報
    • 追加する Addressがなくても空状態のパラメータを入力
    destinationAddressList[].addressNoIntegerOptionalAddressに付与された固有番号
    destinationAddressList[].addressZoneStringOptionalAddressが属するゾーンに関する情報
    • 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[].fqdnStringOptional完全修飾ドメイン名(FQDN)
    • typefqdnの場合、必ず入力
    destinationAddressList[].ipStringOptionalIPアドレス
    • typeipmaskの場合、必ず入力
    destinationAddressList[].maskBitIntegerOptionalサブネットマスクのビット値
    • Secure Zone Advancedタイプで使用可能
    destinationAddressList[].nameStringOptional目的地 Addressの名前
    destinationAddressList[].portStringOptionalポート番号
    • addressZonedbtypefqdnの場合に入力
    destinationAddressList[].typeStringOptionalAddressタイプ情報
    • ipmask(デフォルト) | fqdn
      • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
      • fqdn: Fully qualified domain name(完全修飾ドメイン名)
    destinationAddressZoneStringOptionalAddressが属するゾーンに関する情報
    • 未入力時は Address Groupまたは Addressといった下位情報で自動設定
    policyNameStringRequiredポリシー名
    portStringOptionalファイアウォールサービスのポート番号
    protocolStringOptionalファイアウォールサービスのプロトコル
    sourceAddressGroupList[]ArrayRequired出発地に指定する Address Group情報
    • Address Groupは、あらかじめ作成した項目の中から選択
    • getAddressGroupListを通じて確認
    • 追加する Address Groupがなくても空状態のパラメータを入力
    sourceAddressGroupList[].addressGroupNoIntegerOptionalAddress Groupに付与された固有番号
    sourceAddressGroupList[].addressGroupNameStringOptional出発地 Address Groupの名前
    sourceAddressGroupList[].addressList[]ArrayRequiredAddress Groupに属する Address情報
    sourceAddressGroupList[].addressList[].addressNoIntegerOptionalAddressに付与された固有番号
    sourceAddressGroupList[].addressList[].addressZoneStringOptionalAddressが属するゾーンに関する情報
    • 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[].fqdnStringOptionalfqdn(完全修飾ドメイン名)
    • typefqdnの場合、必ず入力
    sourceAddressGroupList[].addressList[].ipStringOptionalIPアドレス
    • typeipmaskの場合、必ず入力
    sourceAddressGroupList[].addressList[].maskBitIntegerOptionalサブネットマスクのビット値
    • Secure Zone Advancedタイプで使用可能
    sourceAddressGroupList[].addressList[].nameStringOptional出発地 Addressの名前
    sourceAddressGroupList[].addressList[].portStringOptionalポート番号
    • addressZonedbtypefqdnの場合に入力
    sourceAddressGroupList[].addressList[].typeStringOptionalAddressタイプ情報
    • ipmask(デフォルト) | fqdn
      • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
      • fqdn: Fully qualified domain name(完全修飾ドメイン名)
    sourceAddressGroupList[].addressZoneStringOptional出発地 Address Groupが属するゾーンに関する情報
    sourceAddressGroupList[].descriptionStringOptional出発地 Address Groupの説明
    sourceAddressGroupList[].objectStorageBooleanOptionalオブジェクトストレージの使用有無
    • true | false(デフォルト)
      • true: オブジェクトストレージを使用
      • false: オブジェクトストレージを使用しない
    sourceAddressList[]ArrayRequired出発地に指定する個別 Address情報
    • 追加する Addressがなくても空状態のパラメータを入力
    sourceAddressList[].addressNoIntegerOptionalAddressに付与された固有番号
    sourceAddressList[].addressZoneStringOptionalAddressが属するゾーンに関する情報
    • 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[].fqdnStringOptionalfqdn(完全修飾ドメイン名)
    • typefqdnの場合、必ず入力
    sourceAddressList[].ipStringOptionalIPアドレス
    • typeipmaskの場合、必ず入力
    sourceAddressList[].maskBitIntegerOptionalサブネットマスクのビット値
    • Secure Zone Advancedタイプで使用可能
    sourceAddressList[].nameStringOptional出発地 Addressの名前
    sourceAddressList[].portStringOptionalポート番号
    • addressZonedbtypefqdnの場合に入力
    sourceAddressList[].typeStringOptionalAddressタイプ情報
    • ipmask(デフォルト) | fqdn
      • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
      • fqdn: Fully qualified domain name(完全修飾ドメイン名)
    sourceAddressZoneStringOptionalAddressが属するゾーンに関する情報
    • 未入力時は Address Groupまたは Addressといった下位情報で自動設定

    リクエスト例

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

    curl --location --request POST 'https://securezonefirewall.apigw.ntruss.com/api/v2/szfw/kr1/addPolicy'
    --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 '{
      "action": "allow",
      "description": "policy3",
      "destinationAddressGroupList": [
        {
          "addressGroupName": "dbgroup",
          "addressGroupNo": 5452,
          "description": "",
          "addressList": [
                    {
              "addressNo": 3646,
              "addressZone": "db",
              "fqdn": "db-****.cdb.ntruss.com",
              "ip": "***.***.***.***",
              "name": "test-db-001",
              "port": "3306",
              "type": "fqdn"
            }
          ],
          "addressZone": "db",
          "objectStorage": false
        }
      ],
      "destinationAddressList": [],
      "destinationAddressZone": "db",
      "policyName": "policy3",
      "port": "3306",
      "protocol": "TCP",
      "sourceAddressGroupList": [
            {
          "addressGroupNo": 5439,
          "addressGroupName": "grp111",
          "addressList": [
            {
              "addressNo": 3643,
              "addressZone": "sz",
              "ip": "***.***.***.***",
              "name": "sv-securezone",
              "type": "ipmask"
            }
          ],
          "addressZone": "sz",
          "description": "string",
          "objectStorage": false
        }
      ],
      "sourceAddressList": [],
      "sourceAddressZone": "sz"
    }'
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    actionString-リクエストタイプ
    returnCodeInteger-レスポンスコード
    returnMessageString-レスポンスメッセージ

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

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

    レスポンス例

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

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

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.