getPolicy

Prev Next

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

방화벽 정책 중 선택한 정책의 정보를 조회합니다.

요청

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

메서드 URI
POST /{type}/{zone}/getPolicy

요청 헤더

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 존

요청 바디

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

필드 타입 필수 여부 설명
policyName String Conditional 조회할 정책 이름
  • getPolicyList를 통해 확인
  • policyNo가 지정되지 않은 경우 필수
policyNo String Conditional 정책에 부여된 고유 번호
  • getPolicyList를 통해 확인
  • policyName이 지정되지 않은 경우 필수
  • 0 입력 시 우선순위가 가장 낮은 정책 조회

요청 예시

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

curl --location --request POST 'https://securezonefirewall.apigw.gov-ntruss.com/api/v2/szfw/kr2/getPolicy'
--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 '{
  "policyName": "pol1",
  "policyNo": 0
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
action String - 요청 유형
returnCode Integer - 응답 코드
returnMessage String - 응답 메시지
policy List<String> - 조회하는 정책 정보
policy.policyNo Integer - 정책에 부여된 고유 번호
policy.policyName String - 정책 이름
policy.description String - 정책에 대한 설명
policy.action String - 허용 여부
  • allow | deny
policy.memberNo String - 사용자의 네이버 클라우드 플랫폼 회원 번호
policy.instanceNo String - 인스턴스 생성 시 부여된 계약 번호
policy.sourceAddressList[] Array - 출발지 Address의 정보
policy.sourceAddressList[].addressNo Integer - Address에 부여된 고유 번호
policy.sourceAddressList[].memberNo String - 사용자의 네이버 클라우드 플랫폼 회원 번호
policy.sourceAddressList[].instanceNo String - 인스턴스 생성 시 부여된 계약 번호
policy.sourceAddressList[].name String - Address의 이름
policy.sourceAddressList[].ip String - IP 주소
policy.sourceAddressList[].port String - 포트 번호
  • addressZonedb이고 typefqdn인 경우 표시
policy.sourceAddressList[].type String - Address 유형 정보
  • ipmask | fqdn
    • ipmask: IP 주소와 서브넷 마스크로 정의된 주소
    • fqdn: Fully qualified domain name (전체 도메인 이름)
policy.sourceAddressList[].addressZone String - Address가 속한 존에 대한 정보
  • sz | os | vm | db | vpn | lb | kr1
    • sz: Secure Zone
    • os: Object Storage
    • vm: VM
    • db: Cloud DB
    • vpn: SSL VPN 또는 IPsec VPN
    • lb: Load Balancer
    • kr1: KR-1 존
policy.sourceAddressList[].fqdn String - 전체 도메인 이름 (FQDN)
policy.sourceAddressList[].dbAddressZone Boolean - DB Address Zone 여부
policy.sourceAddressList[].maskBit Integer - 서브넷 마스크 비트 값
  • Secure Zone Advanced 타입인 경우 표시
policy.sourceAddressGroupList[] Array - 출발지 Address Group의 정보
policy.sourceAddressGroupList[].addressGroupNo Integer - Address Group에 부여된 고유 번호
policy.sourceAddressGroupList[].addressGroupName String - Address Group의 이름
policy.sourceAddressGroupList[].description String - Address Group에 대한 설명
policy.sourceAddressGroupList[].memberNo String - 사용자의 네이버 클라우드 플랫폼 회원 번호
policy.sourceAddressGroupList[].instanceNo String - 인스턴스 생성 시 부여된 계약 번호
policy.sourceAddressGroupList[].addressList[].addressNo Integer - Address에 부여된 고유 번호
policy.sourceAddressGroupList[].addressList[].memberNo String - 사용자의 네이버 클라우드 플랫폼 회원 번호
policy.sourceAddressGroupList[].addressList[].instanceNo String - 인스턴스 생성 시 부여된 계약 번호
policy.sourceAddressGroupList[].addressList[].name String - Address의 이름
policy.sourceAddressGroupList[].addressList[].ip String - IP 주소
policy.sourceAddressGroupList[].addressList[].port String - 포트 번호
  • addressZonedb이고 typefqdn인 경우 표시
