alarms (アラーム) リソースの使用

内容
casp1032jp
内容
アラーム リソースを使用して、
CA Spectrum
アラームを読み取り、変更、および削除します。非同期の応答がサポートされています。
  • ベース URL
    http://<hostname><:portnumber>/spectrum/restful/alarms
POST alarms (GET トンネリング)
POST alarms (GET トンネリング)を使用して、すべてのアラーム ID を取得します。POST alarms 要求では、取得されるアラームを指定する XML ドキュメントを提供できます。ドキュメントでは、特定のアラームを ID またはモデル仕様で指定できます。モデル仕様は、モデル ハンドル、XML 検索条件、または OneClick サーバ上の既存の検索条件への参照のリストとすることができます。これは、特定のアラーム属性フィルタを満たす GET alarms に対しても可能です。属性フィルタは、検索条件のサブセットです。
重要:
この POST は GET トンネリングの一種です。POST alarms でアラームを作成することはできません。
CA Spectrum
 アラームは、イベント処置ファイルで定義されているイベントに対する応答で作成されます。
  • URL
    http://<hostname><:portnumber>/spectrum/restful/alarms[?symptoms=no][?symptoms=yes]
  • HTTP メソッド
    POST
  • ボディ
    例は、<
    $SPECROOT
    >/RestfulExamples/xml/Alarms で提供されます。これらの XML ファイルでは、さまざまな目的のための適切に形成された XML の例を提供します。これらの例を基にして独自の XML を作成します。
    • GetAlarmsByModelHandles.xml
    • GetAlarmsBySearchCriteria.xml
    • GetAlarmsForAllDevices.xml
    • GetAlarmsByAlarmIDs.xml
    • GetAlarmsByAttributeFilter.xml
      以下の例は、アラーム id と、モデル タイプ、アラーム対象モデルのモデル タイプ、セキュリティ文字列、状態、モデル名、モデル クラスのような関連する詳細を取得するための単純な xml 条件です。
      <?xml version="1.0" encoding="UTF-8"?>
      <rs:alarm-request throttlesize="0"
      xmlns:rs="http://www.ca.com/spectrum/restful/schema/request"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.ca.com/spectrum/restful/schema/request ../../../xsd/Request.xsd ">
      <rs:requested-attribute id="0x10000"/> <!--Model Type Name-->
      <rs:requested-attribute id="0x10001"/> <!--Model Type of Alarmed Model-->
      <rs:requested-attribute id="0x10009"/> <!--Security String-->
      <rs:requested-attribute id="0x1000a"/> <!--Condition-->
      <rs:requested-attribute id="0x1006e"/> <!--Model Name-->
      <rs:requested-attribute id="0x11ee8"/> <!--Model Class–>
      <rs:landscape id="0x100000"/>
      </rs:alarm-request>
       
      <!--If you include landscape attribute(s) in the xml criteria, alarms of all the landscapes that are included are retrieved.-->
  • ボディ コンテンツ
    application/xml
  • ヘッダ
    application/xml、application/json
  • 出力
    SpectroSERVER
     または分散
    SpectroSERVER
     のすべてのアラームを記載する XML または JSON
    次に示すのはコールの例です。
 
Java GenericPoster noun=Alarms file=resources/xml/Alarms/GetAlarmsBySearch.xml server=localhost username=jdoe password=spectrum port=8080
 
