Classic/VPC 환경에서 이용 가능합니다.
개요
Web Security Checker API는 RESTful 형태로 제공되며, 제공되는 API를 호출하기 위해서는 Sub Account (서브 계정) 생성 및 Access Key 가 필요합니다.
Web Security Checker 공통 설정
Web Security Checker API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.
요청
공통 요청 형식을 설명합니다.
API URL
요청 API URL은 다음과 같습니다.
https://wsc.apigw.gov-ntruss.com
요청 헤더
헤더에 대한 설명은 다음과 같습니다.
| 필드 | 필수 여부 | 설명 |
|---|---|---|
x-ncp-apigw-timestamp |
Required | 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간(밀리초)
|
x-ncp-iam-access-key |
Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key |
x-ncp-apigw-signature-v2 |
Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명 |
Content-type |
Required | 요청 데이터의 형식
|
응답
공통 응답 형식을 설명합니다.
응답 상태 코드
응답 상태 코드에 대한 설명은 다음과 같습니다.
| HTTP 상태 코드 | 코드 | 메시지 | 설명 |
|---|---|---|---|
| 200 | 0 | success | 성공 |
| 400 | 901 | API Call Fail | 일시적으로 사용이 원활하지 않으며 오류가 계속될 경우 고객지원 > 문의하기에 문의 |
| 401 | 169201 | Auth Check Error | 사용 권한 없음 |
| 400 | 169202 | User Check Error | 고객 계정정보 확인에 실패했으며 확인을 위해 고객문의 필요 |
| 400 | 160331 | ActionURL Check Error | Action URL 에 http, https 를 입력 |
| 400 | 160332 | Param Check Error | 입력값에 허용되지 않는 값이 존재하며, ID param / PW param 값에는 특수문자 사용이 제한됨 |
| 400 | 160351 | Login_Check_Fail | 로그인 과정에서 오류가 발생했으며 로그인 정보를 다시 확인하여 재시도를 하거나, Cookie 직접 입력 필요 |
| 400 | 160353 | URL Connection Error | 입력한 Action URL 연결 실패 |
| 400 | 160431 | Param Check Error | 입력값에 허용되지 않는 값 존재 |
| 400 | 160432 | Param Check Null | 입력값에 누락 존재 |
| 400 | 160433 | Param Value Not Define | 입력값에 정의되지 않은 값 존재 |
| 400 | 160441 | DB Execute Query Error | 스캔 작업 등록 처리 과정에서 에러가 발생했으며 잠시후 다시 시도 필요 |
| 400 | 160451 | Assets_Check_Fail | 고객의 네이버 클라우드 플랫폼 서버가 아니며 고객 소유의 네이버 클라우드 플랫폼 자산만 진단 가능 |
| 400 | 160452 | Queue_Full | 선택한 일정의 경우, 예약이 꽉 찼으며 다른 일정으로 선택 필요 |
| 400 | 160453 | Already_Exists | 하나의 대상에 대해서 취약점 진단을 동시에 수행 불가하며, 현재 설정한 진단 대상은 진단 대기중임으로 페이지 상단에 있는“Scan Status / Results” 메뉴에서 확인 필요 |
| 400 | 160454 | TooMany_Insert | 작업 대기중인 리스트가 너무 많기에 스캔 진행 후 추가 필요 |
| 400 | 160455 | ReScan Create failed | 재진단 등록 조건이 맞지 않기에 대상의 도메인 및 IP 가 최초 진단과 같아야하며, 첫 진단 종료로부터 60일 내에 3번만 가능 |
| 400 | 160456 | Managed Service agree chk failed | 타사 웹서버 진단에 대한 동의 정보를 확인 할 수 없으며 동의한 후 이용 가능 |
| 400 | 160457 | Managed Service file chk failed | 타사 웹서버 진단에 필요한 파일체크에 실패했으며 타사 웹서버 진단 안내 팝업의 2번 항목 진행 필요 |
| 400 | 160701 | Open period expired | 진단결과 리포트의 열람 가능 기간은 1년 |
| 400 | 160842 | DB Matcing Data 0 | 취소할 대상이 없으며 일괄 취소는 예약 및 대기 상태의 작업만 취소 가능 |
| 400 | 165244 | DB Data Record CNT Not Matching | 요청된 instanceNo 리스트와 DB조회 레코드 수가 다름 |
참고
네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.
Web Security Checker API
Web Security Checker API 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다.
| API | 설명 |
|---|---|
| getJobs | 진단 리스트 조회 |
| searchJobs | 진단 리스트 필터링 검색 |
| cancelJob | 진단 작업 전 취소 |
| stopJob | 진행 중인 진단 작업 중지 |
| getReport | 진단 결과 리포트 조회 |
| createJob | 진단 작업 생성 |