本文へジャンプします。

ニフクラ ユーザーガイド

NiftyUpdateAlarm

処理概要

基本監視ルールを更新します。

監視ルールを指定する場合は、監視ルール名および機能名が必要です。

対象リソース、監視ルール、通知先メールアドレスの更新が指定された場合は、既存の内容を破棄し、指定した内容で再設定されます。

指定するパラメーター

パラメーター 説明 必須
RuleName string 監視ルール名
使用可能文字: 半角英数字(1〜15文字)
RuleNameUpdate string 変更後監視ルール名
使用可能文字: 半角英数字(1〜15文字)
FunctionName string 機能名
値: Server (サーバー) | LoadBalancer (ロードバランサー) | DiskPartition (ディスクパーティション) | ElasticLoadBalancer (マルチロードバランサー)
Description string メモ
InstanceId.n string サーバー名
使用可能文字: 半角英数字(1〜15文字)
○ (FunctionName=Serverの場合 | FunctionName=DiskPartitionかつPartition.nを指定する場合)
LoadBalancerName.n string ロードバランサー名
使用可能文字: 半角英数字(1〜15文字)
○ (FunctionName=LoadBalancerの場合)
LoadBalancerPort.n integer 待ち受けポート
使用可能文字: 1〜65535の数値
○ (FunctionName=LoadBalancerの場合かつRule.m.DataType=networkPortの場合)
Partition.n string パーティション
※OS上に存在するパーティションを指定、すべてのパーティションを指定する場合 all で指定可能
使用可能文字: 半角英数字(1〜255文字)
○ (FunctionName=DiskPartitionの場合かつInstanceId.nを指定する場合)
ElasticLoadBalancerName.n string マルチロードバランサー名
使用可能文字: 半角英数字(1〜15文字)
○ (FunctionName=ElasticLoadBalancerの場合)
ElasticLoadBalancerProtocol.n string マルチロードバランサーのプロトコル
値: TCP | UDP | HTTP | HTTPS
○ (FunctionName=ElasticLoadBalancerの場合かつRule.m.DataType=networkPortの場合)
ElasticLoadBalancerPort.n integer マルチロードバランサーの待ち受けポート
使用可能文字: 1〜65535の数値
○ (FunctionName=ElasticLoadBalancerの場合かつRule.m.DataType=networkPortの場合)
Rule.m.DataType string 監視項目
値: cpu (CPU使用率[FunctionName=Server]) | memory (メモリ使用率[FunctionName=Server]) | volume (ディスク使用率[FunctionName=Server]) | ping (ping応答[FunctionName=Server]) | status (起動ステータス[FunctionName=Server]) | networkPort (ポート毎のネットワーク転送量[FunctionName=LoadBalancer,ElasticLoadBalancer]) | networkAll (全てのポート総計のネットワーク転送量[FunctionName=LoadBalancer,ElasticLoadBalancer]) | partition (パーティション使用率[FunctionName=DiskPartition])
○ (Rule.m配下を指定する場合)
Rule.m.Threshold double 閾値
単位: %
使用可能文字: 0〜100の数値
○ (Rule.m配下を指定し、かつRule.m.DataType=ping|status以外の場合)
Rule.m.UpperLowerCondition string 条件
値: upper (以上) | lower (以下)
○ (Rule.m配下を指定し、かつRule.m.DataType=ping|status以外の場合)
Rule.m.BreachDuration integer 長さ
※閾値の条件で検知してからの継続時間
単位: 分
値: 10 | 20 | 30
AlarmCondition string 監視通知の条件
値: and (すべて) | or (いずれか)
EmailAddress.l string 通知先メールアドレス
形式:メールアドレス形式

応答フィールド

フィールド (項目) 説明
NiftyUpdateAlarmResponse - NiftyUpdateAlarmレスポンス
Ancestor: なし
Children: requestId | return
requestId string リクエスト識別子
Ancestor: NiftyUpdateAlarmResponse
Children: なし
return boolean 処理ステータス
値: true(成功)
Ancestor: NiftyUpdateAlarmResponse
Children: なし

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=NiftyUpdateAlarm
  &RuleName=ruleA
  &FunctionName=Server
  &InstanceId.1=serverA
  &Rule.1.DataType=cpu
  &Rule.1.Threshold=60
  &Rule.1.UpperLowerCondition=upper
  &Rule.1.BreachDuration=10
  &AlarmCondition=and
  &EmailAddress.1=foo@example.com
  &CommonParams

  

応答サンプル

    <NiftyUpdateAlarmResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <return>true</return>
</NiftyUpdateAlarmResponse>

  

ニフクラ サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2020年11月25日時点の情報です。

推奨画面サイズ 1024×768 以上