URL パラメータ
  • <?symptoms=no>
    このパラメータを使用して、兆候アラーム ID を除くすべてのアラーム ID を取得します。
    例の xml のボディに基づき、以下の出力が「http://<hostname><:portnumber>/spectrum/restful/alarms?symptoms=no」に返されます。
    <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
    <alarm-response-list error="EndOfResults" throttle="18" total-alarms="18">
    <alarm-responses>
    <alarm id="55d30306-7d7b-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">WA_Link</attribute>
    <attribute id="0x10001">0x102e2</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">3</attribute>
    <attribute id="0x1006e">10.10.10.0</attribute>
    <attribute id="0x11ee8">7</attribute>
    </alarm>
    <alarm id="55d2d38b-47a6-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">JuniperJUNOSRtr</attribute>
    <attribute id="0x10001">0x3b10002</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">2</attribute>
    <attribute id="0x1006e">jun2300-96.4</attribute>
    <attribute id="0x11ee8">3</attribute>
    </alarm>
    <alarm id="55d40fa8-108f-1000-0228-6c8814e75b4c">
    <attribute id="0x10000">LancomLCOS</attribute>
    <attribute id="0x10001">0x5930001</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">2</attribute>
    <attribute id="0x1006e">Lancom1751test</attribute>
    <attribute id="0x11ee8">4</attribute>
    </alarm>
    <alarm id="55d2fe98-6c6d-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">Rtr_Cisco</attribute>
    <attribute id="0x10001">0x21000c</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">3</attribute>
    <attribute id="0x1006e">cis2524-96.45.ca.com</attribute>
    <attribute id="0x11ee8">4</attribute>
    </alarm>
    <alarm id="55d301da-6dc0-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">Rtr_Cisco</attribute>
    <attribute id="0x10001">0x21000c</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">3</attribute>
    <attribute id="0x1006e">cis7204-96.5.ca.com</attribute>
    <attribute id="0x11ee8">4</attribute>
    </alarm>
    <alarm id="55d40f0b-057d-1000-0228-6c8814e75b4c">
    <attribute id="0x10000">ConfigurationManager</attribute>
    <attribute id="0x10001">0x820005</attribute>
    <attribute id="0x10009">ADMIN</attribute>
    <attribute id="0x1000a">3</attribute>
    <attribute id="0x1006e">Configuration Manager</attribute>
    <attribute id="0x11ee8">17</attribute>
    </alarm>
    <alarm id="55d2d399-47af-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">Host_Device</attribute>
    <attribute id="0x10001">0x1160089</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">2</attribute>
    <attribute id="0x1006e">mcastsrc2.ca.com</attribute>
    <attribute id="0x11ee8">9</attribute>
    </alarm>
    <alarm id="55d2ee8f-52b5-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">WA_Link</attribute>
    <attribute id="0x10001">0x102e2</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">3</attribute>
    <attribute id="0x1006e">10.253.248.0</attribute>
    <attribute id="0x11ee8">7</attribute>
    </alarm>
    <alarm id="55d40efb-0018-1000-0228-6c8814e75b4c">
    <attribute id="0x10000">IPRoutingManager</attribute>
    <attribute id="0x10001">0x5640000</attribute>
    <attribute id="0x10009">ADMIN</attribute>
    <attribute id="0x1000a">3</attribute>
    <attribute id="0x1006e">IP Routing Manager</attribute>
    <attribute id="0x11ee8">118</attribute>
    </alarm>
    <alarm id="55d2d399-47ac-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">Host_Device</attribute>
    <attribute id="0x10001">0x1160089</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">2</attribute>
    <attribute id="0x1006e">mcastsrc4.ca.com</attribute>
    <attribute id="0x11ee8">9</attribute>
    </alarm>
    <alarm id="55d2d39b-47b2-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">Host_Device</attribute>
    <attribute id="0x10001">0x1160089</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">2</attribute>
    <attribute id="0x1006e">mcastsrc6.ca.com</attribute>
    <attribute id="0x11ee8">9</attribute>
    </alarm>
    <alarm id="55d2d39c-47b5-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">Host_Device</attribute>
    <attribute id="0x10001">0x1160089</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">2</attribute>
    <attribute id="0x1006e">mcastsrc1.ca.com</attribute>
    <attribute id="0x11ee8">9</attribute>
    </alarm>
    <alarm id="55d2fd88-6b4f-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">WA_Link</attribute>
    <attribute id="0x10001">0x102e2</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">3</attribute>
    <attribute id="0x1006e">192.168.100.8</attribute>
    <attribute id="0x11ee8">7</attribute>
    </alarm>
    <alarm id="55d2d28b-46c7-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">HubCat5000</attribute>
    <attribute id="0x10001">0x11c0009</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">2</attribute>
    <attribute id="0x1006e">name</attribute>
    <attribute id="0x11ee8">2</attribute>
    </alarm>
    <alarm id="55d2fd41-6b0f-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">Rtr_Cisco</attribute>
    <attribute id="0x10001">0x21000c</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">2</attribute>
    <attribute id="0x1006e">cisco2511-96.16.ca.com</attribute>
    <attribute id="0x11ee8">4</attribute>
    </alarm>
    <alarm id="55d33aed-8f1b-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">Rtr_Cisco</attribute>
    <attribute id="0x10001">0x21000c</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">2</attribute>
    <attribute id="0x1006e">cis7606-96.36.36.ca.com</attribute>
    <attribute id="0x11ee8">4</attribute>
    </alarm>
    <alarm id="55d2d713-489d-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">Rtr_Cisco</attribute>
    <attribute id="0x10001">0x21000c</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">2</attribute>
    <attribute id="0x1006e">cis2524-blue-96.28.ca.com</attribute>
    <attribute id="0x11ee8">4</attribute>
    </alarm>
    <alarm id="55d2f5e0-685c-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">GnSNMPDev</attribute>
    <attribute id="0x10001">0x3d0002</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">1</attribute>
    <attribute id="0x1006e">quanta-1</attribute>
    <attribute id="0x11ee8">3</attribute>
    </alarm>
    </alarm-responses>
    </alarm-response-list>
  • <?symptoms=yes>
    このパラメータを使用して、兆候アラーム ID を含むすべてのアラーム ID を取得します。
    例の xml のボディに基づき、以下の出力が「http://<hostname><:portnumber>/spectrum/restful/alarms?symptoms=yes」に返されます。
     
    <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
    <alarm-response-list error="EndOfResults" throttle="20" total-alarms="20">
    <alarm-responses>
    <alarm id="55d30306-7d7b-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">WA_Link</attribute>
    <attribute id="0x10001">0x102e2</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">3</attribute>
    <attribute id="0x1006e">10.10.10.0</attribute>
    <attribute id="0x11ee8">7</attribute>
    </alarm>
    <alarm id="55d2d38b-47a6-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">JuniperJUNOSRtr</attribute>
    <attribute id="0x10001">0x3b10002</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">2</attribute>
    <attribute id="0x1006e">jun2300-96.4</attribute>
    <attribute id="0x11ee8">3</attribute>
    </alarm>
    <alarm id="55d301da-6dc2-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">Rtr_Cisco</attribute>
    <attribute id="0x10001">0x21000c</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">3</attribute>
    <attribute id="0x1006e">cis7204-96.5.ca.com</attribute>
    <attribute id="0x11ee8">4</attribute>
    </alarm>
    <alarm id="55d40fa8-108f-1000-0228-6c8814e75b4c">
    <attribute id="0x10000">LancomLCOS</attribute>
    <attribute id="0x10001">0x5930001</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">2</attribute>
    <attribute id="0x1006e">Lancom1751test</attribute>
    <attribute id="0x11ee8">4</attribute>
    </alarm>
    <alarm id="55d2fe98-6c6d-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">Rtr_Cisco</attribute>
    <attribute id="0x10001">0x21000c</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">3</attribute>
    <attribute id="0x1006e">cis2524-96.45.ca.com</attribute>
    <attribute id="0x11ee8">4</attribute>
    </alarm>
    <alarm id="55d301da-6dc0-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">Rtr_Cisco</attribute>
    <attribute id="0x10001">0x21000c</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">3</attribute>
    <attribute id="0x1006e">cis7204-96.5.ca.com</attribute>
    <attribute id="0x11ee8">4</attribute>
    </alarm>
    <alarm id="55d40f0b-057d-1000-0228-6c8814e75b4c">
    <attribute id="0x10000">ConfigurationManager</attribute>
    <attribute id="0x10001">0x820005</attribute>
    <attribute id="0x10009">ADMIN</attribute>
    <attribute id="0x1000a">3</attribute>
    <attribute id="0x1006e">Configuration Manager</attribute>
    <attribute id="0x11ee8">17</attribute>
    </alarm>
    <alarm id="55d2d399-47af-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">Host_Device</attribute>
    <attribute id="0x10001">0x1160089</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">2</attribute>
    <attribute id="0x1006e">mcastsrc2.ca.com</attribute>
    <attribute id="0x11ee8">9</attribute>
    </alarm>
    <alarm id="55d2ee8f-52b5-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">WA_Link</attribute>
    <attribute id="0x10001">0x102e2</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">3</attribute>
    <attribute id="0x1006e">10.253.248.0</attribute>
    <attribute id="0x11ee8">7</attribute>
    </alarm>
    <alarm id="55d40efb-0018-1000-0228-6c8814e75b4c">
    <attribute id="0x10000">IPRoutingManager</attribute>
    <attribute id="0x10001">0x5640000</attribute>
    <attribute id="0x10009">ADMIN</attribute>
    <attribute id="0x1000a">3</attribute>
    <attribute id="0x1006e">IP Routing Manager</attribute>
    <attribute id="0x11ee8">118</attribute>
    </alarm>
    <alarm id="55d2d399-47ac-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">Host_Device</attribute>
    <attribute id="0x10001">0x1160089</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">2</attribute>
    <attribute id="0x1006e">mcastsrc4.ca.com</attribute>
    <attribute id="0x11ee8">9</attribute>
    </alarm>
    <alarm id="55d2d39b-47b2-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">Host_Device</attribute>
    <attribute id="0x10001">0x1160089</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">2</attribute>
    <attribute id="0x1006e">mcastsrc6.ca.com</attribute>
    <attribute id="0x11ee8">9</attribute>
    </alarm>
    <alarm id="55d2d39c-47b5-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">Host_Device</attribute>
    <attribute id="0x10001">0x1160089</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">2</attribute>
    <attribute id="0x1006e">mcastsrc1.ca.com</attribute>
    <attribute id="0x11ee8">9</attribute>
    </alarm>
    <alarm id="55d2fd88-6b4f-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">WA_Link</attribute>
    <attribute id="0x10001">0x102e2</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">3</attribute>
    <attribute id="0x1006e">192.168.100.8</attribute>
    <attribute id="0x11ee8">7</attribute>
    </alarm>
    <alarm id="55d2d28b-46c7-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">HubCat5000</attribute>
    <attribute id="0x10001">0x11c0009</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">2</attribute>
    <attribute id="0x1006e">name</attribute>
    <attribute id="0x11ee8">2</attribute>
    </alarm>
    <alarm id="55d2fd41-6b0f-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">Rtr_Cisco</attribute>
    <attribute id="0x10001">0x21000c</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">2</attribute>
    <attribute id="0x1006e">cisco2511-96.16.ca.com</attribute>
    <attribute id="0x11ee8">4</attribute>
    </alarm>
    <alarm id="55d301da-6db7-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">Rtr_Cisco</attribute>
    <attribute id="0x10001">0x21000c</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">3</attribute>
    <attribute id="0x1006e">cis7204-96.5.ca.com</attribute>
    <attribute id="0x11ee8">4</attribute>
    </alarm>
    <alarm id="55d33aed-8f1b-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">Rtr_Cisco</attribute>
    <attribute id="0x10001">0x21000c</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">2</attribute>
    <attribute id="0x1006e">cis7606-96.36.36.ca.com</attribute>
    <attribute id="0x11ee8">4</attribute>
    </alarm>
    <alarm id="55d2d713-489d-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">Rtr_Cisco</attribute>
    <attribute id="0x10001">0x21000c</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">2</attribute>
    <attribute id="0x1006e">cis2524-blue-96.28.ca.com</attribute>
    <attribute id="0x11ee8">4</attribute>
    </alarm>
    <alarm id="55d2f5e0-685c-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">GnSNMPDev</attribute>
    <attribute id="0x10001">0x3d0002</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">1</attribute>
    <attribute id="0x1006e">quanta-1</attribute>
    <attribute id="0x11ee8">3</attribute>
    </alarm>
    </alarm-responses>
    </alarm-response-list>
