getScanner

Prev Next

Available in VPC

Get details of a scanner.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /api/v1/catalogs/{catalogId}/scanners/{scannerId}

Request headers

For information about the headers common to all Data Catalog APIs, see Data Catalog request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
catalogId Integer Required Catalog ID
scannerId Integer Required Scanner ID

Request example

The request example is as follows:

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}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
scannerId Integer - Scanner ID
name String - Scanner name
status String - Scanner status
  • SCANNER_IDLE | SCANNER_STARTING | SCANNER_RUNNING | SCANNER_STOPPING | SCANNER_DONE
    • SCANNER_IDLE: pending execution
    • SCANNER_STARTING: execution started
    • SCANNER_RUNNING: running
    • SCANNER_STOPPING: execution stopped
    • SCANNER_DONE: execution completed
description String - Scanner description
  • Displayed if a value exists
type String - Source data type
location String - Source data path
schedule String - Cron expression for scanner execution cycle
  • Displayed if periodic execution is set
scheduleType String - Scanner execution cycle
  • ON_DEMAND | EVERY_DAY | EVERY_WEEK | EVERY_MONTH | CRON
    • ON_DEMAND: on-demand (upon user request)
    • EVERY_DAY: every day
    • EVERY_WEEK: every week
    • EVERY_MONTH: every month
    • CRON: cron
opAddType String - Collection options when adding schema
  • UPDATE_TABLE | ADD_NEW_COLUMNS_ONLY | IGNORE_UPDATE
    • UPDATE_TABLE: Update table definition.
    • ADD_NEW_COLUMNS_ONLY: Only add new column.
    • IGNORE_UPDATE: Ignore.
opDelType String - Options when deleting schema
  • DEL_NO: Ignore (valid value).
includePattern String - Patterns to include in scan
excludePattern String - Patterns to exclude from scan
  • Exclusion patterns take precedence over inclusion patterns.
tablePrefixName String - Output data prefix
  • Displayed if a value exists
lastExecStartTime String - Last scanner execution date and time
  • ISO 8601 format
lastExecElapsedTime Integer - Last scanner execution time (second)
lastResult String - Last scanner execution result
isSchedulePaused Integer - Whether to pause the execution cycle
  • 1 | 0
    • 1: pause
    • 0: pause unavailable
catalogId Integer - Catalog ID
connectionId Integer - Connection ID
connectionName String - Connection name
classifierResponseList Array - Classifier list
  • Displayed if set as the scanner execution option
databaseName String - Database name for the output data
createTime String - Scanner creation date and time
  • ISO 8601 format
updateTime String - Update date and time
  • ISO 8601 format
lastHistoryUuid String - Last execution history UUID

classifierResponseList

The following describes classifierResponseList.

Field Type Required Description
disabled Boolean - Non-availability
  • true | false
    • true: unavailable
    • false: available
classifierId Integer - Classifier ID
catalogId Integer - Catalog ID
name String - Classifier name
type String - Classifier type
  • CSV | JSON | XML
    • CSV: CSV file
    • JSON: JSON file
    • XML: XML file
value String - Details by classifier type
  • CSV: column separator
  • JSON: metadata creation target path
  • XML: row classification tag name
createTime String - Classifier creation date and time
  • ISO 8601 format

Response status codes

For response status codes common to all Data Catalog APIs, see Data Catalog response status codes.

Response example

The response example is as follows:

{
    "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": "********"
}