getScannerHistories
- Print
- PDF
getScannerHistories
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Checks the run history of a specific scanner in the user’s catalog.
Requests
Request URL
GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/scanners/{scanner-id}/histories
Request parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| catalogId | Yes | String | Unique catalog ID (ref: getCatalogs) | |
| scannerId | Yes | String | Unique scanner ID | |
| fromTimestamp | Yes | Long | Start time for history check (milliseconds timestamp) | |
| toTimestamp | Yes | Long | End time for history check (milliseconds timestamp) | |
| pageNo | No | int | Default of the page number: 1 | |
| pageSize | No | int | Maximum: 200 | Default of the result list size: 20 |
Request header
Request examples
curl -X GET "https://datacatalog.apigw.ntruss.com/api/v1/catalogs/{catalog-id}/scanners/{scanner-id}/histories?fromTimestamp=1673794800000&toTimestamp=1686841200000" \
-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}"
- fromTimestamp: 1673794800000 (January 16, 2023 12:00:00 AM)
- GMT: January 15, 2023 3:00:00 PM
- toTimestamp: 1686841200000 (June 16, 2023 12:00:00 AM)
- GMT: 6/15/2023 3:00:00 PM
Responses
Response bodies
- scannerHistoryListResponseList: list of scanner run history
| Item | Type | Description |
|---|---|---|
| scannerId | int | Unique scanner ID |
| catalogId | int | Unique user catalog ID |
| beginTime | Date | Start time of the scanner run |
| endTime | Date | End time of the scanner run |
| result | String | The result of the scanner run as success/failure |
| resultMessage | String | Message for the result of the scanner run |
| tableChanges | String | Tables added/changed according to the scanner run result, information on the partition added/changed |
| elapsedTime | int | Time taken to run a scanner |
| createTime | Date | Scanner creation time |
Response examples
HTTP
| HTTP Status | Description |
|---|---|
| 200 | OK |
JSON
{
"pageNo": 1,
"pageSize": 1,
"totalCount": 1,
"scannerHistoryListResponseList": [
{
"scannerId": 89,
"catalogId": 301,
"beginTime": "2023-05-25T10:38:49+0900",
"endTime": "2023-05-25T10:38:56+0900",
"result": "SUCCESS",
"resultMessage": "",
"tableChanges": "{\"table_added\": {\"count\": 0, \"list\": []}, \"table_updated\": {\"count\": 0, \"list\": []}, \"table_failed\": {\"count\": 0, \"list\": []}, \"partition_added\": {\"count\": 0, \"list\": []}, \"partition_updated\": {\"count\": 0, \"list\": []}, \"partition_failed\": {\"count\": 0, \"list\": []}}",
"elapsedTime": 5,
"createTime": "2023-05-25T10:38:56+0900"
}
]
}
Was this article helpful?