getScanner

VPC環境で利用できます。

スキャナーの詳細情報を照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`scannerId`	Integer	-	スキャナー ID
`name`	String	-	スキャナー名
`status`	String	-	スキャナーの状態 `SCANNER_IDLE` \| `SCANNER_STARTING` \| `SCANNER_RUNNING` \| `SCANNER_STOPPING` \| `SCANNER_DONE` `SCANNER_IDLE`: 実行待機 `SCANNER_STARTING`: 実行開始 `SCANNER_RUNNING`: 実行中 `SCANNER_STOPPING`: 実行停止 `SCANNER_DONE`: 実行終了
`description`	String	-	スキャナーの説明値が存在する場合、表示
`type`	String	-	ソースデータのタイプ
`location`	String	-	ソースデータのパス
`schedule`	String	-	スキャナー実行周期の cron表現式周期的実行が設定された場合、表示
`scheduleType`	String	-	スキャナーの実行周期 `ON_DEMAND` \| `EVERY_DAY` \| `EVERY_WEEK` \| `EVERY_MONTH` \| `CRON` `ON_DEMAND`: オンデマンド (ユーザーからのリクエスト時) `EVERY_DAY`: 毎日 `EVERY_WEEK`: 毎週 `EVERY_MONTH`: 毎月 `CRON`: cron
`opAddType`	String	-	スキーマ追加時の収集オプション `UPDATE_TABLE` \| `ADD_NEW_COLUMNS_ONLY` \| `IGNORE_UPDATE` `UPDATE_TABLE`: テーブルの定義を更新 `ADD_NEW_COLUMNS_ONLY`: 新規の列だけ追加 `IGNORE_UPDATE`: 無視
`opDelType`	String	-	スキーマ削除時のオプション `DEL_NO`: 無視 (有効値)
`includePattern`	String	-	スキャン対象に含めるパターン
`excludePattern`	String	-	スキャン対象から外すパターン外すパターンが含めるパターンより優先して適用
`tablePrefixName`	String	-	出力データの接頭辞値が存在する場合、表示
`lastExecStartTime`	String	-	スキャナーの直近実行日時 ISO 8601形式
`lastExecElapsedTime`	Integer	-	スキャナーの直近実行時間(秒)
`lastResult`	String	-	スキャナーの直近の実行結果
`isSchedulePaused`	Integer	-	実行周期は一時停止されているか `1` \| `0` `1`: 一時停止 `0`: 一時停止されていない
`catalogId`	Integer	-	カタログ ID
`connectionId`	Integer	-	コネクション ID
`connectionName`	String	-	コネクション名
`classifierResponseList`	Array	-	分類子リストスキャナー実行オプションに設定された場合、表示
`databaseName`	String	-	出力データのデータベース名
`createTime`	String	-	スキャナーの作成日時 ISO 8601形式
`updateTime`	String	-	更新日時 ISO 8601形式
`lastHistoryUuid`	String	-	直近の実行履歴 UUID

`classifierResponseList`

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

フィールド	タイプ	必須の有無	説明
`disabled`	Boolean	-	使用不可かどうか `true` \| `false` `true`: 不可 `false`: 可能
`classifierId`	Integer	-	分類子 ID
`catalogId`	Integer	-	カタログ ID
`name`	String	-	分類子名
`type`	String	-	分類子タイプ `CSV` \| `JSON` \| `XML` `CSV`: CSVファイル `JSON`: JSONファイル `XML`: XMLファイル
`value`	String	-	分類子タイプによる詳細情報 CSV: 列区切り文字 JSON: メタデータ作成対象のパス XML: 行区切りタグ名
`createTime`	String	-	分類子の作成日時 ISO 8601形式

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

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

レスポンス例

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

{
    "scannerId": 9**,
    "name": "employee_list",
    "status": "SCANNER_IDLE",
    "description": "employee list",
    "type": "OBJECT_STORAGE",
    "location": "s3a://datacatalog-c***-e******f/my_database/employeeList/",
    "schedule": "0 2 1 * *",
    "scheduleType": "EVERY_MONTH",
    "opAddType": "UPDATE_TABLE",
    "opDelType": "DEL_NO",
    "tablePrefixName": "out_",
    "lastExecStartTime": "2025-03-19T14:44:55+0900",
    "lastExecElapsedTime": 6,
    "lastResult": "SUCCESS",
    "isSchedulePaused": 0,
    "catalogId": 4**,
    "classifierResponseList": [
        {
            "disabled": false,
            "classifierId": 1**,
            "catalogId": 4**,
            "name": "csv_class",
            "type": "CSV",
            "value": ",",
            "createTime": "2025-03-19T14:41:44+0900"
        }
    ],
    "databaseName": "default",
    "createTime": "2025-03-18T09:34:42+0900",
    "updateTime": "2025-03-19T14:45:15+0900",
    "lastHistoryUuid": "********"
}