VPC環境で利用できます。
スキャナーの実行中に実行を停止します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| PUT | /api/v1/catalogs/{catalogId}/scanners/{scannerId}/stop-scanner |
リクエストヘッダ
Data Catalog APIで共通して使用されるヘッダの詳細は、Data Catalogのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
catalogId |
Integer | Required | カタログ ID
|
scannerId |
Integer | Required | スキャナー ID
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request PUT 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/scanners/9**/stop-scanner' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
scannerId |
Integer | - | スキャナー ID |
name |
String | - | スキャナー名 |
status |
String | - | スキャナーの状態
|
レスポンスステータスコード
Data Catalog APIで共通して使用されるレスポンスステータスコードの詳細は、Data Catalogのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"scannerId": 9**,
"name": "scan_mongodb",
"status": "SCANNER_STOPPING"
}