ニフクラAPI (コンピューティング: NiftyDescribeAlarms)

NiftyDescribeAlarms

処理概要

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

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

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

指定するパラメーター

パラメーター	型	説明	必須
Rule.n.RuleName	string	監視ルール名 使用可能文字: 半角英数字(1〜15文字)	○ (Rule.n.FunctionNameを指定する場合)
Rule.n.FunctionName	string	機能名 値: Server LoadBalancer DiskPartition ElasticLoadBalancer	○ (Rule.n.RuleNameを指定する場合)

応答フィールド

フィールド (項目)	型	説明
NiftyDescribeAlarmsResponse	-	NiftyDescribeAlarmsレスポンス
␣requestId	string	リクエスト識別子
␣reservationSet	-	取得した情報セット
␣␣item	-	取得した情報
␣␣␣ruleName	string	監視ルール名
␣␣␣description	string	メモ
␣␣␣alarmState	string	監視状態 備考: 返却値 0(アラートなし),1(アラートあり)
␣␣␣functionName	string	機能名 値: Server LoadBalancer DiskPartition ElasticLoadBalancer
␣␣␣zone	string	ゾーン名
␣␣␣ruleSet	-	監視内容セット
␣␣␣␣item	-	監視内容
␣␣␣␣␣dataType	string	監視項目
␣␣␣␣␣threshold	double	閾値
␣␣␣␣␣upperLowerCondition	string	条件
␣␣␣␣␣breachDuration	integer	長さ（分）
␣␣␣␣␣addDatetime	timestamp	監視ルールに追加した日時
␣␣␣alarmCondition	string	監視通知の条件
␣␣␣emailAddressSet	-	通知先メールアドレスセット
␣␣␣␣item	-	通知先メールアドレス情報
␣␣␣␣␣emailAddress	string	通知先メールアドレス
␣␣␣alarmTargetsSet	-	監視対象セット
␣␣␣␣item	-	監視対象情報
␣␣␣␣␣resourceName	string	対象リソース名 (Server：サーバー名、LoadBalancer：LB名＋":"＋待受ポート、DiskPartition：サーバー名＋":"＋パーティション、ElasticLoadBalancer:ELB名 + ":" + プロトコル + ":" + "待受ポート")
␣␣␣createdTime	timestamp	監視ルール作成日時

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=NiftyDescribeAlarms
  &Rule.1.Name=ruleA
  &Rule.1.FunctionName=Server
  &CommonParams

  

応答サンプル

    <NiftyDescribeAlarmsResponse xmlns="https://computing.api.nifcloud.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>
          <addDatetime>2014-11-11T00:00:00Z</addDatetime>
        </item>
      </ruleSet>
      <alarmCondition>and</alarmCondition>
      <emailAddressSet>
        <item>
          <emailAddress>foo@example.com</emailAddress>
        </item>
      </emailAddressSet>
      <alarmTargetsSet>
        <item>
          <resourceName>serverA</resourceName>
        </item>
      </alarmTargetsSet>
      <createdTime>2014-11-11T00:00:00Z</createdTime>
    </item>
  </reservationSet>
</NiftyDescribeAlarmsResponse>