本文へジャンプします。

ニフクラ ユーザーガイド

NiftyDescribeAlarms

処理概要

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

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

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

指定するパラメーター

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

応答フィールド

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

リクエストサンプル

    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>

  

ニフクラ サイト内検索

APIメニュー

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

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