GET alarms
GET alarms はアラーム ID を返します。&attr=<
attr_id
> パラメータを使用して、特定のアラーム属性を取得することができます。
  • URL
    http://<hostname><:portnumber>/spectrum/restful/alarms[?attr=<attr_ID>][&landscape=<landscape_handle>][&throttlesize=<num>][?lasthour=<num>]
  • HTTP メソッド
    GET
  • ボディ
    なし
  • ボディ コンテンツ
    使用されません
  • ヘッダ
    application/xml、application/json
  • 出力
    SpectroSERVER
     または分散
    SpectroSERVER
     のアラームを記載する XML または JSON
    以下は、アラーム ID のみを取得する環境での例です。
    <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
    <alarm-response-list error="EndOfResults" throttle="20" total-alarms="20">
    <alarm-responses>
    <alarm id="55d30306-7d7b-1000-02a9-6c8814e75b4c" />
    <alarm id="55d2d38b-47a6-1000-02a9-6c8814e75b4c" />
    <alarm id="55d301da-6dc2-1000-02a9-6c8814e75b4c" />
    <alarm id="55d40fa8-108f-1000-0228-6c8814e75b4c" />
    <alarm id="55d2fe98-6c6d-1000-02a9-6c8814e75b4c" />
    <alarm id="55d301da-6dc0-1000-02a9-6c8814e75b4c" />
    <alarm id="55d40f0b-057d-1000-0228-6c8814e75b4c" />
    <alarm id="55d2d399-47af-1000-02a9-6c8814e75b4c" />
    <alarm id="55d2ee8f-52b5-1000-02a9-6c8814e75b4c" />
    <alarm id="55d40efb-0018-1000-0228-6c8814e75b4c" />
    <alarm id="55d2d399-47ac-1000-02a9-6c8814e75b4c" />
    <alarm id="55d2d39b-47b2-1000-02a9-6c8814e75b4c" />
    <alarm id="55d2d39c-47b5-1000-02a9-6c8814e75b4c" />
    <alarm id="55d2fd88-6b4f-1000-02a9-6c8814e75b4c" />
    <alarm id="55d2d28b-46c7-1000-02a9-6c8814e75b4c" />
    <alarm id="55d2fd41-6b0f-1000-02a9-6c8814e75b4c" />
    <alarm id="55d301da-6db7-1000-02a9-6c8814e75b4c" />
    <alarm id="55d33aed-8f1b-1000-02a9-6c8814e75b4c" />
    <alarm id="55d2d713-489d-1000-02a9-6c8814e75b4c" />
    <alarm id="55d2f5e0-685c-1000-02a9-6c8814e75b4c" />
    </alarm-responses>
    </alarm-response-list>
    This is an example based on our environment.
