모니터링 상태 변경

Prev Next

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

모니터링 서비스의 상태를 변경합니다.

요청

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

메서드 URI
PUT /api/v1/scenarios/{scenarioId}/settings

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
scenarioId Integer Required 시나리오 아이디

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
serviceYn Boolean Required 모니터링 상태
  • true | false
    • true: 시작
    • false: 일시 정지

요청 예시

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

curl --location --request PUT 'https://wms.apigw.gov-ntruss.com/api/v1/scenarios/{scenarioId}/settings' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
	"serviceYn": true
}'

응답

응답 형식을 설명합니다.

응답 상태 코드

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

응답 예시

응답 성공 시 200 OK와 함께 요청한 모니터링 서비스 상태로 변경됩니다.