Web Security Checker 개요
- 인쇄
- PDF
Web Security Checker 개요
- 인쇄
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
개요
Web Security Checker API는 RETSTful 형태로 제공되며, 제공되는 API를 호출하기 위해서는 Sub Account (서브 계정) 생성 및 Access Key 가 필요합니다.
공통 설정
API
| Service | API | Method | Request URI |
|---|---|---|---|
| Web Security Checker | getJobs | GET | https://wsc.apigw.ntruss.com/api/v1/jobs |
| Web Security Checker | searchJobs | POST | https://wsc.apigw.ntruss.com/api/v1/jobs/search |
| Web Security Checker | cancelJob | PATCH | https://wsc.apigw.ntruss.com/api/v1/jobs/{instanceId}/cancel |
| Web Security Checker | stopJob | PATCH | https://wsc.apigw.ntruss.com/api/v1/jobs/{instanceId}/stop |
| Web Security Checker | getReport | GET | https://wsc.apigw.ntruss.com/api/v1/jobs/report |
| Web Security Checker | createJob | PUT | https://wsc.apigw.ntruss.com/api/v1/job |
요청 헤더
IAM 인증을 위한 요청 헤더입니다.
| 헤더명 | 설명 |
|---|---|
| x-ncp-apigw-timestamp | 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 |
| x-ncp-iam-access-key | 네이버 클라우드 플랫폼에서 IAM 에서 발급받은 AccessKey |
| x-ncp-apigw-signature-v2 | 요청 경로 및 헤더를 AccessKey와 맵핑되는 SecretKey로 암호화한 서명으로 HMAC 암호화 알고리즘은 HmacSHA256 을 사용 |
공통 오류
| HTTP 응답 코드 | ErrorCode | ErrorMessage |
|---|---|---|
| 400 | 100 | Bad Request Exception |
| 401 | 200 | Authentication Failed |
| 401 | 210 | Permission Denied |
| 404 | 300 | Not Found Exception |
| 429 | 400 | Quota Exceeded |
| 429 | 410 | Throttle Limited |
| 429 | 420 | Rate Limited |
| 413 | 430 | Request Entity Too Large |
| 503 | 500 | Endpoint Error |
| 504 | 510 | Endpoint Timeout |
| 500 | 900 | Unexpected Error |
서비스 오류
| HTTP 응답 코드 | errorCode | message | 설명 |
|---|---|---|---|
| 200 | 0 | success | 성공 |
| 200 | 901 | API Call Fail | 일시적으로 사용이 원활하지 않으며 오류가 계속될 경우 고객지원 > 문의하기에 문의 |
| 200 | 169201 | Auth Check Error | 사용 권한 없음 |
| 200 | 169202 | User Check Error | 고객 계정정보 확인에 실패했으며 확인을 위해 고객문의 필요 |
| 200 | 160331 | ActionURL Check Error | Action URL 에 http, https 를 입력 |
| 200 | 160332 | Param Check Error | 입력값에 허용되지 않는 값이 존재하며, ID param / PW param 값에는 특수문자 사용이 제한됨 |
| 200 | 160351 | Login_Check_Fail | 로그인 과정에서 오류가 발생했으며 로그인 정보를 다시 확인하여 재시도를 하거나, Cookie 직접 입력 필요 |
| 200 | 160353 | URL Connection Error | 입력한 Action URL 연결 실패 |
| 200 | 160431 | Param Check Error | 입력값에 허용되지 않는 값 존재 |
| 200 | 160432 | Param Check Null | 입력값에 누락 존재 |
| 200 | 160433 | Param Value Not Define | 입력값에 정의되지 않은 값 존재 |
| 200 | 160441 | DB Execute Query Error | 스캔 작업 등록 처리 과정에서 에러가 발생했으며 잠시후 다시 시도 필요 |
| 200 | 160451 | Assets_Check_Fail | 고객의 네이버 클라우드 플랫폼 서버가 아니며 고객 소유의 네이버 클라우드 플랫폼 자산만 진단 가능 |
| 200 | 160452 | Queue_Full | 선택한 일정의 경우, 예약이 꽉 찼으며 다른 일정으로 선택 필요 |
| 200 | 160453 | Already_Exists | 하나의 대상에 대해서 취약점 진단을 동시에 수행 불가하며, 현재 설정한 진단 대상은 진단 대기중임으로 페이지 상단에 있는“Scan Status / Results” 메뉴에서 확인 필요 |
| 200 | 160454 | TooMany_Insert | 작업 대기중인 리스트가 너무 많기에 스캔 진행 후 추가 필요 |
| 200 | 160455 | ReScan Create failed | 재진단 등록 조건이 맞지 않기에 대상의 도메인 및 IP 가 최초 진단과 같아야하며, 첫 진단 종료로부터 60일 내에 3번만 가능 |
| 200 | 160456 | Managed Service agree chk failed | 타사 웹서버 진단에 대한 동의 정보를 확인 할 수 없으며 동의한 후 이용 가능 |
| 200 | 160457 | Managed Service file chk failed | 타사 웹서버 진단에 필요한 파일체크에 실패했으며 타사 웹서버 진단 안내 팝업의 2번 항목 진행 필요 |
| 200 | 160701 | Open period expired | 진단결과 리포트의 열람 가능 기간은 1년 |
| 200 | 160842 | DB Matcing Data 0 | 취소할 대상이 없으며 일괄 취소는 예약 및 대기 상태의 작업만 취소 가능 |
| 200 | 165244 | DB Data Record CNT Not Matching | 요청된 intacneNo 리스트와 DB조회 레코드 수가 다름 |
이 문서가 도움이 되었습니까?