本文へジャンプします。

ニフクラ APIリファレンス

NiftyDescribeAlarms

処理概要

指定した基本監視ルールの情報を取得します。

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

監視ルールを指定しない場合、取得できるすべての監視ルールの情報を取得します。

指定するパラメーター

パラメーター 説明 必須 サンプル値
Rule.n.RuleName 監視ルール名
Type: String
使用可能な文字:半角英数字(1〜15文字)

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

(Rule.n.RuleNameを指定する場合)
LoadBalancer

応答フィールド

フィールド(項目) 説明 サンプル値
NiftyDescribeAlarmsResponse NiftyDescribeAlarmsレスポンス
Type : NiftyDescribeAlarmsResponse
Ancestor : なし
Children : requestId, reservationSet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyDescribeAlarmsResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
reservationSet 取得した情報セット
Type : Alarm Reservation SetType
Ancestor : NiftyDescribeAlarmsResponse
Children : item
 
item 取得した情報
Type : Alarm Reservation ItemType
Ancestor : reservationSet
Children : ruleName,description,alarmState,functionName,zone,ruleSet,alarmCondition,emailAddressSet,alarmTargetsSet,createdTime
 
ruleName 監視ルール名
Type : xsd:string
Ancestor : item
Children : なし
rule777
description メモ
Type : xsd:string
Ancestor : item
Children : なし
 
alarmState 監視状態
Type : xsd:string
値: 0 (アラートなし) | 1 (アラートあり)
Ancestor : item
Children : なし
 
functionName 機能名
Type : xsd:string
値 : Server | LoadBalancer | DiskPartition | ElasticLoadBalancer
Ancestor : item
Children : なし
 
zone ゾーン名
Type : xsd:string
Ancestor : item
Children : なし
 
ruleSet 監視内容セット
Type : RuleSetType
Ancestor : item
Children : item
 
item 監視内容
Type : RuleItemType
Ancestor : ruleSet
Children : dataType,threshold,upperLowerCondition,breachDuration
 
dataType 監視項目
Type : xsd:string
Ancestor : item
Children : なし
 
threshold 閾値
Type : xsd:double
Ancestor : item
Children : なし
 
upperLowerCondition 条件
Type : xsd:string
Ancestor : item
Children : なし
 
breachDuration 長さ(分)
Type : xsd:integer
Ancestor : item
Children : なし
 
alarmCondition 監視通知の条件
Type : xsd:string
Ancestor : item
Children : なし
functionName=Server以外の場合は空
emailAddressSet 通知先メールアドレスセット
Type : EmailAddressSetType
Ancestor : item
Children : item
 
item 通知先メールアドレス情報
Type : EmailAddressItemType
Ancestor : emailAddressSet
Children : emailAddress
 
emailAddress 通知先メールアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
alarmTargetsSet 監視対象セット
Type : AlarmTargetsSetType
Ancestor : item
Children : item
 
item 監視対象情報
Type : ResourceNameItemType
Ancestor : alarmTargetsSet
Children : resourceName
 
resourceName 対象リソース名
(Server:サーバー名、LoadBalancer:LB名+":"+待受ポート、DiskPartition:サーバー名+":"+パーティション、ElasticLoadBalancer:ELB名 + ":" + プロトコル + ":" + "待受ポート")
Type : xsd:string
Ancestor : item
Children : なし
 
createdTime 監視ルール作成日時
Type : Datetime
Ancestor : item
Children : なし
 

リクエストサンプル

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

応答サンプル

<NiftyDescribeAlarmsResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <reservationSet>
    <item>
      <ruleName>ruleA</ruleName>
      <description>memo</description>
      <alarmState>0</alarmState>
      <functionName>Server</functionName>
      <zone>east-11</zone>
      <ruleSet>
        <item>
          <dataType>cpu</dataType>
          <threshold>50</threshold>
          <upperLowerCondition>upper</upperLowerCondition>
          <breachDuration>10</breachDuration>
        </item>
      </ruleSet>
      <alarmCondition>and</alarmCondition>
      <emailAddressSet>
        <item>
          <emailAddress>foo@bar.com</emailAddress>
        </item>
      </emailAddressSet>
      <alarmTagSet>
        <item>
          <resourceName>serverA</resourceName>
        </item>
      </alarmTagSet>
      <createdTime>2014-11-11T00:00:00Z</createdTime>
    </item>
  </reservationSet>
</NiftyDescribeAlarmsResponse>

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

APIメニュー

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

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