getIPSList
    • PDF

    getIPSList

    • PDF

    Article Summary

    개요

    • getIPSList API 는 "Security Monitoring"의 "IPS"에서 제공하는 기능으로 IPS 보안 목록을 이벤트를 확인할 수 있습니다.
    • 해당 API는 네이버 클라우드 플랫폼에서 사용하는 IAM인증 및 API Gateway를 통해 사용하실 수 있습니다.

    요청

    PlatformMethodRequest URI
    ClassicPOSThttps://securitymonitoring.apigw.ntruss.com/securitymonitoring/v1/
    VPCPOSThttps://securitymonitoring.apigw.ntruss.com/vsecuritymonitoring/v1/

    요청 헤더

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

    IAM 인증이 필요한 API 호출하기를 참조

    요청 파라미터

    파라미터명필수 여부타입설명
    startDateTimeYeslong이벤트 조회 시작 시간
    1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것.
    ex) 1646628240000
    endDateTimeYeslong이벤트 조회 종료 시간
    1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것.
    ex) 1646628240000
    pageYesint페이지
    countPerPageYesint페이지당 노출갯수
    orderNostring이벤트 탐지 시간 기준 정렬(asc, desc)
    default value : desc
    regionCodeNostring리전 코드
    (한국:KR, 독일:DEN, 일본:JPN, 싱가폴:SGN, 미국:USWN)
    zoneNameNostringZone(KR-1, KR-2)
    eventNmNostring탐지이벤트
    attackIpNostring공격자IP
    targetIpNostring타겟IP
    attackTypeNostring공격유형
    Classic에서만 사용
    protocolNostring프로토콜
    VPC에서만 사용

    응답

    응답 바디

    필드명타입설명
    returnCodestring요청에 대한 처리 결과 코드
    returnMessagestring요청에 대한 처리 결과 메시지
    ipsTotalCountintgetIPSList의 총 개수
    pageint요청 페이지 번호
    ipsDataListarrayIPS 이벤트 목록
    ipsDataList[].ticketIdstringIPS 이벤트 번호
    ipsDataList[].dateString탐지날짜
    ipsDataList[].productstring상품분류
    classic : IPS, vpc : IPS_V2
    ipsDataList[].eventNmstring이벤트명
    ipsDataList[].attackerIpstring공격IP
    ipsDataList[].attackerPortstring공격Port
    ipsDataList[].targetIpstring타겟IP
    ipsDataList[].targetPortstring타겟Port
    ipsDataList[].detectstring탐지건수
    ipsDataList[].regionstring리전
    ipsDataList[].zoneNamestringZone(KR-1, KR-2)
    ipsDataList[].vpcNamestringvpc name
    ipsDataList[].platFormstringPlatform Info
    ipsDataList[].attackTypestring공격유형
    Classic에서만 사용
    ipsDataList[].protocolstring프로토콜
    VPC에서만 사용

    예시

    요청 예시

    curl -X POST "https://securitymonitoring.apigw.ntruss.com/securitymonitoring/v1/getIPSList"
       -H "accept: application/json"
       -H "x-ncp-apigw-api-key: {x-ncp-apigw-api-key}"
       -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"
       -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}"
       -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"
       -d {"startDateTime": {startDateTime},
             "endDateTime": {endDateTime},
             "page": {page},
             "countPerPage": {countPerPage}
             }
    

    응답 예시

    {
      "returnCode": "0",
      "returnMessage": "SUCCESS",
      "totalRows": 9,
      "page": 1,
      "ipsDataList": [
        {
            "ticketId": "1",
            "date": "1600325545000",
            "product": "IPS_V2",
            "eventNm": "test_event",
            "attackType": null,
            "attackerIp": "10.0.4.10",
            "attackerPort": "2952",
            "targetIp": "10.0.1.7",
            "targetPort": "80",
            "protocol": "TCP",
            "detect": "9",
            "region": "Korea",
            "zoneName": "KR-1",
            "platForm": "VPC",
            "vpcName": "vpc-test"
        }
      ]
    }
    

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

    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.