Change monitoring status

Prev Next

Available in Classic and VPC

Change the status of a monitoring service.

Request

This section describes the request format. The method and URI are as follows:

Method URI
PUT /api/v1/scenarios/{scenarioId}/settings

Request headers

For information about the headers common to all Web service Monitoring System APIs, see Web service Monitoring System request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
scenarioId Integer Required Scenario ID

Request body

You can include the following data in the body of your request:

Field Type Required Description
serviceYn Boolean Required Monitoring status
  • true | false
    • true: started
    • false: suspended

Request example

The request example is as follows:

curl --location --request PUT 'https://wms.apigw.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
}'

Response

This section describes the response format.

Response status codes

For information about the HTTP status codes common to all Web service Monitoring System APIs, see Web service Monitoring System response status codes.

Response example

On a successful response, it changes to the requested monitoring service status with 200 OK.