URL パラメータ
  • &attr=<
    attr_ID
    >
    (オプション)要求する属性を指定します。複数の属性パラメータを指定できます。
    注:
     モデルには多くの属性があります。最高のパフォーマンスのためには、属性の選択を目的の属性に制限する必要があります。
  • &landscape=<
    landscape_handle
    >
    (オプション)照会するランドスケープをフィルタします。複数のランドスケープ パラメータを指定できます。
  • &throttlesize=<
    num
    >
    (オプション)スロットル サイズを指定します。
  • ?lasthour=
    <num>
    (オプション)このパラメータを使用して、過去 <
    num
    > 時間(<
    num
    > 時間)に生成されたアラーム ID を取得します。たとえば、過去 2 時間に生成されたアラームの ID を取得するには、以下の URL を使用します。
    http://<hostname><portnumber>/spectrum/restful/alarms?lasthour=2
    The following output is generated:
    <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
    <alarm-response-list error="EndOfResults" throttle="6" total-alarms="6">
    <alarm-responses>
    <alarm id="55d30306-7d7b-1000-02a9-6c8814e75b4c" />
    <alarm id="55d2d38b-47a6-1000-02a9-6c8814e75b4c" />
    <alarm id="55d301da-6dc2-1000-02a9-6c8814e75b4c" />
    <alarm id="55d2fe98-6c6d-1000-02a9-6c8814e75b4c" />
    <alarm id="55d301da-6dc0-1000-02a9-6c8814e75b4c" />
    <alarm id="55d2d399-47af-1000-02a9-6c8814e75b4c" />
    </alarm-responses>
    </alarm-response-list>
    This is an example based on our environment.
