111 lines
4.4 KiB
XML
111 lines
4.4 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!--
|
|
Copyright (c) 2018 Wind River Systems, Inc.
|
|
|
|
SPDX-License-Identifier: Apache-2.0
|
|
|
|
-->
|
|
<chapter xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
xmlns:linkend="http://www.w3.org/1999/linkend"
|
|
xmlns:xref="http://www.w3.org/1999/xref"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
version="5.0-extension RackBook-2.0" xml:id="fmapi-v1"
|
|
role="api-reference">
|
|
<title>Fault Management API v1</title>
|
|
<para>The API supports alarm and event collection of the cloud platform itself. </para>
|
|
<para>The typical port used for the FM REST API is 18002.
|
|
However, proper technique would be to look up the FM service endpoint in Keystone.</para>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- API VERSIONS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="versions-fm-v1">
|
|
<title>API versions</title>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/fm-api/v1/fm-api-v1.wadl#versions">
|
|
<wadl:method href="#listVersions-fm-v1"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/fm-api/v1/fm-api-v1.wadl#version">
|
|
<wadl:method href="#showVersionDetails-fm-v1"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- ALARMS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="alarms-v1">
|
|
<title>Alarms</title>
|
|
<para>These APIs allow the display of the Active Alarms
|
|
in the system.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/fm-api/v1/fm-api-v1.wadl#alarms">
|
|
<wadl:method href="#listAlarms"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/fm-api/v1/fm-api-v1.wadl#alarm_uuid">
|
|
<wadl:method href="#getAlarm"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/fm-api/v1/fm-api-v1.wadl#alarm_uuid">
|
|
<wadl:method href="#deleteAlarm"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/fm-api/v1/fm-api-v1.wadl#alarm_summary">
|
|
<wadl:method href="#alarmSummary"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- EVENT LOG -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="eventlog-v1">
|
|
<title>Event Log</title>
|
|
<para>These APIs allow the display of the Event Log
|
|
in the system. The Event log contains both historical alarms and customer logs.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/fm-api/v1/fm-api-v1.wadl#event_log">
|
|
<wadl:method href="#listEventLog"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/fm-api/v1/fm-api-v1.wadl#event_log_uuid">
|
|
<wadl:method href="#getEventLog"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- EVENT SUPPRESSION -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="eventsuppression-v1">
|
|
<title>Event Suppression</title>
|
|
<para>These APIs allow the display of the Event Suppression state
|
|
in the system.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/fm-api/v1/fm-api-v1.wadl#event_suppression">
|
|
<wadl:method href="#listEventSuppression"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/fm-api/v1/fm-api-v1.wadl#event_suppression_uuid">
|
|
<wadl:method href="#modifyEventSuppression"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
</chapter>
|