policy.sourceAddressGroupList[].addressList[].type String - Address 유형 정보
  • ipmask | fqdn
    • ipmask: IP 주소와 서브넷 마스크로 정의된 주소
    • fqdn: Fully qualified domain name (전체 도메인 이름)
policy.sourceAddressGroupList[].addressList[].addressZone String - Address가 속한 존에 대한 정보
  • sz | os | vm | db | vpn | lb | kr1
    • sz: Secure Zone
    • os: Object Storage
    • vm: VM
    • db: Cloud DB
    • vpn: SSL VPN 또는 IPsec VPN
    • lb: Load Balancer
    • kr1: KR-1 존
policy.sourceAddressGroupList[].addressList[].fqdn String - 전체 도메인 이름 (FQDN)
policy.sourceAddressGroupList[].addressList[].dbAddressZone Boolean - DB Address Zone 여부
policy.sourceAddressGroupList[].addressList[].maskBit Integer - 서브넷 마스크 비트 값
  • Secure Zone Advanced 타입인 경우 표시
policy.sourceAddressGroupList[].addressZone String - 출발지 Address Group이 속한 존에 대한 정보
  • sz | os | vm | db | vpn | lb | kr1
    • sz: Secure Zone
    • os: Object Storage
    • vm: VM
    • db: Cloud DB
    • vpn: SSL VPN 또는 IPsec VPN
    • lb: Load Balancer
    • kr1: KR-1 존
policy.sourceAddressGroupList[].associatedPoliciesCount Integer - 미사용
policy.sourceAddressGroupList[].objectStorage Boolean - Object Storage 사용 여부
  • true | false
    • true: Object Storage를 사용함
    • false: Object Storage를 사용하지 않음
policy.destinationAddressList[] Array - 목적지 Address의 정보
policy.destinationAddressList[].addressNo Integer - Address에 부여된 고유 번호
policy.destinationAddressList[].memberNo String - 사용자의 네이버 클라우드 플랫폼 회원 번호
policy.destinationAddressList[].instanceNo String - 인스턴스 생성 시 부여된 계약 번호
policy.destinationAddressList[].name String - Address의 이름
policy.destinationAddressList[].ip String - IP 주소
policy.destinationAddressList[].port String - 포트 번호
  • addressZonedb이고 typefqdn인 경우 표시
policy.destinationAddressList[].type String - Address 유형 정보
  • ipmask | fqdn
    • ipmask: IP 주소와 서브넷 마스크로 정의된 주소
    • fqdn: Fully qualified domain name (전체 도메인 이름)
policy.destinationAddressList[].addressZone String - Address가 속한 존에 대한 정보
  • sz | os | vm | db | vpn | lb | kr1
    • sz: Secure Zone
    • os: Object Storage
    • vm: VM
    • db: Cloud DB
    • vpn: SSL VPN 또는 IPsec VPN
    • lb: Load Balancer
    • kr1: KR-1 존
policy.destinationAddressList[].fqdn String - 전체 도메인 이름 (FQDN)
policy.destinationAddressList[].dbAddressZone Boolean - DB Address Zone 여부
policy.destinationAddressList[].maskBit Integer - 서브넷 마스크 비트 값
  • Secure Zone Advanced 타입인 경우 표시
