getIpsecAddress

Prev Next

Available in Classic

Get the list of addresses that belong to the IPsec zone.

Request

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

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

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
memberNo String Optional User's NAVER Cloud Platform member ID
instanceNo String Optional Contract number assigned when creating the instance

Request example

The following is a sample request.

curl --location --request POST 'https://securezonefirewall.apigw.ntruss.com/api/v2/psfw/kr2/getIpsecAddress'
--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 '{
  "memberNo": "27***85",
  "instanceNo": "25****11"
}'

Response

The following describes the response format.

Response body

The following describes the response body.

Field Type Required Description
action String - Request type
addressList[] Array - List of addresses to view
addressList[].addressNo Integer - Unique number assigned to the address
addressList[].addressZone String - Information about the zone the address belongs to
  • vpn
    • vpn: IPsec VPN
addressList[].dbAddressZone Boolean - DB address zone status
addressList[].fqdn String - Full domain name (FQDN)
addressList[].instanceNo String - Contract number assigned when creating the instance
addressList[].ip String - IP address
addressList[].maskBit Integer - Subnet mask bit value
  • It is displayed for the Secure Zone Advanced type
addressList[].memberNo String - User's NAVER Cloud Platform member ID
addressList[].name String - Address name
addressList[].port Integer - Port number
  • It is displayed if addressZone is db and type is fqdn
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)
returnCode Integer - Response code
returnMessage String - Response message

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": "string",
  "addressList": [
    {
      "addressNo": 0,
      "addressZone": "string",
      "fqdn": "string",
      "instanceNo": "string",
      "ip": "string",
      "maskBit": 0,
      "memberNo": "string",
      "name": "string",
      "port": "string",
      "type": "ipmask"
    }
  ],
  "returnCode": 0,
  "returnMessage": "string"
}