本文へジャンプします。

ニフクラ APIリファレンス

NiftyDescribeAlarmHistory

処理概要

アラート履歴一覧を取得します。
リージョン/ゾーン/セルに利用制限がかかっている監視ルールのアラーム履歴は返却されません。

指定するパラメーター

パラメーター 説明 必須 サンプル値
Rule.n.RuleName 監視ルール名
Type: String

(Rule.n.FunctionNameを指定する場合)
 
Rule.n.FunctionName 機能名
Type: String
値:Server | LoadBalancer | DiskPartition | ElasticLoadBalancer

(Rule.n.RuleNameを指定する場合)
 
Rule.n.FromDate 履歴取得開始日付
Type: String
   
Rule.n.ToDate 履歴取得終了日付
Type: String
   

応答フィールド

フィールド(項目) 説明 サンプル値
NiftyDescribeAlarmHistoryResponse NiftyDescribeAlarmHistoryレスポンス
Type : NiftyDescribeAlarmHistoryResponseType
Ancestor : なし
Children : requestId, reservationSet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyDescribeAlarmHistoryResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
reservationSet 取得した情報セット
Type :AlarmReservationSetType
Ancestor :NiftyDescribeAlarmHistoryResponse
Children :item
Ancestor : NiftyDescribeAlarmHistoryResponse
Children : item
 
item 取得した情報
Type :AlarmReservationSetType
Ancestor :reservationSet
Children :ruleName,functionName,alarmDateHistorySet
 
ruleName 監視ルール名
Type : xsd:string
Ancestor : item
Children : なし
 
functionName 機能名
Type : xsd:string
値:Server | LoadBalancer | DiskPartition | ElasticLoadBalancer
Ancestor :item
Children :なし
 
alarmDateHistorySet アラーム日時セット
Type :AlarmDateHistorySetType
Ancestor :item
Children : item
 
item アラーム日時情報
Type :AlarmDateHistoryItemType
Ancestor :alarmDateHistorySet
Children :date,alarmEventHistorySet
 
data アラーム日付
Type : xsd:string
Ancestor :item
Children :なし
 
alarmEventHistorySet アラームイベント情報セット
Type :AlarmEventHistorySetType
Ancestor :item
Children :item
 
item アラームイベント情報
Type :AlarmEventHistoryItemType
Ancestor :alarmEventHistorySet
Children :alarmEventDatetime,alarmEvent
 
dalarmEventDatetime アラームイベント発生日時
Type : xsd:dateTime
Ancestor :item
Children :なし
 
alarmEvent アラームイベント
Type : xsd:string
値:0(アラーム解除)| 1(アラーム発行)
Ancestor :item
Children :なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=NiftyDescribeAlarmHistory&Rule.1.Name=ruleA&Rule.1.FunctionName=Server

応答サンプル

<NiftyDescribeAlarmHistoryResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <reservationSet>
    <item>
      <ruleName>ruleA</ruleName>
      <functionName>Server</functionName>
      <alarmDateHistorySet>
        <item>
          <date>20141111</date>
            <alarmEventHistorySet>
            <item>
             <alarmEventDatetime>2014-11-11T00:00:00Z</alarmEventDatetime>
             <alarmEvent>1</alarmEvent>
            </item>
            </alarmEventHistorySet>
        </item>
      </alarmDateHistorySet>
    </item>
  </reservationSet>
</NiftyDescribeAlarmHistoryResponse>

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

APIメニュー

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

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