stopScanner
- Print
- PDF
stopScanner
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Stops a running scanner in the user’s catalog.
Requests
Request URL
PUT {DATA_CATALOG API_URL}/catalogs/{catalog-id}/scanners/{scanner-id}/stop-scanner
Request parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| catalogId | Yes | String | Unique catalog ID (ref: getCatalogs) | |
| scannerId | Yes | String | Unique scanner ID |
Request header
Request examples
curl -X PUT "https://datacatalog.apigw.ntruss.com/api/v1/catalogs/{catalog-id}/scanners/{scanner-id}/stop-scanner" \
-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}"
Responses
Response bodies
| Item | Type | Description |
|---|---|---|
| scannerId | int | Unique scanner ID |
| name | String | Scanner name |
| status | String | Scanner status (pending for run/run start/running/run end) |
Response examples
HTTP
| HTTP Status | Description |
|---|---|
| 200 | OK |
JSON
{
"scannerId": 89,
"name": "datacatalog-test-scanner",
"status": "SCANNER_STOPPING",
}
Was this article helpful?