getScanners

印刷する
共有
PDF

記事の要約

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

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

VPC環境で利用できます。

ユーザー Catalogのすべての Scannerを照会します。

リクエスト

リクエスト URL

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

リクエストパラメータ

パラメータ名	必須の有無	タイプ	制限事項	説明
catalogId	Yes	String		catalogの固有 ID (getCatalogsを参照)
pageNo	No	Integer		ページ番号デフォルト: 1
pageSize	No	Integer	最大値: 200	結果リストサイズデフォルト: 20
searchValue	No	String		scannerの name/description検索キーワード

リクエストヘッダ

共通ガイドを参照

リクエスト例

curl -X GET "https://datacatalog.apigw.ntruss.com/api/v1/catalogs/{catalog-id}/scanners?pageNo=1&pageSize=20" \
    -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}"

レスポンス

レスポンスボディ

scannerResponseList: ユーザー catalogの scanner情報リスト

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

レスポンス例

HTTP

HTTP Status	Description
200	OK

JSON

{
  "pageNo": 1,
  "pageSize": 20,
  "totalCount": 1,
  "scannerResponseList": [
    {
      "scannerId": 89,
      "name": "datacatalog-test-scanner",
      "description": "datacatalog scanner description",
      "type": "OBJECT_STORAGE",
      "status": "SCANNER_IDLE",
      "location": "singlefile",
      "schedule": "0 10 * * *",
      "scheduleType": "EVERY_DAY",
      "opAddType": "UPDATE_TABLE",
      "opDelType": "DEL_NO",
      "includePattern": "",
      "excludePattern": "*.json",
      "tablePrefixName": "daily_",
      "lastExecStartTime": "2023-06-08T10:00:00+0900",
      "lastExecElapsedTime": 15,
      "lastResult": "SUCCESS",
      "isSchedulePaused": 0,
      "catalogId": 301,
      "connectionId": 87,
      "databaseName": "datacatalog-scan-db",
      "createTime": "2022-12-07T17:25:27+0900",
      "updateTime": "2023-06-08T10:01:15+0900",
      "lastHistoryUuid":"zdiWs2a"
    }
  ]
}

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

What's Next

getScanner

リクエスト
レスポンス

タグ

Data Catalog