getPolicy
    • PDF

    getPolicy

    • PDF

    기사 요약

    개요

    Policy 설정 내용을 조회합니다.
    policyNo 미입력 시 가장 우선순위 낮은 Policy 가 조회됩니다.

    요청

    MethodRequest URI
    POSThttps://securezonefirewall.apigw.gov-ntruss.com/api/v1/{type}/{zone}

    요청 헤더

    헤더명설명
    x-ncp-apigw-timestamp1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것
    API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
    x-ncp-iam-access-key네이버 클라우드 플랫폼에서 발급받은 API Key 또는 IAM에서 발급받은 AccessKey
    x-ncp-apigw-signature-v2Body를 AccessKey와 맵핑되는 SecretKey로 암호화한 서명
    HMAC 암호화 알고리즘은 HmacSHA256 사용

    요청 파라미터

    파라미터명필수 여부타입설명
    instanceNoYesString
    memberNoYesString
    policyNameNoString
    policyNoNoInteger

    요청 바디

    {
      "instanceNo": "string",
      "memberNo": "string",
      "policyName": "string",
      "policyNo": 0
    }
    

    응답

    응답 바디

    파라미터명타입설명
    policy.actionString허용 차단 구분(allow, deny)
    policy.descriptionString정책 설명
    policy.destinationAddressGroupList[].addressGroupNameStringAddress Group명
    policy.destinationAddressGroupList[].addressGroupNoIntegerAddress Group 번호
    policy.destinationAddressGroupList[].addressList[].addressNoIntegerAddress 번호
    policy.destinationAddressGroupList[].addressList[].addressZoneStringAddressZone 정보
    policy.destinationAddressGroupList[].addressList[].dbAddressZoneBooleandb AddressZone 여부
    policy.destinationAddressGroupList[].addressList[].fqdnStringfqdn
    policy.destinationAddressGroupList[].addressList[].instanceNoString인스턴스 번호
    policy.destinationAddressGroupList[].addressList[].ipStringIp
    policy.destinationAddressGroupList[].addressList[].maskBitIntegerMaskBit
    policy.destinationAddressGroupList[].addressList[].memberNoString멤버 번호
    policy.destinationAddressGroupList[].addressList[].nameStringAddress명
    policy.destinationAddressGroupList[].addressList[].portStringPort
    policy.destinationAddressGroupList[].addressList[].typeStringAddress Type 정보(ipmask, fqdn)
    policy.destinationAddressGroupList[].addressZoneStringAddressZone 정보
    policy.destinationAddressGroupList[].associatedPoliciesCountInteger미사용
    policy.destinationAddressGroupList[].descriptionString설명
    policy.destinationAddressGroupList[].instanceNoString인스턴스 번호
    policy.destinationAddressGroupList[].memberNoString멤버 번호
    policy.destinationAddressGroupList[].objectStorageBoolean오브젝트 스토리지 여부
    policy.destinationAddressList[].addressNoIntegerAddress 번호
    policy.destinationAddressList[].addressZoneStringAddressZone 정보
    policy.destinationAddressList[].dbAddressZoneBooleandb AddressZone 여부
    policy.destinationAddressList[].fqdnStringfqdn
    policy.destinationAddressList[].instanceNoString인스턴스 번호
    policy.destinationAddressList[].ipStringIp
    policy.destinationAddressList[].maskBitIntegerMaskBit
    policy.destinationAddressList[].memberNoString멤버 번호
    policy.destinationAddressList[].nameStringAddress명
    policy.destinationAddressList[].portStringPort
    policy.destinationAddressList[].typeStringAddress Type 정보(ipmask, fqdn)
    policy.destinationAddressZoneString목적지 AddressZone 정보
    policy.firewallOrderInteger방화벽 정책 순서
    policy.firewallPolicyIdInteger방화벽 정책 아이디
    policy.instanceNoString인스턴스 번호
    policy.memberNoString사용자 번호
    policy.policyNameString정책명
    policy.policyNoInteger정책 번호
    policy.serviceList[].instanceNoString인스턴스 번호
    policy.serviceList[].memberNoString멤버 번호
    policy.serviceList[].portString방화벽 서비스 포트번호
    policy.serviceList[].protocolString방화벽 서비스 프로토콜
    policy.serviceList[].serviceNameString서비스명
    policy.serviceList[].serviceNoInteger서비스 번호
    policy.sourceAddressGroupList[].addressGroupNameStringAddress Group명
    policy.sourceAddressGroupList[].addressGroupNoIntegerAddress Group 번호
    policy.sourceAddressGroupList[].addressList[].addressNoIntegerAddress 번호
    policy.sourceAddressGroupList[].addressList[].addressZoneStringAddressZone 정보
    policy.sourceAddressGroupList[].addressList[].dbAddressZoneBooleandb AddressZone 여부
    policy.sourceAddressGroupList[].addressList[].fqdnStringfqdn
    policy.sourceAddressGroupList[].addressList[].instanceNoString인스턴스 번호
    policy.sourceAddressGroupList[].addressList[].ipStringIp
    policy.sourceAddressGroupList[].addressList[].maskBitIntegerMaskBit
    policy.sourceAddressGroupList[].addressList[].memberNoString멤버 번호
    policy.sourceAddressGroupList[].addressList[].nameStringAddress명
    policy.sourceAddressGroupList[].addressList[].portStringPort
    policy.sourceAddressGroupList[].addressList[].typeStringAddress Type 정보(ipmask, fqdn)
    policy.sourceAddressGroupList[].addressZoneStringAddressZone 정보
    policy.sourceAddressGroupList[].associatedPoliciesCountInteger미사용
    policy.sourceAddressGroupList[].descriptionString설명
    policy.sourceAddressGroupList[].instanceNoString인스턴스 번호
    policy.sourceAddressGroupList[].memberNoString멤버 번호
    policy.sourceAddressGroupList[].objectStorageBoolean오브젝트 스토리지 여부
    policy.sourceAddressList[].addressNoIntegerAddress 번호
    policy.sourceAddressList[].addressZoneStringAddressZone 정보
    policy.sourceAddressList[].dbAddressZoneBooleandb AddressZone 여부
    policy.sourceAddressList[].fqdnStringfqdn
    policy.sourceAddressList[].instanceNoString인스턴스 번호
    policy.sourceAddressList[].ipStringIp
    policy.sourceAddressList[].maskBitIntegerMaskBit
    policy.sourceAddressList[].memberNoString멤버 번호
    policy.sourceAddressList[].nameStringAddress명
    policy.sourceAddressList[].portStringPort
    policy.sourceAddressList[].typeStringAddress Type 정보(ipmask, fqdn)
    policy.sourceAddressZoneString출발지 AddressZone 정보
    actionString요청 유형
    returnCodeInteger응답 코드
    returnMessageString응답 메세지

    응답 바디

    {
      "action": "string",
      "policy": {
        "action": "string",
        "description": "string",
        "destinationAddressGroupList": [
          {
            "addressGroupName": "string",
            "addressGroupNo": 0,
            "addressList": [
              {
                "addressNo": 0,
                "addressZone": "string",
                "dbAddressZone": true,
                "fqdn": "string",
                "instanceNo": "string",
                "ip": "string",
                "maskBit": 0,
                "memberNo": "string",
                "name": "string",
                "port": "string",
                "type": "string"
              }
            ],
            "addressZone": "string",
            "associatedPoliciesCount": 0,
            "description": "string",
            "instanceNo": "string",
            "memberNo": "string",
            "objectStorage": true
          }
        ],
        "destinationAddressList": [
          {
            "addressNo": 0,
            "addressZone": "string",
            "dbAddressZone": true,
            "fqdn": "string",
            "instanceNo": "string",
            "ip": "string",
            "maskBit": 0,
            "memberNo": "string",
            "name": "string",
            "port": "string",
            "type": "string"
          }
        ],
        "destinationAddressZone": "string",
        "firewallOrder": 0,
        "firewallPolicyId": 0,
        "instanceNo": "string",
        "memberNo": "string",
        "policyName": "string",
        "policyNo": 0,
        "serviceList": [
          {
            "instanceNo": "string",
            "memberNo": "string",
            "port": "string",
            "protocol": "string",
            "serviceName": "string",
            "serviceNo": 0
          }
        ],
        "sourceAddressGroupList": [
          {
            "addressGroupName": "string",
            "addressGroupNo": 0,
            "addressList": [
              {
                "addressNo": 0,
                "addressZone": "string",
                "dbAddressZone": true,
                "fqdn": "string",
                "instanceNo": "string",
                "ip": "string",
                "maskBit": 0,
                "memberNo": "string",
                "name": "string",
                "port": "string",
                "type": "string"
              }
            ],
            "addressZone": "string",
            "associatedPoliciesCount": 0,
            "description": "string",
            "instanceNo": "string",
            "memberNo": "string",
            "objectStorage": true
          }
        ],
        "sourceAddressList": [
          {
            "addressNo": 0,
            "addressZone": "string",
            "dbAddressZone": true,
            "fqdn": "string",
            "instanceNo": "string",
            "ip": "string",
            "maskBit": 0,
            "memberNo": "string",
            "name": "string",
            "port": "string",
            "type": "string"
          }
        ],
        "sourceAddressZone": "string"
      },
      "returnCode": 0,
      "returnMessage": "string"
    }
    

    오류 코드

    공통적으로 발생하는 오류에 대한 상세한 설명은 NAVER Cloud Platform API를 참고해주세요


    이 문서가 도움이 되었습니까?

    What's Next
    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.