MENU
      getPolicyList

        getPolicyList


        Article summary

        Available in Classic

        Get the list of firewall policies.

        Request

        The following describes the request format for the endpoint. The request format is as follows:

        MethodURI
        POST/{type}/{zone}/getPolicyList

        Request headers

        For headers common to Secure Zone APIs, see Secure Zone request headers.

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        typeStringRequiredfirewall type provided by Secure Zone
        • szfw | psfw
          • szfw: Secure Zone Standard
          • psfw: Secure Zone Advanced
        zoneStringRequiredZone in which Secure Zone is configured
        • kr1 | kr2
          • kr1: KR-1 zone
          • kr2: KR-2 zone

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        pageIntegerOptionalPage index
        • 0 (default)
        countPerPageIntegerOptionalNumber of items per page
        • 0 (default)

        Request example

        The following is a sample request.

        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
        }'
        Curl

        Response

        The following describes the response format.

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        actionString-Request type
        returnCodeInteger-Response code
        returnMessageString-Response message
        totalCountInteger-Total number of policies
        policyList[]Array-List of policies to view
        policyList[].policyNoInteger-Unique number assigned to the policy
        policyList[].policyNameString-Policy name
        policyList[].descriptionString-Policy description
        policyList[].actionString-Allow/deny
        • allow | deny
        policyList[].memberNoString-User's NAVER Cloud Platform member ID
        policyList[].instanceNoString-Contract number assigned when creating the instance
        policyList[].sourceAddressList[]Array-Origin address information
        policyList[].sourceAddressList[].addressNoInteger-Unique number assigned to the address
        policyList[].sourceAddressList[].memberNoString-User's NAVER Cloud Platform member ID
        policyList[].sourceAddressList[].instanceNoString-Contract number assigned when creating the instance
        policyList[].sourceAddressList[].nameString-Address name
        policyList[].sourceAddressList[].ipString-IP address
        policyList[].sourceAddressList[].portString-Port number
        • It is displayed if addressZone is db and type is fqdn
        policyList[].sourceAddressList[].typeString-Address type information
        • ipmask | fqdn
          • ipmask: address defined by IP address and subnet mask
          • fqdn: fully qualified domain name (full domain name)
        policyList[].sourceAddressList[].addressZoneString-Information for the zone the address belongs to
        • sz | os | vm | db | vpn | lb | kr1
          • sz: Secure Zone
          • os: Object Storage
          • vm: VM
          • db: Cloud DB
          • vpn: SSL VPN or IPsec VPN
          • lb: Load Balancer
          • kr1: KR-1 zone
        policyList[].sourceAddressList[].fqdnString-Full domain name (FQDN)
        policyList[].sourceAddressList[].dbAddressZoneBoolean-DB address zone status
        policyList[].sourceAddressList[].maskBitInteger-Subnet mask bit value
        • It is displayed for the Secure Zone Advanced type
        policyList[].sourceAddressGroupList[]Array-Origin address group information
        policyList[].sourceAddressGroupList[].addressGroupNoInteger-Unique number assigned to the address group
        policyList[].sourceAddressGroupList[].addressGroupNameString-Address group name
        policyList[].sourceAddressGroupList[].descriptionString-Address group description
        policyList[].sourceAddressGroupList[].memberNoString-User's NAVER Cloud Platform member ID
        policyList[].sourceAddressGroupList[].instanceNoString-Contract number assigned when creating the instance
        policyList[].sourceAddressGroupList[].addressList[].addressNoInteger-Unique number assigned to the address
        policyList[].sourceAddressGroupList[].addressList[].memberNoString-User's NAVER Cloud Platform member ID
        policyList[].sourceAddressGroupList[].addressList[].instanceNoString-Contract number assigned when creating the instance
        policyList[].sourceAddressGroupList[].addressList[].nameString-Address name
        policyList[].sourceAddressGroupList[].addressList[].ipString-IP address
        policyList[].sourceAddressGroupList[].addressList[].portString-Port number
        • It is displayed if addressZone is db and type is fqdn
        policyList[].sourceAddressGroupList[].addressList[].typeString-Address type information
        • ipmask | fqdn
          • ipmask: address defined by IP address and subnet mask
          • fqdn: fully qualified domain name (full domain name)
        policyList[].sourceAddressGroupList[].addressList[].addressZoneString-Information for the zone the address belongs to
        • sz | os | vm | db | vpn | lb | kr1
          • sz: Secure Zone
          • os: Object Storage
          • vm: VM
          • db: Cloud DB
          • vpn: SSL VPN or IPsec VPN
          • lb: Load Balancer
          • kr1: KR-1 zone
        policyList[].sourceAddressGroupList[].addressList[].fqdnString-Full domain name (FQDN)
        policyList[].sourceAddressGroupList[].addressList[].dbAddressZoneBoolean-DB address zone status
        policyList[].sourceAddressGroupList[].addressList[].maskBitInteger-Subnet mask bit value
        • It is displayed for the Secure Zone Advanced type
        policyList[].sourceAddressGroupList[].addressZoneString-Information for the zone the origin address group belongs to
        • sz | os | vm | db | vpn | lb | kr1
          • sz: Secure Zone
          • os: Object Storage
          • vm: VM
          • db: Cloud DB
          • vpn: SSL VPN or IPsec VPN
          • lb: Load Balancer
          • kr1: KR-1 zone
        policyList[].sourceAddressGroupList[].associatedPoliciesCountInteger-Not use
        policyList[].sourceAddressGroupList[].objectStorageBoolean-Whether to use Object Storage
        • true | false
          • true: Object Storage is used
          • false: Object Storage is not used
        policyList[].destinationAddressList[]Array-Destination address information
        policyList[].destinationAddressList[].addressNoInteger-Unique number assigned to the address
        policyList[].destinationAddressList[].memberNoString-User's NAVER Cloud Platform member ID
        policyList[].destinationAddressList[].instanceNoString-Contract number assigned when creating the instance
        policyList[].destinationAddressList[].nameString-Address name
        policyList[].destinationAddressList[].ipString-IP address
        policyList[].destinationAddressList[].portString-Port number
        • It is displayed if addressZone is db and type is fqdn
        policyList[].destinationAddressList[].typeString-Address type information
        • ipmask | fqdn
          • ipmask: address defined by IP address and subnet mask
          • fqdn: fully qualified domain name (full domain name)
        policyList[].destinationAddressList[].addressZoneString-Information for the zone the address belongs to
        • sz | os | vm | db | vpn | lb | kr1
          • sz: Secure Zone
          • os: Object Storage
          • vm: VM
          • db: Cloud DB
          • vpn: SSL VPN or IPsec VPN
          • lb: Load Balancer
          • kr1: KR-1 zone
        policyList[].destinationAddressList[].fqdnString-Full domain name (FQDN)
        policyList[].destinationAddressList[].dbAddressZoneBoolean-DB address zone status
        policyList[].destinationAddressList[].maskBitInteger-Subnet mask bit value
        • It is displayed for the Secure Zone Advanced type
        policyList[].destinationAddressGroupList[]Array-Destination address group information
        policyList[].destinationAddressGroupList[].addressGroupNoInteger-Unique number assigned to the address group
        policyList[].destinationAddressGroupList[].addressGroupNameString-Address group name
        policyList[].destinationAddressGroupList[].descriptionString-Address group description
        policyList[].destinationAddressGroupList[].memberNoString-User's NAVER Cloud Platform member ID
        policyList[].destinationAddressGroupList[].instanceNoString-Contract number assigned when creating the instance
        policyList[].destinationAddressGroupList[].addressList[].addressNoInteger-Unique number assigned to the address
        policyList[].destinationAddressGroupList[].addressList[].memberNoString-User's NAVER Cloud Platform member ID
        policyList[].destinationAddressGroupList[].addressList[].instanceNoString-Contract number assigned when creating the instance
        policyList[].destinationAddressGroupList[].addressList[].nameString-Address name
        policyList[].destinationAddressGroupList[].addressList[].ipString-IP address
        policyList[].destinationAddressGroupList[].addressList[].portString-Port number
        • It is displayed if addressZone is db and type is fqdn
        policyList[].destinationAddressGroupList[].addressList[].typeString-Address type information
        • ipmask | fqdn
          • ipmask: address defined by IP address and subnet mask
          • fqdn: fully qualified domain name (full domain name)
        policyList[].destinationAddressGroupList[].addressList[].addressZoneString-Information for the zone the address belongs to
        • sz | os | vm | db | vpn | lb | kr1
          • sz: Secure Zone
          • os: Object Storage
          • vm: VM
          • db: Cloud DB
          • vpn: SSL VPN or IPsec VPN
          • lb: Load Balancer
          • kr1: KR-1 zone
        policyList[].destinationAddressGroupList[].addressList[].fqdnString-Full domain name (FQDN)
        policyList[].destinationAddressGroupList[].addressList[].dbAddressZoneBoolean-DB address zone status
        policyList[].destinationAddressGroupList[].addressList[].maskBitInteger-Subnet mask bit value
        • It is displayed for the Secure Zone Advanced type
        policyList[].destinationAddressGroupList[].addressZoneString-Information for the zone the destination address group belongs to
        • sz | os | vm | db | vpn | lb | kr1
          • sz: Secure Zone
          • os: Object Storage
          • vm: VM
          • db: Cloud DB
          • vpn: SSL VPN or IPsec VPN
          • lb: Load Balancer
          • kr1: KR-1 zone
        policyList[].destinationAddressGroupList[].associatedPoliciesCountInteger-Not use
        policyList[].destinationAddressGroupList[].objectStorageBoolean-Whether to use Object Storage
        • true | false
          • true: Object Storage is used
          • false: Object Storage is not used
        policyList[].sourceAddressZoneString-Information for the zone of the origin address
        • sz | os | vm | db | vpn | lb | kr1
          • sz: Secure Zone
          • os: Object Storage
          • vm: VM
          • db: Cloud DB
          • vpn: SSL VPN or IPsec VPN
          • lb: Load Balancer
          • kr1: KR-1 zone
        policyList[].destinationAddressZoneString-Information for the zone of the destination address
        • sz | os | vm | db | vpn | lb | kr1
          • sz: Secure Zone
          • os: Object Storage
          • vm: VM
          • db: Cloud DB
          • vpn: SSL VPN or IPsec VPN
          • lb: Load Balancer
          • kr1: KR-1 zone
        policyList[].serviceList[]Array-Service information of the policy to view
        policyList[].serviceList[].serviceNoInteger-Firewall service number
        policyList[].serviceList[].serviceNameString-Firewall service name
        policyList[].serviceList[].protocolString-Firewall service protocol
        policyList[].serviceList[].portString-Firewall service port number
        policyList[].serviceList[].memberNoString-User's NAVER Cloud Platform member ID
        policyList[].serviceList[].instanceNoString-Contract number assigned when creating the instance
        policyList[].firewallPolicyIdInteger-ID assigned to the firewall policy
        policyList[].firewallOrderInteger-Firewall policy order

        Response status codes

        For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

        Response example

        The following is a sample example.

        {
          "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
            }
          ]
        }
        JSON

        Was this article helpful?

        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.