98 lines
3.7 KiB
XML
98 lines
3.7 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!--
|
|
Copyright (c) 2014-2017 Wind River Systems, Inc.
|
|
|
|
SPDX-License-Identifier: Apache-2.0
|
|
|
|
-->
|
|
<!DOCTYPE chapter[
|
|
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
|
]>
|
|
<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="telemetry-v2-cgcs-ext"
|
|
role="api-reference">
|
|
<title>Telemetry API v2 Titanium extensions</title>
|
|
<para>Titanium extensions to the OpenStack Telemetry API such as
|
|
Pipelines for outputting samples to CSV files.
|
|
</para>
|
|
<para>The typical port used for the Telemetry REST API is 8777.
|
|
However, proper technique would be to look up the ceilometer service endpoint in Keystone.</para>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- EXTENSIONS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="telemetry-ext-list">
|
|
<title>Extensions</title>
|
|
<para>The Extensions entity lists all available extensions</para>
|
|
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/telemetry-api/v2/cgcs-ext/telemetry-v2-cgcs-ext.wadl#extensions">
|
|
<wadl:method href="#listExtensions"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/telemetry-api/v2/cgcs-ext/telemetry-v2-cgcs-ext.wadl#extensionget">
|
|
<wadl:method href="#getExtension"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
|
|
|
|
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- Meter Types -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="telemetry-metertype-list">
|
|
<title>Meter Types</title>
|
|
<para>The Meter Types entity is modeled by Titanium extensions to
|
|
show unique meter types</para>
|
|
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/telemetry-api/v2/cgcs-ext/telemetry-v2-cgcs-ext.wadl#metertypes">
|
|
<wadl:method href="#listMeterTypes"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
|
|
|
|
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- PIPELINES -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="telemetry-ext-action">
|
|
<title>Pipeline</title>
|
|
<para>The Pipeline entity is modeled by Titanium extensions to
|
|
manipulate how samples are stored to CSV files</para>
|
|
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/telemetry-api/v2/cgcs-ext/telemetry-v2-cgcs-ext.wadl#pipelines">
|
|
<wadl:method href="#listPipelines"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/telemetry-api/v2/cgcs-ext/telemetry-v2-cgcs-ext.wadl#pipeline_id">
|
|
<wadl:method href="#getPipeline"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/telemetry-api/v2/cgcs-ext/telemetry-v2-cgcs-ext.wadl#pipeline_id">
|
|
<wadl:method href="#modifyPipeline"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
|
|
|
|
|
|
</section>
|
|
|
|
</chapter>
|