getScanners
- Print
- PDF
getScanners
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
View all scanners of the user catalog.
Request
Request URL
GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/scanners
Request parameters
| Parameter name | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| catalogId | Yes | String | Unique catalog ID (See getCatalogs) | |
| pageNo | No | Integer | Page number Default: 1 | |
| pageSize | No | Integer | Maximum value: 200 | Result list size Default: 20 |
| searchValue | No | String | name/description keyword for the scanner |
Request headers
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}"
Response
Response body
- scannerResponseList: scanner information list of the user catalog
| Category | Type | Description |
|---|---|---|
| scannerId | Integer | Unique scanner ID |
| name | String | Scanner name |
| description | String | Scanner description |
| type | String | Scanner type |
| status | String | Scanner status (Pending execution/Execution started/Running/Execution ended) |
| location | String | Location to scan |
| schedule | String | cron expression |
| scheduleType | String | Execution cycle (on-demand/daily/weekly/monthly/cron) |
| opAddType | String | (When adding schema) Update table definition, add new columns only, ignore |
| opDelType | String | Fixed value at DEL_NO |
| includePattern | String | Patterns to include in scans |
| excludePattern | String | Patterns to exclude from scans |
| tablePrefixName | String | Prefix character of the data that the scanner will run and output |
| lastExecStartTime | Date | Last execution start time of the scanner |
| lastExecElapsedTime | Integer | Run time (seconds) for the scanner's last execution |
| lastResult | String | Results for the scanner's last execution |
| isSchedulePaused | Integer | Whether to pause the execution cycle |
| catalogId | Integer | Unique user catalog ID |
| connectionId | Integer | Unique connection ID |
| databaseName | String | Database of data that the scanner will run and output |
| createTime | Date | Connection creation date and time |
| updateTime | Date | Connection modification date and time |
| lastHistoryUuid | String | Last scan UUID |
Response example
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"
}
]
}
Was this article helpful?