モニタリングの状態変更

Prev Next

Classic/VPC環境で利用できます。

モニタリングサービスの状態を変更します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
PUT /api/v1/scenarios/{scenarioId}/settings

リクエストヘッダ

Web service Monitoring System APIで共通して使用されるヘッダの詳細は、Web service Monitoring Systemのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
scenarioId Integer Required シナリオ ID

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
serviceYn Boolean Required モニタリングの状態
  • true | false
    • true: 開始
    • false: 一時停止

リクエスト例

リクエストのサンプルコードは次の通りです。

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
}'

レスポンス

レスポンス形式を説明します。

レスポンスステータスコード

Web service Monitoring System APIで共通して使用されるレスポンスステータスコードの詳細は、Web service Monitoring Systemのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンス成功時、200 OKと表示され、リクエストしたモニタリングサービス状態に変更されます。