本文へジャンプします。

ニフクラ APIリファレンス

NiftyCreateAlarm

処理概要

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

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

指定するパラメーター

パラメーター 説明 必須 サンプル値
RuleName 監視ルール名
Type: String
使用可能な文字:半角英数字(1〜15文字)
rule123
FunctionName 機能名
Type: String
値:Server | LoadBalancer | DiskPartition | ElasticLoadBalancer
DiskPartition
Description メモ
Type: String
使用可能な文字:半角英数字(500文字以内)
   
Zone ゾーン情報(ゾーン名)
Type: String

(FunctionName=Server | DiskPartitionの場合)
 
InstanceId.n サーバー名
Type: String
使用可能な文字:半角英数字(1〜15文字)

(FunctionName=Server | DiskPartitionの場合)
server001
LoadBalancerName.n ロードバランサー名
Type: String
使用可能な文字:半角英数字(1〜15文字)

(FunctionName=LoadBalancerの場合)
lb001
LoadBalancerPort.n 待ち受けポート
Type: Integer
値:0〜65535の数値

(FunctionName=LoadBalancerの場合かつRule.m.DataType=networkPortの場合)
80
Partition.n パーティション
Type: String
使用可能な文字:半角英数字(1〜255文字)
※all(すべてのパーティション)指定可能

(FunctionName=DiskPartitionの場合)
/boot
ElasticLoadBalancerName.n マルチロードバランサー名
Type: String
使用可能な文字:半角英数字(1〜15文字)

(FunctionName=ElasticLoadBalancerの場合)
/boot
ElasticLoadBalancerProtocol.n マルチロードバランサーのプロトコル
Type: String
値:TCP | UDP | HTTP | HTTPS

(FunctionName=ElasticLoadBalancerの場合かつRule.m.DataType=networkPortの場合)
/boot
ElasticLoadBalancerPort.n マルチロードバランサーの待ち受けポート
Type: Integer
値:0〜65535の数値

(FunctionName=ElasticLoadBalancerの場合かつRule.m.DataType= networkPortの場合)
/boot
Rule.m.DataType 監視項目
Type: String
Function=Serverの場合:(ping | status | cpu | memory | volume)
Function=LoadBalancerの場合:(networkAll | networkPort)
Function=DiskPartitionの場合:(partition)
Function= ElasticLoadBalancerの場合:(networkAll | networkPort)
partition
Rule.m.Threshold 閾値
Type: Double
値:0〜100の数値
単位:%

(Rule.m.DataType=ping | status以外の場合)
77
Rule.m.UpperLowerCondition 条件
Type: String
値:upper(以上) | lower(以下)

(Rule.m.DataType=ping | status以外の場合)
upper
Rule.m.BreachDuration 長さ
単位: 分
Type: Integer
値:0〜30の数値
30
AlarmCondition 監視通知の条件
Type: String
値:and(すべて) | or(いずれか)
○(FunctionName=Serverの場合) or
EmailAddress.l 通知先メールアドレス
Type: String
形式:メールアドレス形式
 

応答フィールド

フィールド(項目) 説明 サンプル値
NiftyCreateAlarmResponse NiftyCreateAlarmレスポンス
Type : NiftyCreateAlarmResponseType
Ancestor : なし
Children : requestId, return
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyCreateAlarmResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
return 処理ステータス
Type : xsd:boolean
Ancestor : NiftyCreateAlarmResponse
Children : なし
 

リクエストサンプル

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

応答サンプル

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

ニフティクラウド サイト内検索

APIメニュー

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

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