概要
Web Security Checker APIは RESTful形式で提供され、その APIを呼び出すには Sub Account(サブアカウント)の作成と Access Keyが必要です。
Web Security Checkerの共通設定
Web Security Checker APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。
リクエスト
共通リクエスト形式を説明します。
API URL
リクエスト API URLは次の通りです。
https://wsc.apigw.ntruss.com
リクエストヘッダ
ヘッダの説明は次の通りです。
| フィールド | 必須の有無 | 説明 |
|---|---|---|
x-ncp-apigw-timestamp |
Required | 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
|
x-ncp-iam-access-key |
Required | NAVERクラウドプラットフォームから発行された Access Key
|
x-ncp-apigw-signature-v2 |
Required | NAVERクラウドプラットフォームから発行された 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 | 顧客の NAVERクラウドプラットフォームサーバではない。顧客が所有する NAVERクラウドプラットフォーム資産のみ診断可能 |
| 400 | 160452 | Queue_Full | 選択したスケジュールは予約がいっぱいのため、別のスケジュールの選択が必要 |
| 400 | 160453 | Already_Exists | 1つの対象に脆弱性診断を同時に実行不可。現在設定されている対象は診断待ち状態であり、ページ上部の「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照会レコード数が一致しない |
参考
NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
Web Security Checker API
Web Security Checker APIサービスで提供する APIの説明は次の通りです。
| API | 説明 |
|---|---|
| getJobs | 診断リストを照会 |
| searchJobs | 診断リスト絞り込み検索 |
| cancelJob | 診断ジョブ前にキャンセル |
| stopJob | 実行中の診断ジョブを停止 |
| getReport | 診断結果レポートを照会 |
| createJob | 診断ジョブを作成 |