getJobs

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

概要

getJobs APIは、「Web Security Checker」で提供される機能で、ユーザーが登録した診断のリストを出力するAPIです。

リクエスト

Method	Request URI
GET	`https://wsc.apigw.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	NAVERクラウドプラットフォームのIAMから発行されたAccessKeyです。
x-ncp-apigw-signature-v2	リクエストパスやヘッダーをAccessKeyにマッピングされるSecretKeyで暗号化した署名で HMACの暗号化アルゴリズムはHmacSHA256を使用します。

リクエストパラメーター

パラメーター名	必須	タイプ	説明
limit	Yes	integer	リストのページごとの出力項目数
page	Yes	integer	リストのページ番号

レスポンス

レスポンスボディー

フィールド名	必須	タイプ	説明
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.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}"

レスポンス例

{
    "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
            }
        ]
    }
}

レスポンス例（診断リスト）

{
    "resources": {
        "total_cnt": 0,
        "total_page_cnt": "1",
        "current_start_page": "1",
        "current_end_page": "1",
        "record_data": null
    }
}

この記事は役に立ちましたか?

What's Next

searchJobs

概要
リクエスト
レスポンス
例

タグ

Web Security Checker