---
title: "createScanner"
slug: "analytics-datacatalog-scanner-createscanner"
updated: 2026-09-17T09:57:35Z
published: 2026-09-17T09:57:35Z
canonical: "api.ncloud-docs.com/analytics-datacatalog-scanner-createscanner"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# createScanner

VPC環境で利用できます。

スキャナーを作成します。

## リクエスト

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

| メソッド | URI |
| --- | --- |
| POST | /api/v1/catalogs/{catalogId}/scanners |

### リクエストヘッダ

Data Catalog APIで共通して使用されるヘッダの詳細は、[Data Catalogのリクエストヘッダ](/docs/ja/analytics-datacatalog#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

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

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `catalogId` | Integer | Required | カタログ ID - [getCatalogs](/docs/ja/analytics-datacatalog-catalog-getcatalogs)を参照 |

### リクエストボディ

リクエストボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `name` | String | Required | スキャナー名 |
| `type` | String | Required | データタイプ - `OBJECT_STORAGE` \| `ICEBERG` \| `CLOUD_DB_FOR_MYSQL` \| `CLOUD_DB_FOR_MSSQL` \| `CLOUD_DB_FOR_MONGODB` \| `CLOUD_DB_FOR_POSTGRESQL` \| `JDBC` - `OBJECT_STORAGE`: オブジェクトストレージ - `ICEBERG`: Apache Iceberg - `CLOUD_DB_FOR_MYSQL`: Cloud DB for MySQL - `CLOUD_DB_FOR_MSSQL`: Cloud DB for MSSQL - `CLOUD_DB_FOR_MONGODB`: Cloud DB for MongoDB - `CLOUD_DB_FOR_POSTGRESQL`: Cloud DB for PostgreSQL - `JDBC`: JDBC |
| `location` | String | Optional | スキャンのパス - `type`が`OBJECT_STORAGE`または`ICEBERG`の場合、必ず入力 |
| `connectionId` | Integer | Optional | コネクション ID - `type`が`CLOUD_DB_FOR_MYSQL`、`CLOUD_DB_FOR_MSSQL`、`CLOUD_DB_FOR_MONGODB`、`CLOUD_DB_FOR_POSTGRESQL`または`JDBC`の場合、必ず入力 - [getConnection API](/docs/ja/analytics-datacatalog-connection-getconnection)を参照 |
| `scanFileLimitCnt` | Integer | Optional | スキャンの範囲 - `1`~`100`: 一部のファイルのみをスキャン - 入力がない場合はすべてスキャン - `type`が`OBJECT_STORAGE`の場合にのみ入力 |
| `scheduleType` | String | Required | 実行周期 - `ON_DEMAND` \| `CRON` - `ON_DEMAND`: オンデマンド(ユーザーのリクエスト時) - `CRON`: Cron |
| `schedule` | String | Optional | 実行周期の値 - `CRON`: Cron形式で入力 {0 10 * * *} - `scheduleType=ON_DEMAND`がない場合、必ず入力 |
| `excludePattern` | String | Optional | 適用パターン |
| `includePattern` | String | Optional | 含めるパターン |
| `isUseHivePartitionOnly` | Boolean | Optional | hiveパーティションのみ認識するかどうか |
| `databaseName` | String | Required | 出力データベース名 |
| `tablePrefixName` | String | Optional | 作成テーブルの Prefix名 |
| `description` | String | Optional | スキャナーの説明 |
| `opAddType` | String | Required | スキーマ追加時の更新方法 - `ADD_NEW_COLUMNS_ONLY` \| `UPDATE_TABLE` \| `IGNORE_UPDATE` - `ADD_NEW_COLUMNS_ONLY`: 新規の列だけ追加 - `UPDATE_TABLE`: テーブル定義を更新 - `IGNORE_UPDATE`: 無視 |
| `opDelType` | String | Optional | スキーマ削除時の更新方法 - `DEL_NO`: 無視 |
| `maxTableThreshold` | Integer | Optional | 作成テーブルの制限数 |
| `isMergeForce` | Boolean | Optional | テーブルを強制的にマージするかどうか |

### リクエスト例

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

```
curl --location --request POST 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/scanners' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
-data '{     
    "databaseName": "mydatabase", 
    "description": "description", 
    "excludePattern": "*.csv", 
    "includePattern": "*.xml", 
    "isMergeForce": false, 
    "isUseHivePartitionOnly": false, 
    "location": "s3a://mybucket/test/",
    "name": "my-scanner", 
    "opAddType": "UPDATE_TABLE", 
    "opDelType": "DEL_NO", 
    "schedule": "1 0 * * *", 
    "scheduleType": "CRON", 
    "tablePrefixName": "test-", 
    "type": "OBJECT_STORAGE"
}'
```

## レスポンス

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

### レスポンスボディ

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `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` \| `CRON` - `ON_DEMAND`: オンデマンド (ユーザーのリクエスト時) - `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 | - | 分類子リスト: [classifierResponseList](/docs/ja/analytics-datacatalog-scanner-createscanner#classifierResponseList) - スキャナー実行オプションに設定された場合、表示 |
| `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のレスポンスステータスコード](/docs/ja/analytics-datacatalog#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

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

```
{
    "scannerId": 9**,
    "name": "my-scanner",
    "status": "SCANNER_IDLE",
    "description": "description",
    "type": "OBJECT_STORAGE",
    "location": "s3a://mybucket/test/",
    "schedule": "1 0 * * *", 
    "scheduleType": "CRON",
    "opAddType": "UPDATE_TABLE",
    "opDelType": "DEL_NO",
    "tablePrefixName": "test-",
    "lastExecStartTime": "2026-03-19T14:44:55+0900",
    "lastExecElapsedTime": 6,
    "lastResult": "SUCCESS",
    "isSchedulePaused": 0,
    "catalogId": 4**,
    "databaseName": "mydatabase",
    "createTime": "2026-03-18T09:34:42+0900",
    "updateTime": "2026-03-19T14:45:15+0900",
    "lastHistoryUuid": "********"
}
```