概要
Web Security Checker APIは RESTful形式で提供され、その 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)からの経過時間をミリ秒で表したもの API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす |
x-ncp-iam-access-key |
NAVERクラウドプラットフォーム IAMから発行された Access Key |
x-ncp-apigw-signature-v2 |
リクエストパスとヘッダを Access Keyとマッピングする Secret Keyで暗号化した署名 HMAC暗号化アルゴリズムは HmacSHA256を使用 |
Content-Type |
リクエストボディ Content Typeをapplication/jsonに指定 |
共通エラー
| 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レスポンスコード | エラー | 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 | 顧客の NAVERクラウドプラットフォームサーバではない。顧客が所有する NAVERクラウドプラットフォーム資産のみ診断可能 |
| 200 | 160452 | Queue_Full | 選択したスケジュールは予約がいっぱいのため、別のスケジュールの選択が必要 |
| 200 | 160453 | Already_Exists | 1つの対象に脆弱性診断を同時に実行不可。現在設定されている対象は診断待ち状態であり、ページ上部の「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 | リクエストされた instanceNoリストと DB照会レコード数が一致しない |