本文へジャンプします。

ニフクラ ユーザーガイド

NiftyCreateAlarm

処理概要

基本監視ルールを新規作成します。

FunctionNameに機能名を指定することでサーバー、ロードバランサー、ディスクパーティション、マルチロードバランサーに対して監視するルールを作成されます。ロードバランサー以外の監視ルールはゾーン毎の作成になります。作成されたルールの設定からアラートが上がった場合、EmailAddressのメールアドレスにアラートメールが送信されます。

指定するパラメーター

パラメーター 説明 必須
RuleName string 監視ルール名
FunctionName string 機能名
値: Server (サーバー) | LoadBalancer (ロードバランサー) | DiskPartition (ディスクパーティション) | ElasticLoadBalancer (マルチロードバランサー)
Description string メモ
使用可能文字: 半角英数字(500文字以内)
Zone string ゾーン情報(ゾーン名)
○ (FunctionName=Server|DiskPartition|ElasticLoadBalancerの場合)
InstanceId.n string サーバー名
使用可能文字: 半角英数字(1〜15文字)
○ (FunctionName=Server|DiskPartitionの場合)
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文字)
※all(すべてのパーティション)指定可能
○ (FunctionName=DiskPartitionの場合)
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.Threshold double 閾値
※少数点以下の指定は切り捨てて設定
単位: %
使用可能文字: 0〜100の数値
○ (Rule.m.DataType=ping|status以外の場合)
Rule.m.UpperLowerCondition string 条件
値: upper (以上) | lower (以下)
○ (Rule.m.DataType=ping|status以外の場合)
Rule.m.BreachDuration integer 長さ
単位: 分
値: 10 | 20 | 30
AlarmCondition string 監視通知の条件
値: and (すべて) | or (いずれか)
○ (FunctionName=Serverの場合)
EmailAddress.l string 通知先メールアドレス
形式:メールアドレス形式

応答フィールド

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

リクエストサンプル

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

  

応答サンプル

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

  

ニフクラ サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ

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