MENU
      getAddressGroup

        getAddressGroup


        Article summary

        Available in Classic

        Get the information of a specific group of address groups.

        Request

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

        MethodURI
        POST/{type}/{zone}/getAddressGroup

        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
        addressGroupNameStringConditionalAddress group name
        • Check through getAddressGroupList
        • Required if addressGroupNo is not specified
        • If neither is specified, default to null
        addressGroupNoIntegerConditionalUnique number assigned to the address group
        • Check through getAddressGroupList
        • Required if addressGroupName is not specified
        • If neither is specified, default to null
        countPerPageIntegerOptionalNumber of items per page
        • 20 (default)
        pageIntegerOptionalPage index
        • 1 (default)

        Request example

        The following is a sample request.

        curl --location --request POST 'https://securezonefirewall.apigw.ntruss.com/api/v2/szfw/kr2/getAddressGroup'
        --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 '{
          "addressGroupName": "grp111",
          "addressGroupNo": 0,
          "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
        addressGroupList<String>-Information of the address group to view
        addressGroup.addressGroupNoInteger-Unique number assigned to the address group
        addressGroup.addressGroupNameString-Address group name
        addressGroup.descriptionString-Address group description
        addressGroup.memberNoString-User's NAVER Cloud Platform member ID
        addressGroup.instanceNoString-Contract number assigned when creating the instance
        addressGroup.addressList[]Array-Information about addresses that belong to the address group
        addressGroup.addressList[].addressNoInteger-Unique number assigned to the address
        addressGroup.addressList[].memberNoString-User's NAVER Cloud Platform member ID
        addressGroup.addressList[].instanceNoString-Contract number assigned when creating the instance
        addressGroup.addressList[].nameString-Address name
        addressGroup.addressList[].ipString-IP address
        addressGroup.addressList[].portInteger-Port number
        • It is displayed if addressZone is db and type is fqdn
        addressGroup.addressList[].typeString-Address type information
        • ipmask | fqdn
          • ipmask: address defined by IP address and subnet mask
          • fqdn: fully qualified domain name (full domain name)
        addressGroup.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
        addressGroup.addressList[].fqdnString-Full domain name (FQDN)
        • It is displayed if type is fqdn
        addressGroup.addressList[].dbAddressZoneBoolean-DB address zone status
        addressGroup.addressList[].maskBitInteger-Subnet mask bit value
        • It is displayed for the Secure Zone Advanced type
        addressGroup.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
        addressGroup.associatedPoliciesCountInteger-Not use
        addressGroup.objectStorageBoolean-Whether to use Object Storage
        • true | false
          • true: Object Storage is used
          • false: Object Storage is not used

        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": "getAddressGroup",
            "returnCode": 0,
            "returnMessage": "success",
            "addressGroup": {
                "addressGroupNo": 5452,
                "addressGroupName": "dbgroup",
                "description": "",
                "memberNo": "27***85",
                "instanceNo": "25****11",
                "addressList": [
                    {
                        "addressNo": 3646,
                        "memberNo": "27***85",
                        "instanceNo": "25****11",
                        "name": "test-db-001",
                        "ip": "***.***.***.***",
                        "port": "3306",
                        "type": "fqdn",
                        "addressZone": "db",
                        "fqdn": "db-****.cdb.ntruss.com"
                    }
                ],
                "addressZone": "db",
                "associatedPoliciesCount": 0,
                "objectStorage": false
            }
        }
        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.