233 lines
9.7 KiB
XML
233 lines
9.7 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE application [
|
|
<!ENTITY % common SYSTEM "../common.ent">
|
|
%common;
|
|
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
|
|
%common_project;
|
|
]>
|
|
<!-- (C) 2013-2015 OpenStack Foundation, All Rights Reserved -->
|
|
<application xmlns="http://wadl.dev.java.net/2009/02"
|
|
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
|
xmlns:csapi="http://docs.openstack.org/identity/api/v3">
|
|
<resources base="https://servers.api.openstack.com"
|
|
xml:id="os-aggregates-v2.1">
|
|
<resource id="v2.1" path="//v2.1">
|
|
<resource id="tenant_id" path="{tenant_id}">
|
|
&tenantIdRequestParameter;
|
|
<resource id="os-aggregates" path="os-aggregates">
|
|
<method href="#createaggregate"/>
|
|
<method href="#listaggregate"/>
|
|
<resource id="aggregate-id" path="{aggregate_id}">
|
|
&aggregateIdRequestParameter;
|
|
<method href="#showaggregate"/>
|
|
<method href="#updateaggregate"/>
|
|
<resource id="action" path="action">
|
|
<method href="#addhost"/>
|
|
<method href="#aggregatemetadata"/>
|
|
<method href="#removeaggregate"/>
|
|
</resource>
|
|
</resource>
|
|
</resource>
|
|
</resource>
|
|
</resource>
|
|
</resources>
|
|
<!-- *******************************************************-->
|
|
<!-- Aggregates -->
|
|
<!--*******************************************************-->
|
|
<method name="POST" id="createaggregate">
|
|
<wadl:doc xml:lang="EN" title="Create aggregate"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<para role="shortdesc">Creates a aggregate in a availability zone.</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<xsdxt:code
|
|
href="../api_samples/os-aggregates/aggregate-post-req.json"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="200">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<xsdxt:code
|
|
href="../api_samples/os-aggregates/aggregate-post-resp.json"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
</method>
|
|
<method name="POST" id="addhost">
|
|
<wadl:doc xml:lang="EN" title="Add host"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<para role="shortdesc">Adds a host to an
|
|
aggregate.</para>
|
|
<para>Specify the <code>add_host</code> action in the request body.</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<xsdxt:code
|
|
href="../api_samples/os-aggregates/aggregate-add-host-post-req.json"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="202">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<xsdxt:code
|
|
href="../api_samples/os-aggregates/aggregates-add-host-post-resp.json"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
</method>
|
|
<method name="GET" id="showaggregate">
|
|
<wadl:doc xml:lang="EN" title="Show aggregate details"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<para role="shortdesc">Shows the details of an aggregate,
|
|
hosts and metadata included.</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<xsdxt:code
|
|
href="../api_samples/os-aggregates/aggregate-post-req.json"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="200">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<xsdxt:code
|
|
href="../api_samples/os-aggregates/aggregates-get-resp.json"
|
|
/>
|
|
</wadl:doc> &x-openstack-request-idHeader;
|
|
</representation>
|
|
</response>
|
|
</method>
|
|
<method name="GET" id="listaggregate">
|
|
<wadl:doc xml:lang="EN" title="List aggregates"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<para role="shortdesc">Lists aggregates id, name, and
|
|
availability_zone for an aggregate.</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<xsdxt:code
|
|
href="../api_samples/os-aggregates/aggregate-post-req.json"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="200">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<xsdxt:code
|
|
href="../api_samples/os-aggregates/aggregates-list-get-resp.json"
|
|
/>
|
|
</wadl:doc> &x-openstack-request-idHeader;
|
|
</representation>
|
|
</response>
|
|
</method>
|
|
<method name="POST" id="aggregatemetadata">
|
|
<wadl:doc xml:lang="EN"
|
|
title="Create or update aggregate metadata"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<para role="shortdesc">Creates or replaces metadata for an
|
|
aggregate.</para>
|
|
<para>Specify the <code>add_metadata</code> action in the request body.</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<xsdxt:code
|
|
href="../api_samples/os-aggregates/aggregate-metadata-post-req.json"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="200">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<xsdxt:code
|
|
href="../api_samples/os-aggregates/aggregates-metadata-post-resp.json"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
</method>
|
|
|
|
<method name="POST" id="removeaggregate">
|
|
<wadl:doc xml:lang="EN" title="Remove host"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<para role="shortdesc">Removes a host from an
|
|
aggregate.</para>
|
|
<para>Specify the <code>remove_host</code> action in the request body.</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<xsdxt:code
|
|
href="../api_samples/os-aggregates/aggregate-remove-host-post-req.json"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="202">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<xsdxt:code
|
|
href="../api_samples/os-aggregates/aggregates-remove-host-post-resp.json"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
</method>
|
|
<method name="GET" id="updateaggregate">
|
|
<wadl:doc xml:lang="EN" title="Update aggregate"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<para role="shortdesc">Updates either or both the name and
|
|
availability zone for a aggregate.</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<xsdxt:code
|
|
href="../api_samples/os-aggregates/aggregate-update-post-req.json"
|
|
/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="200">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<xsdxt:code
|
|
href="../api_samples/os-aggregates/aggregate-update-post-resp.json"
|
|
/>
|
|
</wadl:doc> &x-openstack-request-idHeader;
|
|
</representation>
|
|
</response>
|
|
</method>
|
|
</application>
|