105 lines
4.2 KiB
XML
105 lines
4.2 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="smapi-v1"
|
|
role="api-reference">
|
|
<title>SM API v1</title>
|
|
<para> Interact with Service Management </para>
|
|
<para>The typical port used for the SM REST API is 7777.
|
|
However, proper technique would be to look up the smapi service endpoint in Keystone.</para>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- API VERSIONS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="versions-smapi-v1">
|
|
<title>API versions</title>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sm-api/v1/sm-api-v1.wadl#versions">
|
|
<wadl:method href="#listVersions-smapi-v1"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sm-api/v1/sm-api-v1.wadl#version">
|
|
<wadl:method href="#showVersionDetails-smapi-v1"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- SERVICES -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="smapi-services-v1">
|
|
<title>Services</title>
|
|
<para>These APIs allow the display of the services running
|
|
and their attributes</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sm-api/v1/sm-api-v1.wadl#services">
|
|
<wadl:method href="#smlistServices"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sm-api/v1/sm-api-v1.wadl#service_id">
|
|
<wadl:method href="#smgetService" />
|
|
</wadl:resource>
|
|
<!--<wadl:resource-->
|
|
<!--href="../wadls/sm-api/v1/sm-api-v1.wadl#service_name">-->
|
|
<!--<wadl:method href="#modifyService"/>-->
|
|
<!--</wadl:resource>-->
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- SERVICE NODES -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="smapi-service-nodes-v1">
|
|
<title>Service Nodes</title>
|
|
<para>These APIs allow the display of the service nodes
|
|
and their attributes</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sm-api/v1/sm-api-v1.wadl#servicenodes">
|
|
<wadl:method href="#smlistServiceNodes"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sm-api/v1/sm-api-v1.wadl#node_id">
|
|
<wadl:method href="#smgetServiceNode" />
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- SERVICE GROUPS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="smapi-services-groups-v1">
|
|
<title>Service Groups</title>
|
|
<para>These APIs allow the display of the service groups
|
|
and their attributes</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sm-api/v1/sm-api-v1.wadl#servicegroup">
|
|
<wadl:method href="#smlistServiceGroups"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sm-api/v1/sm-api-v1.wadl#servicegroup_id">
|
|
<wadl:method href="#smgetServiceGroup" />
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
</chapter>
|