getIpsecAddress

Prev Next

Classic 환경에서 이용 가능합니다.

IPsec 존에 속한 Address 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
POST /api/v1/{type}/{zone}/getIpsecAddress

요청 헤더

Secure Zone API에서 공통으로 사용하는 헤더에 대한 정보는 Secure Zone 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
type String Required Secure Zone에서 제공하는 방화벽 유형
  • szfw | psfw
    • szfw: Secure Zone Standard
    • psfw: Secure Zone Advanced
zone String Required Secure Zone을 구성한 존
  • kr1 | kr2
    • kr1: KR-1 존
    • kr2: KR-2 존

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
memberNo String Optional 사용자의 네이버 클라우드 플랫폼 회원 번호
instanceNo String Optional 인스턴스 생성 시 부여된 계약 번호

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://securezonefirewall.apigw.gov-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"
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
action String - 요청 유형
addressList Array - 조회하는 Address 목록: addressList
returnCode Integer - 응답 코드
returnMessage String - 응답 메시지

addressList

addressList에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
addressNo Integer - Address에 부여된 고유 번호
addressZone String - Address가 속한 존에 대한 정보
  • vpn
    • vpn: IPsec VPN
dbAddressZone Boolean - DB Address Zone 여부
fqdn String - 전체 도메인 이름 (FQDN)
instanceNo String - 인스턴스 생성 시 부여된 계약 번호
ip String - IP 주소
maskBit Integer - 서브넷 마스크 비트 값
  • Secure Zone Advanced 타입인 경우 표시
memberNo String - 사용자의 네이버 클라우드 플랫폼 회원 번호
name String - Address의 이름
port Integer - 포트 번호
  • addressZonedb이고 typefqdn인 경우 표시
type String - Address 유형 정보
  • ipmask | fqdn
    • ipmask: IP 주소와 서브넷 마스크로 정의된 주소
    • fqdn: Fully qualified domain name (전체 도메인 이름)

응답 상태 코드

Secure Zone API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Secure Zone 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

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