getScanner

印刷する
共有
PDF

記事の要約

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

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

VPC環境で利用できます。

ユーザー Catalogの特定の Scanner IDに該当する Scannerを照会します。

リクエスト

リクエスト URL

GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/scanners/{scanner-id}

リクエストパラメータ

パラメータ名	必須の有無	タイプ	制限事項	説明
catalogId	Yes	String		catalogの固有 ID (getCatalogsを参照)
scannerId	Yes	String		scannerの固有 ID

リクエストヘッダ

共通ガイドを参照

リクエスト例

curl -X GET "https://datacatalog.apigw.ntruss.com/api/v1/catalogs/{catalog-id}/scanners/{scanner-id}" \
    -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}" \
    -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"  \
    -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"

レスポンス

レスポンスボディ

項目	タイプ	説明
scannerId	Integer	Scannerの固有 ID
name	String	Scanner名
description	String	Scannerの説明
type	String	Scannerタイプ
status	String	Scannerrの状態(実行待機/実行開始/実行中/実行終了)
location	String	スキャンする位置
schedule	String	cron expression
scheduleType	String	実行周期(オンデマンド/毎日/毎週/毎月/クロン)
opAddType	String	(スキーマ追加時)テーブル定義を更新/新規の列だけ追加/無視
opDelType	String	DEL_NOを固定値にする
includePattern	String	スキャン対象に含めるパターン
excludePattern	String	スキャン対象から外すパターン
tablePrefixName	String	Scanner実行されて出力するデータの Prefix文字
lastExecStartTime	Date	Scannerの最終実行開始時間
lastExecElapsedTime	Integer	Scannerの最終実行の実行時間(秒)
lastResult	String	Scannerの最終実行の結果
isSchedulePaused	Integer	実行周期を一時停止するかどうか
catalogId	Integer	ユーザー Catalogの固有 ID
connectionId	Integer	Connectionの固有 ID
connectionName	String	Connection名
classifierResponseList	json	Scannerの実行オプションとして適用された分類子リスト情報
databaseName	String	Scanner実行されて出力するデータのデータベース
createTime	Date	Connectionの作成日時
updateTime	Date	Cfonnectionの更新日時
lastHistoryUuid	String	最終スキャン履歴 UUID

レスポンス例

HTTP

HTTP Status	Description
200	OK

JSON

{
  "scannerId": 89,
  "name": "datacatalog-test-scanner",
  "description": "",
  "type": "OBJECT_STORAGE",
  "status": "SCANNER_IDLE",
  "location": "datacatalog-test",
  "schedule": "",
  "scheduleType": "ON_DEMAND",
  "opAddType": "UPDATE_TABLE",
  "opDelType": "DEL_NO",
  "includePattern": "",
  "excludePattern": "",
  "tablePrefixName": "",
  "lastExecStartTime": "2023-06-16T10:45:54+0900",
  "lastExecElapsedTime": 6,
  "lastResult": "SUCCESS",
  "isSchedulePaused": 0,
  "catalogId": 301,
  "connectionId": 87,
  "connectionName": "datacatalog-test-conn",
  "classifierResponseList": [
    {
      "disabled": false,
      "classifierId": 30,
      "catalogId": 301,
      "name": "datacatalog-json-classier",
      "type": "JSON",
      "value": "$.store.book[*]",
      "createTime": "2022-12-05T10:07:08+0900"
    },
    {
      "disabled": false,
      "classifierId": 31,
      "catalogId": 301,
      "name": "datacatalog-csv-classier",
      "type": "CSV",
      "value": ",",
      "createTime": "2023-04-17T08:14:45+0900"
    }
  ],
  "databaseName": "datacatalog-scan-db",
  "createTime": "2023-05-19T20:12:26+0900",
  "updateTime": "2023-06-16T10:46:15+0900",
  "lastHistoryUuid": do5sxpiAs"
}

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

What's Next

getScannerHistories

リクエスト
レスポンス

タグ

Data Catalog