getJobs
- 인쇄
- PDF
getJobs
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
개요
- getJobs API 는 "Web Security Checker" 에서 제공하는 기능으로 사용자가 등록한 진단 리스트를 출력하는 API 입니다.
요청
| Method | Request URI |
|---|---|
| GET | https://wsc.apigw.gov-ntruss.com/api/v1/jobs |
요청 헤더
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을 사용 |
요청 파라미터
| 파라미터명 | 필수 여부 | 타입 | 설명 |
|---|---|---|---|
| limit | Yes | integer | 리스트의 한 페이지 당 출력 항목 수 (default: 20) |
| page | Yes | integer | 리스트의 페이지 번호 (default: 1) |
응답
응답 바디
| 필드명 | 필수 여부 | 타입 | 설명 |
|---|---|---|---|
| total_cnt | Yes | integer | 총 작업 레코드 수 |
| total_page_cnt | Yes | integer | 마지막 페이지(page) |
| current_start_page | Yes | integer | Pagination 노출 시 시작 페이지 번호 (10개 단위) |
| current_end_page | Yes | integer | Pagination 노출 시 마지막 페이지 번호 (10개 단위) |
| record_data | Yes | array | 진단 리스트 |
| record_data[].instanceNo | Yes | integer | 작업(Job)의 식별 번호 |
| record_data[].start_date | Yes | date | 진단 작업(Job) 시작 시간 |
| record_data[].end_date | Yes | date | 진단 작업(Job) 종료 시간 |
| record_data[].status | Yes | string | 작업 상태(Job Status) |
| record_data[].start_url | Yes | string | 진단 작업 대상 URL |
| record_data[].crawl_cnt | Yes | integer | 크롤링 URL 수집 카운트 |
| record_data[].scan_cnt | Yes | integer | 취약점 카운트 |
| record_data[].memo | Yes | string | 작업(Job) 메모(memo) |
| record_data[].result_button | Yes | string | 작업 리포트 출력 가능 여부 및 작업 취소 여부 등의 작업 상태를 표기 report : 리포트 출력 가능 상태 cancel : 작업 취소 상태 terminate : 작업 중지 상태 expired : 기간 만료 cause : 작업 진행 중 오류 발생 |
| record_data[].result_desc | Yes | string | 작업 결과 상세 설명 (작업 오류일 경우 상세 출력) |
| record_data[].rescan_button | Yes | string | 재진단 가능 상태를 표시 possible: 재진단 가능 expired : 기간 만료로 재진단 불가 null : 재진단 불가 |
| record_data[].slave_data | Yes | Array |
예시
요청 예시
curl -X GET "https://wsc.apigw.gov-ntruss.com/api/v1/jobs?limit=10&page=1"
-H "accept: application/json"
-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}"
응답 예시 1
{
"resources": {
"total_cnt": 1,
"total_page_cnt": "1",
"current_start_page": "1",
"current_end_page": "10",
"record_data": [
{
"instanceNo": "1234567890",
"start_date": "2020-05-21 12:00:00",
"end_date": null,
"status": "예약",
"start_url": "http://your-domain.com",
"crawl_cnt": null,
"scan_cnt": null,
"memo": "샘플",
"result_button": "cancel",
"result_desc": null,
"rescan_button": null,
"slave_data": null
}
]
}
}
응답 예시 2
{
"resources": {
"total_cnt": 0,
"total_page_cnt": "1",
"current_start_page": "1",
"current_end_page": "1",
"record_data": null
}
}
이 문서가 도움이 되었습니까?