getPolicyList
    • PDF

    getPolicyList

    • PDF

    記事の要約

    Classic環境で利用できます。

    ファイアウォールポリシーリストを照会します。

    リクエスト

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

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

    リクエストヘッダ

    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ゾーン

    リクエストボディ

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

    フィールドタイプ必須の有無説明
    pageIntegerOptionalページインデックス
    • 0(デフォルト)
    countPerPageIntegerOptionalページごとの項目数
    • 0(デフォルト)

    リクエスト例

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

    curl --location --request POST 'https://securezonefirewall.apigw.ntruss.com/api/v2/szfw/kr2/getPolicyList'
    --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 '{
      "countPerPage": 0,
      "page": 0
    }'
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    actionString-リクエストタイプ
    returnCodeInteger-レスポンスコード
    returnMessageString-レスポンスメッセージ
    totalCountInteger-総ポリシー数
    policyList[]Array-照会対象のポリシーリスト
    policyList[].policyNoInteger-ポリシーに付与された固有番号
    policyList[].policyNameString-ポリシー名
    policyList[].descriptionString-ポリシーの説明
    policyList[].actionString-許可するかどうか
    • allow | deny
    policyList[].memberNoString-ユーザーの NAVERクラウドプラットフォーム会員番号
    policyList[].instanceNoString-インスタンス作成時に付与された契約番号
    policyList[].sourceAddressList[]Array-出発地 Address情報
    policyList[].sourceAddressList[].addressNoInteger-Addressに付与された固有番号
    policyList[].sourceAddressList[].memberNoString-ユーザーの NAVERクラウドプラットフォーム会員番号
    policyList[].sourceAddressList[].instanceNoString-インスタンス作成時に付与された契約番号
    policyList[].sourceAddressList[].nameString-Addressの名前
    policyList[].sourceAddressList[].ipString-IPアドレス
    policyList[].sourceAddressList[].portString-ポート番号
    • addressZonedbtypefqdnの場合に表示
    policyList[].sourceAddressList[].typeString-Addressタイプ情報
    • ipmask | fqdn
      • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
      • fqdn: Fully qualified domain name(完全修飾ドメイン名)
    policyList[].sourceAddressList[].addressZoneString-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ゾーン
    policyList[].sourceAddressList[].fqdnString-完全修飾ドメイン名(FQDN)
    policyList[].sourceAddressList[].dbAddressZoneBoolean-DB Address Zoneかどうか
    policyList[].sourceAddressList[].maskBitInteger-サブネットマスクのビット値
    • Secure Zone Advancedタイプの場合に表示
    policyList[].sourceAddressGroupList[]Array-出発地 Address Group情報
    policyList[].sourceAddressGroupList[].addressGroupNoInteger-Address Groupに付与された固有番号
    policyList[].sourceAddressGroupList[].addressGroupNameString-Address Groupの名前
    policyList[].sourceAddressGroupList[].descriptionString-Address Groupの説明
    policyList[].sourceAddressGroupList[].memberNoString-ユーザーの NAVERクラウドプラットフォーム会員番号
    policyList[].sourceAddressGroupList[].instanceNoString-インスタンス作成時に付与された契約番号
    policyList[].sourceAddressGroupList[].addressList[].addressNoInteger-Addressに付与された固有番号
    policyList[].sourceAddressGroupList[].addressList[].memberNoString-ユーザーの NAVERクラウドプラットフォーム会員番号
    policyList[].sourceAddressGroupList[].addressList[].instanceNoString-インスタンス作成時に付与された契約番号
    policyList[].sourceAddressGroupList[].addressList[].nameString-Addressの名前
    policyList[].sourceAddressGroupList[].addressList[].ipString-IPアドレス
    policyList[].sourceAddressGroupList[].addressList[].portString-ポート番号
    • addressZonedbtypefqdnの場合に表示
    policyList[].sourceAddressGroupList[].addressList[].typeString-Addressタイプ情報
    • ipmask | fqdn
      • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
      • fqdn: Fully qualified domain name(完全修飾ドメイン名)
    policyList[].sourceAddressGroupList[].addressList[].addressZoneString-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ゾーン
    policyList[].sourceAddressGroupList[].addressList[].fqdnString-完全修飾ドメイン名(FQDN)
    policyList[].sourceAddressGroupList[].addressList[].dbAddressZoneBoolean-DB Address Zoneかどうか
    policyList[].sourceAddressGroupList[].addressList[].maskBitInteger-サブネットマスクのビット値
    • Secure Zone Advancedタイプの場合に表示
    policyList[].sourceAddressGroupList[].addressZoneString-出発地 Address Groupが属するゾーンに関する情報
    • 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ゾーン
    policyList[].sourceAddressGroupList[].associatedPoliciesCountInteger-使用しない
    policyList[].sourceAddressGroupList[].objectStorageBoolean-Object Storageの使用有無
    • true | false
      • true: Object Storageを使用
      • false: Object Storageを使用しない
    policyList[].destinationAddressList[]Array-目的地 Address情報
    policyList[].destinationAddressList[].addressNoInteger-Addressに付与された固有番号
    policyList[].destinationAddressList[].memberNoString-ユーザーの NAVERクラウドプラットフォーム会員番号
    policyList[].destinationAddressList[].instanceNoString-インスタンス作成時に付与された契約番号
    policyList[].destinationAddressList[].nameString-Addressの名前
    policyList[].destinationAddressList[].ipString-IPアドレス
    policyList[].destinationAddressList[].portString-ポート番号
    • addressZonedbtypefqdnの場合に表示
    policyList[].destinationAddressList[].typeString-Addressタイプ情報
    • ipmask | fqdn
      • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
      • fqdn: Fully qualified domain name(完全修飾ドメイン名)
    policyList[].destinationAddressList[].addressZoneString-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ゾーン
    policyList[].destinationAddressList[].fqdnString-完全修飾ドメイン名(FQDN)
    policyList[].destinationAddressList[].dbAddressZoneBoolean-DB Address Zoneかどうか
    policyList[].destinationAddressList[].maskBitInteger-サブネットマスクのビット値
    • Secure Zone Advancedタイプの場合に表示
    policyList[].destinationAddressGroupList[]Array-目的地 Address Group情報
    policyList[].destinationAddressGroupList[].addressGroupNoInteger-Address Groupに付与された固有番号
    policyList[].destinationAddressGroupList[].addressGroupNameString-Address Groupの名前
    policyList[].destinationAddressGroupList[].descriptionString-Address Groupの説明
    policyList[].destinationAddressGroupList[].memberNoString-ユーザーの NAVERクラウドプラットフォーム会員番号
    policyList[].destinationAddressGroupList[].instanceNoString-インスタンス作成時に付与された契約番号
    policyList[].destinationAddressGroupList[].addressList[].addressNoInteger-Addressに付与された固有番号
    policyList[].destinationAddressGroupList[].addressList[].memberNoString-ユーザーの NAVERクラウドプラットフォーム会員番号
    policyList[].destinationAddressGroupList[].addressList[].instanceNoString-インスタンス作成時に付与された契約番号
    policyList[].destinationAddressGroupList[].addressList[].nameString-Addressの名前
    policyList[].destinationAddressGroupList[].addressList[].ipString-IPアドレス
    policyList[].destinationAddressGroupList[].addressList[].portString-ポート番号
    • addressZonedbtypefqdnの場合に表示
    policyList[].destinationAddressGroupList[].addressList[].typeString-Addressタイプ情報
    • ipmask | fqdn
      • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
      • fqdn: Fully qualified domain name(完全修飾ドメイン名)
    policyList[].destinationAddressGroupList[].addressList[].addressZoneString-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ゾーン
    policyList[].destinationAddressGroupList[].addressList[].fqdnString-完全修飾ドメイン名(FQDN)
    policyList[].destinationAddressGroupList[].addressList[].dbAddressZoneBoolean-DB Address Zoneかどうか
    policyList[].destinationAddressGroupList[].addressList[].maskBitInteger-サブネットマスクのビット値
    • Secure Zone Advancedタイプの場合に表示
    policyList[].destinationAddressGroupList[].addressZoneString-目的地 Address Groupが属するゾーンに関する情報
    • 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ゾーン
    policyList[].destinationAddressGroupList[].associatedPoliciesCountInteger-使用しない
    policyList[].destinationAddressGroupList[].objectStorageBoolean-Object Storageの使用有無
    • true | false
      • true: Object Storageを使用
      • false: Object Storageを使用しない
    policyList[].sourceAddressZoneString-ポリシーの出発地 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ゾーン
    policyList[].destinationAddressZoneString-ポリシーの目的地 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ゾーン
    policyList[].serviceList[]Array-照会対象ポリシーのサービス情報
    policyList[].serviceList[].serviceNoInteger-ファイアウォールサービス番号
    policyList[].serviceList[].serviceNameString-ファイアウォールサービス名
    policyList[].serviceList[].protocolString-ファイアウォールサービスのプロトコル
    policyList[].serviceList[].portString-ファイアウォールサービスのポート番号
    policyList[].serviceList[].memberNoString-ユーザーの NAVERクラウドプラットフォーム会員番号
    policyList[].serviceList[].instanceNoString-インスタンス作成時に付与された契約番号
    policyList[].firewallPolicyIdInteger-ファイアウォールポリシーに付与された ID
    policyList[].firewallOrderInteger-ファイアウォールポリシーの順序

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

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

    レスポンス例

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

    {
      "action": "getPolicyList",
      "returnCode": 0,
      "returnMessage": "success",
      "totalCount": 1,
      "policyList": [
        {
          "policyNo": 11787,
          "policyName": "pol1",
          "description": "policy1",
          "action": "allow",
          "memberNo": "27***85",
          "instanceNo": "25****11",
          "sourceAddressList": [
            {
              "addressNo": 3643,
              "memberNo": "27***85",
              "instanceNo": "25****11",
              "name": "sv-securezone",
              "ip": "***.***.***.***",
              "type": "ipmask",
              "addressZone": "sz"
            }
          ],
          "sourceAddressGroupList": [],
          "destinationAddressList": [],
          "destinationAddressGroupList": [
            {
              "addressGroupNo": 5432,
              "addressGroupName": "Object Storage",
              "description": "object storage address group",
              "memberNo": "27***85",
              "instanceNo": "25****11",
              "addressList": [],
              "addressZone": "vm",
              "associatedPoliciesCount": 0,
              "objectStorage": true
            }
          ],
          "sourceAddressZone": "sz",
          "destinationAddressZone": "os",
          "serviceList": [
            {
              "serviceNo": 1371,
              "serviceName": "TCP_443",
              "protocol": "TCP",
              "port": "443",
              "memberNo": "27***85",
              "instanceNo": "25****11"
            }
          ],
          "firewallPolicyId": 1,
          "firewallOrder": 1
        }
      ]
    }
    

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

    What's Next
    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.