policy.destinationAddressGroupList[] Array - 목적지 Address Group의 정보
policy.destinationAddressGroupList[].addressGroupNo Integer - Address Group에 부여된 고유 번호
policy.destinationAddressGroupList[].addressGroupName String - Address Group의 이름
policy.destinationAddressGroupList[].description String - Address Group에 대한 설명
policy.destinationAddressGroupList[].memberNo String - 사용자의 네이버 클라우드 플랫폼 회원 번호
policy.destinationAddressGroupList[].instanceNo String - 인스턴스 생성 시 부여된 계약 번호
policy.destinationAddressGroupList[].addressList[].addressNo Integer - Address에 부여된 고유 번호
policy.destinationAddressGroupList[].addressList[].memberNo String - 사용자의 네이버 클라우드 플랫폼 회원 번호
policy.destinationAddressGroupList[].addressList[].instanceNo String - 인스턴스 생성 시 부여된 계약 번호
policy.destinationAddressGroupList[].addressList[].name String - Address의 이름
policy.destinationAddressGroupList[].addressList[].ip String - IP 주소
policy.destinationAddressGroupList[].addressList[].port String - 포트 번호
  • addressZonedb이고 typefqdn인 경우 표시
policy.destinationAddressGroupList[].addressList[].type String - Address 유형 정보
  • ipmask | fqdn
    • ipmask: IP 주소와 서브넷 마스크로 정의된 주소
    • fqdn: Fully qualified domain name (전체 도메인 이름)
policy.destinationAddressGroupList[].addressList[].addressZone String - Address가 속한 존에 대한 정보
  • sz | os | vm | db | vpn | lb | kr1
    • sz: Secure Zone
    • os: Object Storage
    • vm: VM
    • db: Cloud DB
    • vpn: SSL VPN 또는 IPsec VPN
    • lb: Load Balancer
    • kr1: KR-1 존
policy.destinationAddressGroupList[].addressList[].fqdn String - 전체 도메인 이름 (FQDN)
policy.destinationAddressGroupList[].addressList[].dbAddressZone Boolean - DB Address Zone 여부
policy.destinationAddressGroupList[].addressList[].maskBit Integer - 서브넷 마스크 비트 값
  • Secure Zone Advanced 타입인 경우 표시
policy.destinationAddressGroupList[].addressZone String - 목적지 Address Group이 속한 존에 대한 정보
  • sz | os | vm | db | vpn | lb | kr1
    • sz: Secure Zone
    • os: Object Storage
    • vm: VM
    • db: Cloud DB
    • vpn: SSL VPN 또는 IPsec VPN
    • lb: Load Balancer
    • kr1: KR-1 존
policy.destinationAddressGroupList[].associatedPoliciesCount Integer - 미사용
policy.destinationAddressGroupList[].objectStorage Boolean - Object Storage 사용 여부
  • true | false
    • true: Object Storage를 사용함
    • false: Object Storage를 사용하지 않음
policy.sourceAddressZone String - 정책의 출발지 Address의 존 정보
  • sz | os | vm | db | vpn | lb | kr1
    • sz: Secure Zone
    • os: Object Storage
    • vm: VM
    • db: Cloud DB
    • vpn: SSL VPN 또는 IPsec VPN
    • lb: Load Balancer
    • kr1: KR-1 존
policy.destinationAddressZone String - 정책의 목적지 Address의 존 정보
  • sz | os | vm | db | vpn | lb | kr1
    • sz: Secure Zone
    • os: Object Storage
    • vm: VM
    • db: Cloud DB
    • vpn: SSL VPN 또는 IPsec VPN
    • lb: Load Balancer
    • kr1: KR-1 존
policy.serviceList[] Array - 조회하는 정책의 서비스 정보
policy.serviceList[].serviceNo Integer - 방화벽 서비스 번호
policy.serviceList[].serviceName String - 방화벽 서비스 이름
policy.serviceList[].protocol String - 방화벽 서비스의 프로토콜
policy.serviceList[].port String - 방화벽 서비스의 포트 번호
policy.serviceList[].memberNo String - 사용자의 네이버 클라우드 플랫폼 회원 번호
policy.serviceList[].instanceNo String - 인스턴스 생성 시 부여된 계약 번호
policy.firewallPolicyId Integer - 방화벽 정책에 부여된 ID
policy.firewallOrder Integer - 방화벽 정책 순서

응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시

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

{
    "action": "getPolicy",
    "returnCode": 0,
    "returnMessage": "success",
    "policy": {
        "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
    }
}