GET アラーム フィルタ
GET アラーム フィルタを使用して、OneClick で定義されたアラーム フィルタを取得します。
  • URL
     
    http://<hostname><:portnumber>/spectrum/restful/alarms/filters
  • HTTP メソッド
    GET
  • ボディ
    なし
  • ボディ コンテンツ
    使用されません
  • ヘッダ
    application/xml、application/json
  • 出力
    アラーム フィルタの名前を含む以下の xml 出力が返されます。
      <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
    - <alarmfilters-response xmlns="http://www.ca.com/spectrum/restful/schema/response">
      <alarmfilter>LAN_alarms</alarmfilter>
      <alarmfilter>Chassis_Alarms</alarmfilter>
      <alarmfilter>core_router_alarms</alarmfilter>
      </alarmfilters-response>
     
    This is an example based on our environment.
POST アラーム数
POST アラーム フィルタを使用して、OneClick からすべての重大度のアラームの数を取得します。
  • URL
     
    http://<hostname><portnumber>/spectrum/restful/alarms/count
  • HTTP メソッド
    POST
  • ボディ
    広範な xml 条件を使用して、目的のアラーム数を取得できます。たとえば、以下のボディを使用します。
    <?xml version="1.0" encoding="UTF-8"?> 
    <rs:alarms-count-request xmlns:rs="http://www.ca.com/spectrum/restful/schema/request" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://www.ca.com/spectrum/restful/schema/request 
    ../../../xsd/Request.xsd ">
     
    <rs:alarm-filter name="def"/>
    </rs:alarms-count-request> 
  • ボディ コンテンツ
    application/xml
  • ヘッダ
    application/xml、application/json
  • 出力
    すべての重大度のアラーム数を含む以下の xml 出力が返されます。
    <alarmcount-response>
        <critical>4</critical>
        <major>21</major>
        <minor>4</minor> 
    </alarmcount-response>
PUT alarms
PUT alarms を使用して、アラーム属性を更新します。
  • URL
    http://<hostname><:portnumber>/spectrum/restful/alarms/<alarm_id>?attr=<attr_ID>&val=<num>
  • HTTP メソッド
    PUT
  • ボディ
    なし
  • ボディ コンテンツ
    使用されません
  • ヘッダ
    application/xml、application/json
  • 出力
    成功または失敗を示す XML または JSON のリスト
URL パラメータ
  • alarm_ID
    アラーム ID を指定します。
  • &attr=<
    attr_ID
    >&val=<
    num
    >
    属性と値を指定します。複数の属性値のペアを指定することができます。
DELETE alarms
DELETE alarms を使用してアラームを削除するには、他のパラメータを使用せず、アラーム ID を含めます。
  • URL
    http://<hostname><:portnumber>/spectrum/restful/alarms/<alarm_id>
  • HTTP メソッド
    DELETE
  • ボディ
    なし
  • ボディ コンテンツ
    使用されません
  • ヘッダ
    application/xml、application/json
  • 出力
    成功または失敗を示す XML または JSON のリスト
URL パラメータ
  • alarm_ID
    削除するアラームを指定します。