本文へジャンプします。

ニフクラ APIリファレンス

NiftyUpdateAlarm

処理概要

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

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

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

指定するパラメーター

パラメーター 説明 必須 サンプル値
RuleName 監視ルール名
Type: String
使用可能な文字:半角英数字(1〜15文字)
rule888
RuleNameUpdate 変更後監視ルール名
Type: String
使用可能な文字:半角英数字(1〜15文字)
  updaterule
  • ※監視ルール名を変更する場合に指定する
FunctionName 機能名
Type: String
値:Server | LoadBalancer | DiskPartition | ElasticLoadBalancer
 
Description メモ
Type: String
   
InstanceId.n サーバー名
Type: String
使用可能な文字:半角英数字(1〜15文字)

(FunctionName=DiskPartitionの場合かつPartition.nを指定する場合)
 
LoadBalancerName.n ロードバランサー名
Type: String
使用可能な文字:半角英数字(1〜15文字)

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

○(FunctionName=LoadBalancerの場合かつRule.m.DataType=networkPortの場合)
 
Partition.n パーティション
Type: String
使用可能な文字:半角英数字(1〜255文字)
  • ※all(すべてのパーティション)指定可能と追記
○(FunctionName=DiskPartitionの場合かつInstanceId.nを指定する場合)  
ElasticLoadBalancerName.n マルチロードバランサー名
Type: String
使用可能な文字:半角英数字(1〜15文字)
○(FunctionName=ElasticLoadBalancerの場合)  
ElasticLoadBalancerProtocol.n マルチロードバランサーのプロトコル
Type: String
値:TCP | UDP | HTTP | HTTPS
○(FunctionName=ElasticLoadBalancerの場合かつRule.m.DataType= networkPortnetworkの場合)  
ElasticLoadBalancerPort.n マルチロードバランサーの待ち受けポート
Type: Integer
値:0〜65535の数値
○(FunctionName=ElasticLoadBalancerの場合かつRule.m.DataType= networkPortの場合)  
Rule.m.DataType 監視項目
Type: String
Function=Serverの場合:(ping | status | cpu | memory | volume)
Function=LoadBalancerの場合:(networkAll | networkPort)
Function=DiskPartitionの場合:(partition)
Function=ElasticLoadBalancerの場合:(networkAll | networkPort)

(Rule.m配下を指定する場合)
 
Rule.m.Threshold 閾値
Type: Double
値:0〜100の数値
単位:%

(Rule.m配下を指定し、かつRule.m.DataType=ping | status以外の場合)
 
Rule.m.UpperLowerCondition 条件
Type: String
値:upper(以上) | lower(以下)

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

応答フィールド

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

リクエストサンプル

https://cp.cloud.nifty.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@bar.com&CommonParams

応答サンプル

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

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

APIメニュー

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

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