stopScanner

Prev Next

VPC 환경에서 이용 가능합니다.

스캐너 실행 중에 실행을 중지합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
PUT /api/v1/catalogs/{catalogId}/scanners/{scannerId}/stop-scanner

요청 헤더

Data Catalog API에서 공통으로 사용하는 헤더에 대한 정보는 Data Catalog 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
catalogId Integer Required 카탈로그 아이디
scannerId Integer Required 스캐너 아이디

요청 예시

요청 예시는 다음과 같습니다.

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 - 스캐너 아이디
name String - 스캐너 이름
status String - 스캐너 상태
  • SCANNER_STOPPING: 실행 중지 (유효 값)

응답 상태 코드

Data Catalog API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Data Catalog 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "scannerId": 9**,
    "name": "scan_mongodb",
    "status": "SCANNER_STOPPING"
}