getAddressGroupList

Available in Classic

Get the list of address groups.

Request

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

Method	URI
POST	/{type}/{zone}/getAddressGroupList

Request headers

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

Request path parameters

The following describes the parameters.

Field	Type	Required	Description
`type`	String	Required	firewall type provided by Secure Zone `szfw` \| `psfw` `szfw`: Secure Zone Standard `psfw`: Secure Zone Advanced
`zone`	String	Required	Zone in which Secure Zone is configured `kr1` \| `kr2` `kr1`: KR-1 zone `kr2`: KR-2 zone

Request body

The following describes the request body.

Field	Type	Required	Description
`addressGroupName`	String	Optional	Address group name
`addressGroupNo`	Integer	Optional	Unique number assigned to the address group
`addressZone`	String	Optional	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
`countPerPage`	Integer	Optional	Number of items per page 20 (default)
`page`	Integer	Optional	Page index 1 (default)

Request example

The following is a sample request.

curl --location --request POST 'https://securezonefirewall.apigw.ntruss.com/api/v2/szfw/kr2/getAddressGroupList'
--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
}'

Response

The following describes the response format.

Response body

The following describes the response body.

Field	Type	Required	Description
`action`	String	-	Request type
`returnCode`	Integer	-	Response code
`returnMessage`	String	-	Response message
`totalCount`	Integer	-	Total number of address groups
`addressGroupList[]`	Array	-	List of address groups to view
`addressGroupList[].addressGroupNo`	Integer	-	Unique number assigned to the address group
`addressGroupList[].addressGroupName`	String	-	Address group name
`addressGroupList[].description`	String	-	Address group description
`addressGroupList[].memberNo`	String	-	User's NAVER Cloud Platform member ID
`addressGroupList[].instanceNo`	String	-	Contract number assigned when creating the instance
`addressGroupList[].addressList[]`	Array	-	Information about addresses that belong to the address group
`addressGroupList[].addressList[].addressNo`	Integer	-	Unique number assigned to the address
`addressGroupList[].addressList[].memberNo`	String	-	User's NAVER Cloud Platform member ID
`addressGroupList[].addressList[].instanceNo`	String	-	Contract number assigned when creating the instance
`addressGroupList[].addressList[].name`	String	-	Address name
`addressGroupList[].addressList[].ip`	String	-	IP address
`addressGroupList[].addressList[].port`	Integer	-	Port number It is displayed if `addressZone` is `db` and `type` is `fqdn`
`addressGroupList[].addressList[].type`	String	-	Address type information `ipmask` \| `fqdn` `ipmask`: address defined by IP address and subnet mask `fqdn`: fully qualified domain name (full domain name)
`addressGroupList[].addressList[].addressZone`	String	-	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
`addressGroupList[].addressList[].fqdn`	String	-	Full domain name (FQDN) It is displayed if `type` is `fqdn`
`addressGroupList[].addressList[].dbAddressZone`	Boolean	-	DB address zone status
`addressGroupList[].addressList[].maskBit`	Integer	-	Subnet mask bit value It is displayed for the Secure Zone Advanced type
`addressGroupList[].addressZone`	String	-	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
`addressGroupList[].associatedPoliciesCount`	Integer	-	Not use
`addressGroupList[].objectStorage`	Boolean	-	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": "getAddressGroupList",
    "returnCode": 0,
    "returnMessage": "success",
    "totalCount": 2,
    "addressGroupList": [
        {
            "addressGroupNo": 5452,
            "addressGroupName": "dbgroup",
            "description": "",
            "memberNo": "2795985",
            "instanceNo": "25200511",
            "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
        },
        {
            "addressGroupNo": 5438,
            "addressGroupName": "grp1",
            "description": "",
            "memberNo": "27***85",
            "instanceNo": "25****11",
            "addressList": [
                {
                    "addressNo": 3644,
                    "memberNo": "27***85",
                    "instanceNo": "25****11",
                    "name": "s1906cf93f79",
                    "ip": "***.***.***.***",
                    "type": "ipmask",
                    "addressZone": "sz"
                }
            ],
            "addressZone": "sz",
            "associatedPoliciesCount": 0,
            "objectStorage": false
        }
    ]
}