getScannerHistories

VPC環境で利用できます。

スキャナーの実行履歴を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/api/v1/catalogs/{catalogId}/scanners/{scannerId}/histories

リクエストヘッダ

Data Catalog APIで共通して使用されるヘッダの詳細は、Data Catalogのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`catalogId`	Integer	Required	カタログ ID getCatalogsを参照
`scannerId`	Integer	Required	スキャナー ID getScannersを参照

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`fromTimestamp`	Integer	Required	照会開始日時(ミリ秒) Unix Timestamp形式
`toTimestamp`	Integer	Required	照会終了日時(ミリ秒) Unix Timestamp形式
`pageNo`	Integer	Optional	ページ番号 1~N (デフォルト: 1)
`pageSize`	Integer	Optional	ページの出力数 1~200 (デフォルト: 20)

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/scanners/9**/histories?fromTimestamp=1742338800000&toTimestamp=1742342400000' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	-	ページ番号
`pageSize`	Integer	-	ページ表示数
`totalCount`	Integer	-	レスポンス結果数
`scannerHistoryListResponseList`	Array	-	実行履歴リスト

`scannerHistoryListResponseList`

scannerHistoryListResponseListの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`scannerId`	Integer	-	スキャナー ID
`catalogId`	Integer	-	カタログ ID
`beginTime`	String	-	スキャンの開始日時 ISO 8601形式
`endTime`	String	-	スキャンの終了日時 ISO 8601形式
`result`	String	-	スキャナーの実行結果 `SUCCESS` \| `FAIL` \| `CANCEL` `SUCCESS`: 成功 `FAIL`: 失敗 `CANCEL`: キャンセル
`resultMessage`	String	-	実行結果メッセージ `result`が`FAIL`または`CANCEL`の場合、表示
`tableChanges`	String	-	スキャンの結果、追加されたか変更されたテーブルとパーティション情報 `result`が`SUCCESS`の場合、表示
`elapsedTime`	Integer	-	スキャナーの実行時間(秒)
`createTime`	String	-	履歴の作成日時 ISO 8601形式

レスポンスステータスコード

Data Catalog APIで共通して使用されるレスポンスステータスコードの詳細は、Data Catalogのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "pageNo": 1,
    "pageSize": 20,
    "totalCount": 3,
    "scannerHistoryListResponseList": [
        {
            "scannerId": 9**,
            "catalogId": 4**,
            "beginTime": "2025-03-19T08:50:45+0900",
            "endTime": "2025-03-19T08:50:50+0900",
            "result": "FAIL",
            "resultMessage": "scanner finished with error",
            "elapsedTime": 5,
            "createTime": "2025-03-19T08:50:51+0900"
        },
        {
            "scannerId": 9**,
            "catalogId": 4**,
            "beginTime": "2025-03-19T08:49:36+0900",
            "endTime": "2025-03-19T08:49:41+0900",
            "result": "FAIL",
            "resultMessage": "scanner finished with error",
            "elapsedTime": 5,
            "createTime": "2025-03-19T08:49:42+0900"
        },
        {
            "scannerId": 9**,
            "catalogId": 4**,
            "beginTime": "2025-03-19T08:43:44+0900",
            "endTime": "2025-03-19T08:43:50+0900",
            "result": "SUCCESS",
            "tableChanges": "{\"table_added\": {\"count\": 1, \"list\": [\"library_books_csv\"]}, \"table_updated\": {\"count\": 0, \"list\": []}, \"table_failed\": {\"count\": 0, \"list\": []}, \"partition_added\": {\"count\": 0, \"list\": []}, \"partition_updated\": {\"count\": 0, \"list\": []}, \"partition_failed\": {\"count\": 0, \"list\": []}}",
            "elapsedTime": 6,
            "createTime": "2025-03-19T08:43:50+0900"
        }
    ]
}