getScanners

VPC環境で利用できます。

カタログ内のスキャナーリストを照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

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

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

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	Optional	ページ番号 1~N (デフォルト: 1)
`pageSize`	Integer	Optional	ページの出力数 1~200 (デフォルト: 20)
`searchValue`	String	Optional	検索キーワードスキャナー名または説明で検索可能ハングルを入力する場合、URLエンコードが必要

リクエスト例

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

curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/scanners?searchValue=%EB%8F%84%EC%84%9C%EA%B4%80' \
--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	-	レスポンス結果数
`scannerResponseList`	Array	-	スキャナーリスト

`scannerResponseList`

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

フィールド	タイプ	必須の有無	説明
`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
`databaseName`	String	-	出力データのデータベース名
`createTime`	String	-	スキャナーの作成日時 ISO 8601形式
`updateTime`	String	-	更新日時 ISO 8601形式
`lastHistoryUuid`	String	-	直近の実行履歴 UUID

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

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

レスポンス例

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

{
    "pageNo": 1,
    "pageSize": 20,
    "totalCount": 7,
    "scannerResponseList": [
        {
            "scannerId": 9**,
            "name": "s_mysql",
            "status": "SCANNER_IDLE",
            "description": "Scanner for my_DB",
            "type": "CLOUD_DB_FOR_MYSQL",
            "location": "tables",
            "schedule": "0 4 * * *",
            "scheduleType": "EVERY_DAY",
            "opAddType": "UPDATE_TABLE",
            "opDelType": "DEL_NO",
            "includePattern": "req_avg_*",
            "excludePattern": "sample/*.json",
            "tablePrefixName": "out_",
            "lastExecStartTime": "2025-03-18T17:15:58+0900",
            "lastExecElapsedTime": 6,
            "lastResult": "SUCCESS",
            "isSchedulePaused": 0,
            "catalogId": 4**,
            "connectionId": 6**,
            "databaseName": "default",
            "createTime": "2025-03-18T14:36:29+0900",
            "updateTime": "2025-03-19T11:21:06+0900",
            "lastHistoryUuid": "********"
        },
        {
            "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": "ADD_NEW_COLUMNS_ONLY",
            "opDelType": "DEL_NO",
            "lastExecStartTime": "2025-03-18T09:40:41+0900",
            "lastExecElapsedTime": 6,
            "lastResult": "SUCCESS",
            "isSchedulePaused": 0,
            "catalogId": 4**,
            "databaseName": "default",
            "createTime": "2025-03-18T09:34:42+0900",
            "updateTime": "2025-03-19T10:18:10+0900",
            "lastHistoryUuid": "********"
        },
        ...
    ]
}