MENU
      getScanners

        getScanners


        Article summary

        Available in VPC

        View all scanners of the user catalog.

        Request

        Request URL

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

        Request parameters

        Parameter nameRequiredTypeRestrictionsDescription
        catalogIdYesStringUnique catalog ID
        (See getCatalogs)
        pageNoNoIntegerPage number
        Default: 1
        pageSizeNoIntegerMaximum value: 200Result list size
        Default: 20
        searchValueNoStringname/description keyword for the scanner

        Request headers

        See the common guide

        Request example

        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}"
        Bash

        Response

        Response body

        • scannerResponseList: scanner information list of the user catalog
        CategoryTypeDescription
        scannerIdIntegerUnique scanner ID
        nameStringScanner name
        descriptionStringScanner description
        typeStringScanner type
        statusStringScanner status (Pending execution/Execution started/Running/Execution ended)
        locationStringLocation to scan
        scheduleStringcron expression
        scheduleTypeStringExecution cycle (on-demand/daily/weekly/monthly/cron)
        opAddTypeString(When adding schema) Update table definition, add new columns only, ignore
        opDelTypeStringFixed value at DEL_NO
        includePatternStringPatterns to include in scans
        excludePatternStringPatterns to exclude from scans
        tablePrefixNameStringPrefix character of the data that the scanner will run and output
        lastExecStartTimeDateLast execution start time of the scanner
        lastExecElapsedTimeIntegerRun time (seconds) for the scanner's last execution
        lastResultStringResults for the scanner's last execution
        isSchedulePausedIntegerWhether to pause the execution cycle
        catalogIdIntegerUnique user catalog ID
        connectionIdIntegerUnique connection ID
        databaseNameStringDatabase of data that the scanner will run and output
        createTimeDateConnection creation date and time
        updateTimeDateConnection modification date and time
        lastHistoryUuidStringLast scan UUID

        Response example

        HTTP

        HTTP statusDescription
        200OK

        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"
            }
          ]
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.