1976 lines
91 KiB
XML
1976 lines
91 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!-- (C) 2012-2015 OpenStack Foundation, All Rights Reserved -->
|
|
<!--*******************************************************-->
|
|
<!-- Import Common XML Entities -->
|
|
<!-- -->
|
|
<!-- You can resolve the entities with xmllint -->
|
|
<!-- -->
|
|
<!-- xmllint -noent os-compute-2.wadl -->
|
|
<!--*******************************************************-->
|
|
<!DOCTYPE application [
|
|
<!ENTITY % common SYSTEM "../common.ent">
|
|
%common;
|
|
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
|
|
%common_project;
|
|
]>
|
|
<application xmlns="http://wadl.dev.java.net/2009/02"
|
|
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
|
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:db="http://docbook.org/ns/docbook"
|
|
xmlns:common="http://docs.openstack.org/common/api/v1.0"
|
|
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
|
|
<grammars>
|
|
<include href="../xsd/api.xsd"/>
|
|
<include href="../xsd/api-common.xsd"/>
|
|
</grammars>
|
|
<!--*******************************************************-->
|
|
<!-- All Resources -->
|
|
<!--*******************************************************-->
|
|
<resources base="https://servers.api.openstack.com" xml:id="os-compute-v2">
|
|
<resource id="versions" path="/">
|
|
<method href="#listVersionsv2" />
|
|
<resource id="version" path="v2">
|
|
<resource id="tenant_id" path="{tenant_id}">
|
|
<param name="tenant_id" style="template" type="csapi:UUID">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>The tenant ID in a multi-tenancy cloud.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<resource id="extensions" type="#ExtensionList" path="extensions">
|
|
<resource id="extension" path="{alias}">
|
|
<param required="true" name="alias" style="template" type="xsd:string">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>An alias, which is a name for a pointer to a resource. For
|
|
example, a named extension.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<method href="#getExtensionv2" />
|
|
</resource>
|
|
</resource>
|
|
<resource id="limits" path="limits">
|
|
<method href="#listLimits" />
|
|
</resource>
|
|
<resource id="Servers" type="#ServerList" path="servers">
|
|
<method href="#createServer" />
|
|
<resource id="server_detail" path="detail" type="#DetailServerList" />
|
|
<resource id="server_id" path="{server_id}">
|
|
<param name="server_id" style="template" type="csapi:UUID">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>The UUID for the server.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<method href="#getServer" />
|
|
<method href="#updateServer" />
|
|
<method href="#deleteServer" />
|
|
</resource>
|
|
<resource id="ips" path="ips">
|
|
<method href="#getServerAddresses" />
|
|
<resource id="Network_label" path="{network_label}" type="#NetworkAddressList">
|
|
<param name="network_label" style="template" type="xsd:string">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="network_label">
|
|
<para>
|
|
The network label, such as
|
|
<literal>public</literal>
|
|
or
|
|
<literal>private</literal>
|
|
.
|
|
</para>
|
|
</wadl:doc>
|
|
</param>
|
|
</resource>
|
|
<method href="#getNetworkAddresses" />
|
|
</resource>
|
|
<resource id="server_metadata" path="metadata" type="#ServerMetadataDetails">
|
|
<resource id="ServerMetadataKey" path="{key}">
|
|
<param name="key" style="template" type="csapi:MetadataKey">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Server metadata item key">
|
|
<para>A string. Maximum length is 255 characters.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<method href="#getServerMetadataItem" />
|
|
<method href="#setServerMetadataItem" />
|
|
<method href="#deleteServerMetadataItem" />
|
|
</resource>
|
|
</resource>
|
|
<resource id="action" path="action">
|
|
<method href="#changePassword" />
|
|
<method href="#rebootServer" />
|
|
<method href="#rebuildServer" />
|
|
<method href="#resizeServer" />
|
|
<method href="#confirmServer" />
|
|
<method href="#revertServer" />
|
|
<method href="#associateSecGroup" />
|
|
<method href="#createImage" />
|
|
</resource>
|
|
</resource>
|
|
</resource>
|
|
<resource id="Images" type="#ImageList" path="images">
|
|
<resource id="image_detail" path="detail" type="#DetailImageList" />
|
|
<resource id="image_id" path="{image_id}">
|
|
<param name="image_id" style="template" type="csapi:UUID">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="image_id">
|
|
<para>The UUID for the image.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<method href="#getImage" />
|
|
<method href="#deleteImage" />
|
|
<resource id="image_metadata" path="metadata" type="#ImageMetadataDetails">
|
|
<resource id="imageMetadataKey" path="{key}">
|
|
<param name="key" style="template" type="csapi:imageMetadataKey">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Metadata item key">
|
|
<para>A string. Maximum length is 255 characters.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<method href="#getImageMetadataItem" />
|
|
<method href="#setImageMetadataItem" />
|
|
<method href="#deleteImageMetadataItem" />
|
|
</resource>
|
|
</resource>
|
|
</resource>
|
|
</resource>
|
|
<resource id="Flavors" type="#FlavorList" path="flavors">
|
|
<resource id="flavor_detail" path="detail" type="#DetailFlavorList" />
|
|
<resource id="flavor_id" path="{flavor_id}">
|
|
<param name="flavor_id" style="template" type="csapi:UUID">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="flavor_id">
|
|
<para>UUID for the specific flavor (combination of memory, disk
|
|
size, and CPUs).</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<method href="#getFlavor" />
|
|
</resource>
|
|
</resource>
|
|
</resource>
|
|
</resource>
|
|
</resources>
|
|
<!--*******************************************************-->
|
|
<!-- Resource Types -->
|
|
<!--*******************************************************-->
|
|
<resource_type id="ExtensionList">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Detail image list">
|
|
<para>A list of supported extensions.</para>
|
|
</wadl:doc>
|
|
<method href="#listExtensionsv2"/>
|
|
</resource_type>
|
|
<resource_type id="DetailServerList">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Detail server list">
|
|
<para>A detailed server list.</para>
|
|
</wadl:doc>
|
|
<method href="#listDetailServers"/>
|
|
</resource_type>
|
|
<resource_type id="ServerList">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Server list">
|
|
<para>
|
|
A list of servers. In the list, each server element includes
|
|
its ID, name, and links attributes. Other attributes are omitted.
|
|
</para>
|
|
</wadl:doc>
|
|
<method href="#listServers"/>
|
|
</resource_type>
|
|
<resource_type id="Addresses">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Addresses">
|
|
<para>A list of addresses associated with a server.</para>
|
|
</wadl:doc>
|
|
<method href="#getServerAddresses"/>
|
|
</resource_type>
|
|
<resource_type id="NetworkAddressList">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Network address list">
|
|
<para>A list of addresses associated with a network label.</para>
|
|
</wadl:doc>
|
|
<method href="#getNetworkAddresses"/>
|
|
</resource_type>
|
|
<resource_type id="DetailImageList">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Detail image list">
|
|
<para>A detailed image list.</para>
|
|
</wadl:doc>
|
|
<method href="#listDetailImages"/>
|
|
</resource_type>
|
|
<resource_type id="ImageList">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Image list">
|
|
<para>
|
|
A list of images. Each image contains IDs, names, and links.
|
|
Other attributes are omitted.
|
|
</para>
|
|
</wadl:doc>
|
|
<method href="#listImages"/>
|
|
</resource_type>
|
|
<resource_type id="DetailFlavorList">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Detail flavor list">
|
|
<para>A detailed flavor list.</para>
|
|
</wadl:doc>
|
|
<method href="#listDetailFlavors"/>
|
|
</resource_type>
|
|
<resource_type id="FlavorList">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Flavor list">
|
|
<para>
|
|
A list of flavors. Each flavor contains IDs, names, and links;
|
|
other attributes are omitted.
|
|
</para>
|
|
</wadl:doc>
|
|
<method href="#listFlavors"/>
|
|
</resource_type>
|
|
<resource_type id="ServerMetadataDetails">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Server metadata list">
|
|
<para>Metadata details for a server.</para>
|
|
</wadl:doc>
|
|
<method href="#showServerMetadata"/>
|
|
<method href="#createServerMetadata"/>
|
|
<method href="#updateServerMetadata"/>
|
|
</resource_type>
|
|
<resource_type id="ImageMetadataDetails">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Image metadata list">
|
|
<para>Metadata details for an image.</para>
|
|
</wadl:doc>
|
|
<method href="#showImageMetadata"/>
|
|
<method href="#createImageMetadata"/>
|
|
<method href="#updateImageMetadata"/>
|
|
</resource_type>
|
|
<!--*******************************************************-->
|
|
<!-- All Methods -->
|
|
<!--*******************************************************-->
|
|
<!-- Version -->
|
|
<method name="GET" id="listVersionsv2">
|
|
<wadl:doc xml:lang="EN" title="List API versions" xmlns="http://docbook.org/ns/docbook">
|
|
<para role="shortdesc">
|
|
Lists information about all Compute API versions.
|
|
</para>
|
|
</wadl:doc>
|
|
<response status="200 300">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/versions/versions-get-resp.json"/>
|
|
</wadl:doc>
|
|
&x-compute-request-idHeader;
|
|
</representation>
|
|
</response>
|
|
&commonFaults; &getFaults;
|
|
</method>
|
|
<!-- Limits -->
|
|
<method name="GET" id="listLimits">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List limits">
|
|
<para role="shortdesc">
|
|
Lists the current absolute and rate limits for a specified project.
|
|
</para>
|
|
<para>
|
|
An absolute limit value of <code>-1</code> indicates that the
|
|
absolute limit for the item is infinite.
|
|
</para>
|
|
</wadl:doc>
|
|
<response status="200 203">
|
|
<representation mediaType="application/json" element="common:limits">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/limit-get-resp.json"/>
|
|
</wadl:doc>
|
|
&x-compute-request-idHeader; &absoluteLimits; &rateLimits;
|
|
</representation>
|
|
<representation mediaType="application/xml" element="common:limits">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/limit-get-resp.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
<!-- Common Faults and Header --> &commonFaults;
|
|
</method>
|
|
<!-- Extensions -->
|
|
<method name="GET" id="listExtensionsv2">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List extensions">
|
|
<para role="shortdesc">Lists available extensions.</para>
|
|
</wadl:doc>
|
|
<response status="200 203">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/all_extensions/extensions-get-resp.json"/>
|
|
</wadl:doc>
|
|
&x-compute-request-idHeader;
|
|
</representation>
|
|
<representation mediaType="application/xml" element="common:extensions">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/all_extensions/extensions-get-resp.xml"/>
|
|
</wadl:doc>
|
|
<param name="next" style="plain" type="xsd:anyURI"
|
|
path="/common:extensions/atom:link[@rel='next']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>
|
|
Moves to the next metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#ExtensionList" rel="next"/>
|
|
</param>
|
|
<param name="previous" style="plain" type="xsd:anyURI"
|
|
path="/common:extensions/atom:link[@rel='previous']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>
|
|
Moves to the previous metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#ExtensionList" rel="previous"/>
|
|
</param>
|
|
</representation>
|
|
</response>
|
|
<!-- Common Faults and Header --> &commonFaults;
|
|
</method>
|
|
<method name="GET" id="getExtensionv2">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" title="Get extension">
|
|
<para role="shortdesc">Gets details about the specified extension.</para>
|
|
<para>
|
|
Extensions introduce features and vendor-specific functionality to
|
|
the API without requiring a version change.
|
|
</para>
|
|
</wadl:doc>
|
|
<response status="200 203">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/extension.json"/>
|
|
</wadl:doc>
|
|
&x-compute-request-idHeader;
|
|
</representation>
|
|
<representation mediaType="application/xml" element="common:extension">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/extension.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
<!-- Common and GET Faults and Header--> &commonFaults; &getFaults;
|
|
</method>
|
|
<!-- Servers -->
|
|
<method name="POST" id="createServer">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create server">
|
|
<para role="shortdesc">Creates a server.</para>
|
|
<para>
|
|
The progress of this operation depends on the location of the
|
|
requested image, network I/O, host load, selected flavor, and
|
|
other factors.
|
|
</para>
|
|
<para>
|
|
Issue a <code>GET /servers/{id}</code> request to check the
|
|
progress of the request, which returns a progress attribute with a
|
|
from 0 to 100% complete value. The <code>Location</code> header
|
|
returns the full URL to the newly created server and is available
|
|
as a <code>self</code> and <code>bookmark</code> link in the
|
|
server representation.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
When you create a server, only the server ID, its links,
|
|
and the admin password are guaranteed to be returned in
|
|
the response. You can get additional attributes through
|
|
subsequent &GET; requests on the server.
|
|
</para>
|
|
</note>
|
|
<para>
|
|
Include the <code>block-device-mapping-v2</code> parameter
|
|
in the create request body to boot a server from a volume.
|
|
</para>
|
|
<para>
|
|
Include the <code>key_name</code> parameter in the create request
|
|
body to add a keypair to the server when you create it. To create
|
|
a keypair, make a
|
|
<link xlink:href="http://developer.openstack.org/api-ref-compute-v2-ext.html#createKeypair">create keypair</link> request.
|
|
</para>
|
|
<para>Preconditions</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>
|
|
The user must have sufficient server quota to create
|
|
the number of servers requested.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
The connection to the Image service is valid.
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
<para>Asynchronous postconditions</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>
|
|
With correct permissions, you can see the server
|
|
status as <code>ACTIVE</code> through API calls.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
With correct access, you can see the created server in
|
|
the compute node that OpenStack Compute manages.
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
<para>Troubleshooting</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>
|
|
If the server status remains <code>BUILDING</code> or
|
|
shows another error status, the request failed. Ensure
|
|
you meet the preconditions then investigate the
|
|
compute node.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
The server is not created in the compute node that
|
|
OpenStack Compute manages.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
The compute node needs enough free resource to match
|
|
the specified resource of the server creation request.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Ensure that the scheduler selection filter can fulfill the
|
|
request with the available compute nodes that match
|
|
the selection criteria of the filter.
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/xml" element="csapi:server">
|
|
&serverCreateParameters;
|
|
</representation>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/os-block-device-mapping-v2-boot/server-post-req.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-post-req.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="202">
|
|
<representation mediaType="application/json" element="csapi:server">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-post-resp.json"/>
|
|
</wadl:doc>
|
|
&serverCreateParameters;
|
|
</representation>
|
|
</response>
|
|
<response status="422">
|
|
<representation mediaType="application/json"/>
|
|
<representation mediaType="application/xml" element="csapi:UnprocessableEntity"/>
|
|
</response>
|
|
<!-- All other common faults except build in progress --> &commonFaults; &getFaults;
|
|
&postPutFaults; &buildFaults;
|
|
</method>
|
|
<method name="GET" id="listServers">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List servers">
|
|
<para role="shortdesc">Lists IDs, names, and links for all servers.</para>
|
|
<para>
|
|
Servers contain a status attribute that indicates the current
|
|
server state. You can filter on the server status when you
|
|
complete a list servers request. The server status is returned in
|
|
the response body. The possible server status values are:
|
|
</para>
|
|
<itemizedlist xml:id="server_status">
|
|
<title>Server status values</title>
|
|
<listitem>
|
|
<para><code>ACTIVE</code>. The server is active.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><code>BUILDING</code>. The server has not finished the original build
|
|
process.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><code>DELETED</code>. The server is permanently deleted.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><code>ERROR</code>. The server is in error.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><code>HARD_REBOOT</code>. The server is hard rebooting. This is equivalent
|
|
to pulling the power plug on a physical server, plugging it back in, and
|
|
rebooting it.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><code>PASSWORD</code>. The password is being reset on the server.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><code>PAUSED</code>. In a paused state, the state of the server is
|
|
stored in RAM. A paused server continues to run in frozen state.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><code>REBOOT</code>. The server is in a soft reboot state. A reboot
|
|
command was passed to the operating system.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><code>REBUILD</code>. The server is currently being rebuilt from an
|
|
image.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><code>RESCUED</code>. The server is in rescue mode. A rescue image
|
|
is running with the original server image attached.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><code>RESIZED</code>. Server is performing the differential copy of data
|
|
that changed during its initial copy. Server is down for this stage.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><code>REVERT_RESIZE</code>. The resize or migration of a server failed for
|
|
some reason. The destination server is being cleaned up and the original
|
|
source server is restarting.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><code>SOFT_DELETED</code>. The server is marked as deleted but the
|
|
disk images are still available to restore.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><code>STOPPED</code>. The server is powered off and the disk image
|
|
still persists.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
<code>SUSPENDED</code>. The server is suspended,
|
|
either by request or necessity. This status appears for only
|
|
the following hypervisors: XenServer/XCP, KVM, and ESXi.
|
|
Administrative users may suspend an instance if it is
|
|
infrequently used or to perform system maintenance. When you
|
|
suspend an instance, its VM state is stored on disk, all memory is written
|
|
to disk, and the virtual machine is stopped. Suspending an instance is
|
|
similar to placing a device in hibernation; memory and vCPUs become
|
|
available to create other instances.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><code>UNKNOWN</code>. The state of the server is unknown. Contact your
|
|
cloud provider.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><code>VERIFY_RESIZE</code>. System is awaiting confirmation that the
|
|
server is operational after a move or resize.
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/xml">
|
|
&serverListQueryParameters;
|
|
&limitMarkerReqParameter;
|
|
</representation>
|
|
</request>
|
|
<response status="200 203">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/servers-list-resp.json"/>
|
|
</wadl:doc>
|
|
&x-compute-request-idHeader;
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:servers">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code
|
|
href="../api_samples/servers-list-resp.xml"/>
|
|
</wadl:doc>
|
|
<param name="servers" style="plain" required="true"
|
|
type="csapi:ServersWithOnlyIDsNamesLinks"
|
|
path="/csapi:servers/atom:link[@rel='servers']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>List of servers.</para>
|
|
</wadl:doc>
|
|
<link resource_type="#ServerList" rel="servers"/>
|
|
</param>
|
|
<param name="next" style="plain" type="xsd:anyURI"
|
|
path="/csapi:servers/atom:link[@rel='next']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>
|
|
Moves to the next metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#ServerList" rel="next"/>
|
|
</param>
|
|
<param name="previous" style="plain" type="xsd:anyURI"
|
|
path="/csapi:servers/atom:link[@rel='previous']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>
|
|
Moves to the previous metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#ServerList" rel="previous"/>
|
|
</param>
|
|
</representation>
|
|
</response>
|
|
<!-- Common Faults and Header --> &commonFaults;
|
|
</method>
|
|
<method name="GET" id="listDetailServers">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
|
title="List details for servers">
|
|
<para role="shortdesc">Lists details for all servers.</para>
|
|
<para>
|
|
The compute provisioning algorithm has an anti-affinity property
|
|
that attempts to spread customer VMs across hosts. Under certain
|
|
situations, VMs from the same customer might be placed on the same
|
|
host. The <property>hostId</property> property shows the host that
|
|
your server runs on and can be used to determine this scenario if
|
|
it is relevant to your application.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
<property>HostId</property> is unique <emphasis>per
|
|
account</emphasis> and is not globally unique.
|
|
</para>
|
|
</note>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/xml">
|
|
&serverListQueryParameters;
|
|
&limitMarkerReqParameter;
|
|
</representation>
|
|
</request>
|
|
<response status="200 203">
|
|
<representation mediaType="application/xml">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/servers-details-resp.xml"/>
|
|
</wadl:doc>
|
|
<param name="next" style="plain" type="xsd:anyURI"
|
|
path="/csapi:servers/atom:link[@rel='next']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>
|
|
Moves to the next metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#DetailServerList" rel="next"/>
|
|
</param>
|
|
<param name="previous" style="plain" type="xsd:anyURI"
|
|
path="/csapi:servers/atom:link[@rel='previous']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>
|
|
Moves to the previous metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#DetailServerList" rel="previous"/>
|
|
</param> &x-compute-request-idHeader;
|
|
</representation>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/servers-details-resp.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:servers">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/servers-details-resp.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
<!-- Common Faults --> &commonFaults;
|
|
</method>
|
|
<method name="GET" id="getServer">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Get server details">
|
|
<para role="shortdesc">Gets details for a specified server.</para>
|
|
<para>Preconditions</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>The specified server must exist.</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</wadl:doc>
|
|
<response status="200 203">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-get-resp.json"/>
|
|
</wadl:doc>
|
|
&x-compute-request-idHeader;
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:server">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-get-resp.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
<!-- Common and GET Faults--> &commonFaults; &getFaults;
|
|
</method>
|
|
<method name="PUT" id="updateServer">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update server">
|
|
<para role="shortdesc">Updates the editable attributes of the specified server.</para>
|
|
<para>Preconditions</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>The specified server must exist.</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json" element="csapi:server">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
|
title="Update Server Name Request: JSON">
|
|
<xsdxt:code href="../api_samples/server-put-req.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:server">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
|
title="Update Server Name Request: XML">
|
|
<xsdxt:code href="../api_samples/server-put-req.xml"/>
|
|
</wadl:doc>
|
|
<param name="name" style="plain" required="false" type="csapi:ServerForUpdate"
|
|
path="/csapi:server">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>The name of the server. If you edit the server name, the server host
|
|
name does not change. Also, server names are not guaranteed to be
|
|
unique.
|
|
</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param name="accessIPv4" style="plain" required="false" type="csapi:ServerForUpdate"
|
|
path="/csapi:server">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>The IP version 4 address.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param name="accessIPv6" style="plain" required="false" type="csapi:ServerForUpdate"
|
|
path="/csapi:server">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>The IP version 6 address.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param name="auto_disk_config" style="plain" required="false" type="csapi:ServerForUpdate"
|
|
path="/csapi:server">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>
|
|
Defines how the server's root disk partition is handled when
|
|
the server is started or resized. Valid values are:
|
|
</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>
|
|
True. The root partition expands to encompass all
|
|
available virtual disks.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
False. The root partition remains the same size as the
|
|
original image. The operating system sees extra
|
|
virtual disk space as unformatted free space.
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</wadl:doc>
|
|
</param>
|
|
</representation>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
|
title="Update Server IP Addresses Request: JSON">
|
|
<xsdxt:code href="../api_samples/server-put-req-ad.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
|
title="Update Server IP Addresses Request: XML">
|
|
<xsdxt:code href="../api_samples/server-put-req-ad.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="200">
|
|
<representation mediaType="application/json" element="csapi:server">
|
|
<wadl:doc xml:lang="EN" title="Update Server Name Response: JSON"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<xsdxt:code href="../api_samples/server-put-resp.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:server">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
|
title="Update Server Name Response: XML">
|
|
<xsdxt:code href="../api_samples/server-put-resp.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
|
title="Update Server IP Addresses Response: JSON">
|
|
<xsdxt:code href="../api_samples/server-put-resp-ad.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
|
title="Update Server IP Addresses Response: XML">
|
|
<xsdxt:code href="../api_samples/server-put-resp-ad.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
<!-- Common, GET, POST/PUT, inProgress Faults--> &commonFaults; &getFaults; &postPutFaults;
|
|
&inProgressFault;
|
|
</method>
|
|
<method name="DELETE" id="deleteServer">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete server">
|
|
<para role="shortdesc">Deletes a specified server.</para>
|
|
<para>Preconditions</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>The specified server must exist.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Anyone can delete a server when the server's
|
|
status is not locked.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>You can delete a server which status is
|
|
not locked.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>If the specified server is locked, you need to
|
|
have administrator privileges to delete the server.
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
<para>Asynchronous postconditions</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>With correct permissions, you can see the
|
|
specified server status as <code>DELETED</code> through API
|
|
calls.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>The port attached to the specified server
|
|
is deleted.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>The server is deleted from the list of
|
|
servers returned by an API call.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>The server managed by OpenStack Compute is
|
|
deleted on the compute node.
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
<para>Troubleshooting</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>If server status remains in <code>deleting</code>
|
|
or shows another error status, the request failed. Ensure you
|
|
meet the preconditions then investigate the compute back end.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>The request returns the HTTP 409 status code
|
|
when the server is locked even if you have a correct permissions.
|
|
Ensure you meet the preconditions then investigate the server
|
|
status.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>The server managed by OpenStack Compute is not
|
|
deleted from the compute node.
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</wadl:doc>
|
|
<response status="204"/>
|
|
<!-- Common, GET, inProgress Faults--> &commonFaults; &getFaults;
|
|
</method>
|
|
<!-- Server Actions -->
|
|
<method name="POST" id="changePassword">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Change password">
|
|
<para role="shortdesc">Changes the password for a server. Specify the
|
|
<code>changePassword</code> action in the request body.
|
|
</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-action-changepassword.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:changePassword">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-action-changepassword.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="202"/>
|
|
<!-- Common, GET, POST, PUT, and inProgress Faults--> &commonFaults; &getFaults; &postPutFaults;
|
|
&inProgressFault;
|
|
</method>
|
|
<method name="POST" id="rebootServer">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Reboot server">
|
|
<para role="shortdesc">Reboots the specified server. Specify the <code>reboot</code>
|
|
action in the request body.
|
|
</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-action-reboot.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:reboot">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-action-reboot.xml"/>
|
|
</wadl:doc>
|
|
<param name="type" style="plain" type="xsd:string" required="true">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>
|
|
The type of reboot.
|
|
Valid values are:
|
|
</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>
|
|
SOFT. Signal the operating system to restart.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
HARD. Restart the server. Equivalent to power cycling
|
|
the server.
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</wadl:doc>
|
|
</param>
|
|
</representation>
|
|
</request>
|
|
<response status="202"/>
|
|
<!-- Common, GET, POST, PUT, and inProgress Faults--> &commonFaults; &getFaults; &postPutFaults;
|
|
&rebootFaults; &inProgressFault;
|
|
</method>
|
|
<method name="POST" id="rebuildServer">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Rebuild server">
|
|
<para role="shortdesc">
|
|
Rebuilds the specified server. Specify the <code>rebuild</code>
|
|
action in the request body.
|
|
</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-action-rebuild.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:rebuild">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-action-rebuild.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="202">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-action-rebuild-resp.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:server">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-action-rebuild-resp.xml"/>
|
|
</wadl:doc>
|
|
<param name="Location" style="header" required="true" type="xsd:anyURI">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Location">
|
|
<para>Specific URL of the server you want to rebuild.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
</representation>
|
|
</response>
|
|
<!-- All other faults, build, common, get, post/put, and inProgress --> &commonFaults;
|
|
&getFaults; &postPutFaults; &buildFaults; &inProgressFault;
|
|
</method>
|
|
<method name="POST" id="resizeServer">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Resize server">
|
|
<para role="shortdesc">Resizes the specified server. Specify the <code>resize</code>
|
|
action in the request body.
|
|
</para>
|
|
<para>
|
|
A successfully resized server shows the <code>VERIFY_RESIZE</code>
|
|
status, <code>RESIZED</code> VM status, and <code>finished</code>
|
|
migration status. If you set the <code>auto_confirm</code> option
|
|
of the Compute service to <code>True</code>, the Compute service
|
|
automatically confirms the resize operation.
|
|
</para>
|
|
<para>Preconditions</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>You can only resize a server when its status is
|
|
<code>ACTIVE</code>.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>If the specified server is locked, you must have
|
|
administrator privileges to resize the server.
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-action-resize.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:resize">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-action-resize.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="202"/>
|
|
<!-- All other faults, build, common, get, post/put, and inProgress --> &commonFaults;
|
|
&getFaults; &postPutFaults; &buildFaults; &inProgressFault;
|
|
</method>
|
|
<method name="POST" id="confirmServer">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Confirm resized server">
|
|
<para role="shortdesc">
|
|
Confirms a pending resize action. Specify the
|
|
<code>confirmResize</code> action in the request body.
|
|
</para>
|
|
<para>
|
|
After you make this request, you typically must keep polling the
|
|
server status to determine whether the request succeeded. A
|
|
successfully confirming resize operation shows <code>ACTIVE</code>
|
|
status and <code>confirmed</code> migration status. You can also
|
|
see the resized server in the compute node that OpenStack Compute
|
|
manages.
|
|
</para>
|
|
<para>Preconditions</para>
|
|
<para>
|
|
To confirm a pending resize action, these preconditions must be
|
|
met:
|
|
</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>
|
|
Server status is <code>VERIFY_RESIZED</code>, VM status is
|
|
<code>RESIZED</code>, and migration status is
|
|
<code>finished</code> or <code>confirming</code>.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>If the specified server is locked, you must have
|
|
administrator privileges to confirm the server.
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
<para>Troubleshooting</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>
|
|
If the specified server status remains <code>RESIZED</code>,
|
|
the request failed. Ensure you meet the preconditions and run
|
|
the request again. If the request fails again, investigate the
|
|
compute back end or ask your cloud provider.
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-action-confirmresize.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:confirmResize">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-action-confirmresize.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="204"/>
|
|
<!-- All other faults, build, common, get, post/put, and inProgress --> &commonFaults;
|
|
&getFaults; &postPutFaults; &buildFaults; &inProgressFault;
|
|
</method>
|
|
<method name="POST" id="revertServer">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Revert resized server">
|
|
<para role="shortdesc">Cancels and reverts a pending resize action. Specify the
|
|
<code>revertResize</code> action in the request body.
|
|
</para>
|
|
<para>
|
|
After you make this request, you typically must keep polling the
|
|
server status to determine whether the request succeeded. A
|
|
successfully reverting resize operation shows <code>ACTIVE</code>
|
|
status and <code>reverted</code> migration status. You can also
|
|
see the reverted server in the compute node that OpenStack Compute
|
|
manages.
|
|
</para>
|
|
<para>Preconditions</para>
|
|
<para>
|
|
To cancel and revert a pending resize action, these preconditions
|
|
must be met:
|
|
</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>
|
|
Server status is <code>VERIFY_RESIZE</code> and VM status is
|
|
<code>RESIZED</code>.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>If the specified server is locked, you must have
|
|
administrator privileges to revert the resizing.
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
<para>Troubleshooting</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>
|
|
If the specified server status remains <code>RESIZED</code>,
|
|
the request failed. Ensure you meet the preconditions and
|
|
run the request again. If the request fails again,
|
|
investigate the compute back end.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>The specified server is not reverted in the compute
|
|
node that OpenStack Compute manages.
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-action-revertresize.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:revertResize">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-action-revertresize.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="202"/>
|
|
<!-- All other faults, build, common, get, post/put, and inProgress --> &commonFaults;
|
|
&getFaults; &postPutFaults; &buildFaults; &inProgressFault;
|
|
</method>
|
|
<method name="POST" id="associateSecGroup">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Associate security
|
|
group with server">
|
|
<para role="shortdesc">
|
|
Associates a specified security group with a server.
|
|
Specify the <code>addSecurityGroup</code> action and
|
|
the name of the security group in the request body.
|
|
</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-action-associatesecgroup.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="202"/>
|
|
<!-- Common, GET, POST, PUT, and inProgress Faults--> &commonFaults; &getFaults; &postPutFaults;
|
|
&inProgressFault;
|
|
</method>
|
|
<method name="POST" id="createImage">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create image">
|
|
<para role="shortdesc">
|
|
Creates an image. Specify the <code>createImage</code> action in
|
|
the request body.
|
|
</para>
|
|
<para>
|
|
After you make this request, you typically must keep polling the
|
|
created image's status to determine whether the request succeeded.
|
|
A successfully creating image operation shows the
|
|
<code>available</code> image status and the server status reverts
|
|
to its original status. You can also see the new image in the
|
|
image back end that OpenStack Image service manages.
|
|
</para>
|
|
<para>Preconditions</para>
|
|
<para>
|
|
To create an image, these preconditions must be met:
|
|
</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>The specified server must exist.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
The server status is <code>ACTIVE</code>,
|
|
<code>PAUSED</code>, or <code>SUSPENDED</code>.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>The connection to the Image service is valid.
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
<para>Troubleshooting</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>
|
|
If the image status remains uploading or shows another error
|
|
status, the request failed. Ensure you meet the
|
|
preconditions and run the request again. If the request
|
|
fails again, investigate the image back end.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>If the server status does not go back to an original
|
|
server's status, the request failed. Ensure you meet the preconditions,
|
|
or check if there is another operation that causes race conditions
|
|
for the server, then run the request again. If the request fails
|
|
again, investigate the compute back end or ask your cloud provider.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>If the request fails due to an error on OpenStack
|
|
Compute service, the image is purged from the image store that
|
|
OpenStack Image service manages. Ensure you meet the preconditions
|
|
and run the request again. If the request fails again, investigate
|
|
OpenStack Compute service or ask your cloud provider.
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-action-createimage.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:createImage">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-action-createimage.xml"/>
|
|
</wadl:doc>
|
|
<param name="name" style="plain" required="true" type="csapi:ServerForCreate"
|
|
path="/csapi:server">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="name">
|
|
<para>Name of the snapshot.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param name="createImage" style="plain" required="true" type="csapi:ServerForCreate"
|
|
path="/csapi:server">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
|
title="createImage">
|
|
<para>A dictionary representation of a creation for image.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param name="metadata" style="plain" required="false" type="csapi:ServerForCreate"
|
|
path="/csapi:server">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="metadata">
|
|
<para>Metadata key and value pairs. The maximum size of the metadata key and
|
|
value is 255 bytes each.
|
|
</para>
|
|
</wadl:doc>
|
|
</param>
|
|
</representation>
|
|
</request>
|
|
<response status="202">
|
|
<representation mediaType="application/xml">
|
|
<param name="Location" style="header" required="true" type="xsd:anyURI"/>
|
|
</representation>
|
|
</response>
|
|
<response status="409">
|
|
<representation mediaType="application/json"/>
|
|
<representation mediaType="application/xml" element="csapi:backupOrResizeInProgress"/>
|
|
</response>
|
|
<!-- All other faults, build, common, get, post/put, and inProgress --> &commonFaults;
|
|
&getFaults; &postPutFaults; &buildFaults; &inProgressFault;
|
|
</method>
|
|
<!-- IPs -->
|
|
<method name="GET" id="getServerAddresses">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" title="List addresses">
|
|
<para role="shortdesc">Lists networks and addresses for a specified tenant and
|
|
server.
|
|
</para>
|
|
<para>Specify the tenant ID and server ID in the URI.</para>
|
|
</wadl:doc>
|
|
<response status="200 203">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/addresses.json"/>
|
|
</wadl:doc>
|
|
&x-compute-request-idHeader;
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:addresses">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/addresses.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
<!-- Common, GET, inProgress Faults--> &commonFaults; &getFaults; &inProgressFault;
|
|
</method>
|
|
<method name="GET" id="getNetworkAddresses">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
|
title="List addresses by network">
|
|
<para role="shortdesc">Lists addresses for a specified tenant, server, and
|
|
network.
|
|
</para>
|
|
<para>Specify the tenant ID, server ID, and network label in the request URI.</para>
|
|
</wadl:doc>
|
|
<response status="200 203">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/public.json"/>
|
|
</wadl:doc>
|
|
&x-compute-request-idHeader;
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:public">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/public.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
<!-- Common, GET, inProgress Faults--> &commonFaults; &getFaults; &inProgressFault;
|
|
</method>
|
|
<!-- Flavors -->
|
|
<method name="GET" id="listFlavors">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List flavors">
|
|
<para role="shortdesc">Lists IDs, names, and links for available flavors.</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/xml">
|
|
&flavorListQueryParameters;
|
|
&limitMarkerReqParameter;
|
|
</representation>
|
|
</request>
|
|
<response status="200 203">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/flavors-list-resp.json"/>
|
|
</wadl:doc>
|
|
&x-compute-request-idHeader;
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:flavors">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/flavors-list-resp.xml"/>
|
|
</wadl:doc>
|
|
<param name="flavors" style="plain" required="true"
|
|
type="csapi:FlavorsWithOnlyIDsNamesLinks" path="/csapi:flavors">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>
|
|
Flavors are known combinations of memory, disk space, and
|
|
number of CPUs.
|
|
</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param name="next" style="plain" type="xsd:anyURI"
|
|
path="/csapi:flavors/atom:link[@rel='next']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Moves to the next metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#FlavorList" rel="next"/>
|
|
</param>
|
|
<param name="previous" style="plain" type="xsd:anyURI"
|
|
path="/csapi:flavors/atom:link[@rel='previous']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Moves to the previous metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#FlavorList" rel="previous"/>
|
|
</param>
|
|
</representation>
|
|
</response>
|
|
<!-- Common Faults --> &commonFaults;
|
|
</method>
|
|
<method name="GET" id="listDetailFlavors">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
|
title="List details for flavors">
|
|
<para role="shortdesc">Lists all details for available flavors.</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/xml">
|
|
&flavorListQueryParameters;
|
|
&limitMarkerReqParameter;
|
|
</representation>
|
|
</request>
|
|
<response status="200 203">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/flavors-list-resp.json"/>
|
|
</wadl:doc>
|
|
&x-compute-request-idHeader;
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:flavors">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/flavors-list-resp.xml"/>
|
|
</wadl:doc>
|
|
<param name="next" style="plain" type="xsd:anyURI"
|
|
path="/csapi:flavors/atom:link[@rel='next']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Moves to the next metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#DetailFlavorList" rel="next"/>
|
|
</param>
|
|
<param name="previous" style="plain" type="xsd:anyURI"
|
|
path="/csapi:flavors/atom:link[@rel='previous']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Moves to the previous metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#DetailFlavorList" rel="previous"/>
|
|
</param>
|
|
</representation>
|
|
</response>
|
|
<!-- Common Faults --> &commonFaults;
|
|
</method>
|
|
<method name="GET" id="getFlavor">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Get flavor details">
|
|
<para role="shortdesc">Gets details for a specified flavor.</para>
|
|
</wadl:doc>
|
|
<response status="200 203">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/flavor-get-resp.json"/>
|
|
</wadl:doc>
|
|
&x-compute-request-idHeader;
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:flavor">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/flavor-get-resp.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
<!-- Common and GET Faults--> &commonFaults; &getFaults;
|
|
</method>
|
|
<!-- Images -->
|
|
<method name="GET" id="listDetailImages">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" title="List images details">
|
|
<para role="shortdesc">Lists all details for available images.</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/xml">
|
|
&imageListQueryParameters;
|
|
&limitMarkerReqParameter;
|
|
</representation>
|
|
</request>
|
|
<response status="200 203">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/images-details-get-resp.json"/>
|
|
</wadl:doc>
|
|
&x-compute-request-idHeader;
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:images">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/images-details-get-resp.xml"/>
|
|
</wadl:doc>
|
|
<param name="next" style="plain" type="xsd:anyURI"
|
|
path="/csapi:images/atom:link[@rel='next']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Moves to the next metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#DetailImageList" rel="next"/>
|
|
</param>
|
|
<param name="previous" style="plain" type="xsd:anyURI"
|
|
path="/csapi:images/atom:link[@rel='previous']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Moves to the previous metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#DetailImageList" rel="previous"/>
|
|
</param>
|
|
</representation>
|
|
</response>
|
|
<!-- Common Faults --> &commonFaults;
|
|
</method>
|
|
<method name="GET" id="listImages">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List images">
|
|
<para role="shortdesc">Lists IDs, names, and links for available images.</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/xml">
|
|
&imageListQueryParameters;
|
|
&limitMarkerReqParameter;
|
|
</representation>
|
|
</request>
|
|
<response status="200 203">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/images-list-get-resp.json"/>
|
|
</wadl:doc>
|
|
&x-compute-request-idHeader;
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:images">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/images-list-get-resp.xml"/>
|
|
</wadl:doc>
|
|
<param name="images" style="plain" required="true"
|
|
type="csapi:ImagesWithOnlyIDsNamesLinks" path="/csapi:images">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Image information.
|
|
</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param name="next" style="plain" type="xsd:anyURI"
|
|
path="/csapi:images/atom:link[@rel='next']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Moves to the next metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#ImageList" rel="next"/>
|
|
</param>
|
|
<param name="previous" style="plain" type="xsd:anyURI"
|
|
path="/csapi:images/atom:link[@rel='previous']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Moves to the previous metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#ImageList" rel="previous"/>
|
|
</param>
|
|
</representation>
|
|
</response>
|
|
<!-- Common Faults --> &commonFaults;
|
|
</method>
|
|
<method name="GET" id="getImage">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Get image details">
|
|
<para role="shortdesc">Gets details for a specified image.</para>
|
|
</wadl:doc>
|
|
<response status="200 203">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/image-get-resp.json"/>
|
|
</wadl:doc>
|
|
&x-compute-request-idHeader;
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:image">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/image-get-resp.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
<!-- Common and GET Faults--> &commonFaults; &getFaults;
|
|
</method>
|
|
<method name="DELETE" id="deleteImage">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete image">
|
|
<para role="shortdesc">Deletes a specified image.</para>
|
|
</wadl:doc>
|
|
<response status="204"/>
|
|
<!-- Common and GET Faults --> &commonFaults; &getFaults;
|
|
</method>
|
|
<!-- Metadata -->
|
|
<method name="GET" id="showServerMetadata">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" title="Show server metadata">
|
|
<para role="shortdesc">Shows metadata for a specified server.</para>
|
|
</wadl:doc>
|
|
<response status="200 203">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-metadata-all-resp.json"/>
|
|
</wadl:doc>
|
|
&x-compute-request-idHeader;
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:metadata">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-metadata-all-resp.xml"/>
|
|
</wadl:doc>
|
|
<param name="next" style="plain" type="xsd:anyURI"
|
|
path="/csapi:metadata/atom:link[@rel='next']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Moves to the next metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#ServerMetadataDetails" rel="next"/>
|
|
</param>
|
|
<param name="previous" style="plain" type="xsd:anyURI"
|
|
path="/csapi:metadata/atom:link[@rel='previous']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Moves to the previous metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#ServerMetadataDetails" rel="previous"/>
|
|
</param>
|
|
</representation>
|
|
</response>
|
|
<!-- Common Faults and GET Faults--> &commonFaults; &getFaults;
|
|
</method>
|
|
<method name="GET" id="showImageMetadata">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" title="Show image metadata">
|
|
<para role="shortdesc">Shows metadata for a specified image.</para>
|
|
</wadl:doc>
|
|
<response status="200 203">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/image-metadata-get-resp.json"/>
|
|
</wadl:doc>
|
|
&x-compute-request-idHeader;
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:metadata">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/image-metadata-get-resp.xml"/>
|
|
</wadl:doc>
|
|
<param name="next" style="plain" type="xsd:anyURI"
|
|
path="/csapi:metadata/atom:link[@rel='next']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Moves to the next metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#ServerMetadataDetails" rel="next"/>
|
|
</param>
|
|
<param name="previous" style="plain" type="xsd:anyURI"
|
|
path="/csapi:metadata/atom:link[@rel='previous']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Moves to the previous metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#ServerMetadataDetails" rel="previous"/>
|
|
</param>
|
|
</representation>
|
|
</response>
|
|
<!-- Common Faults and GET Faults--> &commonFaults; &getFaults;
|
|
</method>
|
|
<method name="POST" id="updateServerMetadata">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
|
title="Update server metadata items">
|
|
<para role="shortdesc">Updates metadata items by key for a specified server.</para>
|
|
<para>Replaces items that match the specified keys and does not modify items not
|
|
specified in the request.
|
|
</para>
|
|
<para>
|
|
If this operation exceeds the metadata items quota,
|
|
the API throws an <code>overLimit (413)</code> fault.
|
|
</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-metadata-req.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:metadata">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-metadata-req.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="200">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-metadata-resp.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:metadata">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-metadata-resp.xml"/>
|
|
</wadl:doc>
|
|
<param name="next" style="plain" type="xsd:anyURI"
|
|
path="/csapi:metadata/atom:link[@rel='next']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Moves to the next metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#ServerMetadataDetails" rel="next"/>
|
|
</param>
|
|
<param name="previous" style="plain" type="xsd:anyURI"
|
|
path="/csapi:metadata/atom:link[@rel='previous']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Moves to the previous metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#ServerMetadataDetails" rel="previous"/>
|
|
</param>
|
|
</representation>
|
|
</response>
|
|
<!-- Common, GET, POST/PUT, inProgress Faults--> &commonFaults; &getFaults; &postPutFaults;
|
|
&inProgressFault;
|
|
</method>
|
|
<method name="POST" id="updateImageMetadata">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
|
title="Update image metadata items">
|
|
<para role="shortdesc">Updates metadata items by key for a specified image.</para>
|
|
<para>Replaces items that match the specified keys and does not modify items not
|
|
specified in the request.
|
|
</para>
|
|
<para>
|
|
If this operation exceeds the metadata items quota,
|
|
the API throws an <code>overLimit (413)</code> fault.
|
|
</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/image-metadata-post-req.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:metadata">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/image-metadata-post-req.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="200">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/image-metadata-post-resp.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:metadata">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/image-metadata-post-resp.xml"/>
|
|
</wadl:doc>
|
|
<param name="next" style="plain" type="xsd:anyURI"
|
|
path="/csapi:metadata/atom:link[@rel='next']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Moves to the next metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#ImageMetadataDetails" rel="next"/>
|
|
</param>
|
|
<param name="previous" style="plain" type="xsd:anyURI"
|
|
path="/csapi:metadata/atom:link[@rel='previous']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Moves to the previous metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#ImageMetadataDetails" rel="previous"/>
|
|
</param>
|
|
</representation>
|
|
</response>
|
|
<!-- Common, GET, POST/PUT, inProgress Faults--> &commonFaults; &getFaults; &postPutFaults;
|
|
&inProgressFault;
|
|
</method>
|
|
<method name="PUT" id="createServerMetadata">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
|
title="Create or replace server metadata items">
|
|
<para role="shortdesc">Creates or replaces metadata items for a specified server.</para>
|
|
<para>All existing metadata items are removed and completely replaced by the metadata
|
|
items in the request.
|
|
</para>
|
|
<para>
|
|
If this operation exceeds the metadata items quota,
|
|
the API throws an <code>overLimit (413)</code> fault.
|
|
</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-metadata-req.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:metadata">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-metadata-req.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="200">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-metadata-resp.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:metadata">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-metadata-resp.xml"/>
|
|
</wadl:doc>
|
|
<param name="next" style="plain" type="xsd:anyURI"
|
|
path="/csapi:metadata/atom:link[@rel='next']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Moves to the next metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#ServerMetadataDetails" rel="next"/>
|
|
</param>
|
|
<param name="previous" style="plain" type="xsd:anyURI"
|
|
path="/csapi:metadata/atom:link[@rel='previous']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Moves to the previous metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#ServerMetadataDetails" rel="previous"/>
|
|
</param>
|
|
</representation>
|
|
</response>
|
|
<!-- Common, GET, POST/PUT, inProgress Faults--> &commonFaults; &getFaults; &postPutFaults;
|
|
&inProgressFault;
|
|
</method>
|
|
<method name="PUT" id="createImageMetadata">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
|
title="Create or replace image metadata">
|
|
<para role="shortdesc">Creates or replaces metadata for a specified image.</para>
|
|
<para>Replaces items that match the specified keys. If you omit a key that already
|
|
exists, this key retains its value.
|
|
</para>
|
|
<para>
|
|
If this operation exceeds the metadata items quota,
|
|
the API throws an <code>overLimit (413)</code> fault.
|
|
</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/image-metadata-put-req.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:metadata">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/image-metadata-put-req.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="200">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/image-metadata-put-resp.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:metadata">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/image-metadata-put-resp.xml"/>
|
|
</wadl:doc>
|
|
<param name="next" style="plain" type="xsd:anyURI"
|
|
path="/csapi:metadata/atom:link[@rel='next']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Moves to the next metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#ImageMetadataDetails" rel="next"/>
|
|
</param>
|
|
<param name="previous" style="plain" type="xsd:anyURI"
|
|
path="/csapi:metadata/atom:link[@rel='previous']/@href">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Moves to the previous metadata item.
|
|
</para>
|
|
</wadl:doc>
|
|
<link resource_type="#ImageMetadataDetails" rel="previous"/>
|
|
</param>
|
|
</representation>
|
|
</response>
|
|
<!-- Common, GET, POST/PUT, inProgress Faults--> &commonFaults; &getFaults; &postPutFaults;
|
|
&inProgressFault;
|
|
</method>
|
|
<method name="GET" id="getServerMetadataItem">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
|
title="Show server metadata item details">
|
|
<para role="shortdesc">Shows details for a metadata item by key for a specified
|
|
server.
|
|
</para>
|
|
</wadl:doc>
|
|
<response status="200 203">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-metadata-resp.json"/>
|
|
</wadl:doc>
|
|
&x-compute-request-idHeader;
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:meta">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-metadata-resp.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
<!-- Common Faults and GET Faults--> &commonFaults; &getFaults;
|
|
</method>
|
|
<method name="GET" id="getImageMetadataItem">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
|
title="Show image metadata item details">
|
|
<para role="shortdesc">Shows details for a metadata item by key for a specified
|
|
image.
|
|
</para>
|
|
</wadl:doc>
|
|
<response status="200 203">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/image-metadata-get-resp.json"/>
|
|
</wadl:doc>
|
|
&x-compute-request-idHeader;
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:meta">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/image-metadata-get-resp.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
<!-- Common Faults and GET Faults--> &commonFaults; &getFaults;
|
|
</method>
|
|
<method name="PUT" id="setServerMetadataItem">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
|
title="Create or update server metadata item">
|
|
<para role="shortdesc">Sets a metadata item by key for a specified server.</para>
|
|
<para>
|
|
If this operation exceeds the metadata items quota,
|
|
the API throws an <code>overLimit (413)</code> fault.
|
|
</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-metadata-req.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:meta">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-metadata-req.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="200">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-metadata-resp.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:meta">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/server-metadata-resp.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
<!-- Common, GET, POST/PUT, inProgress Faults--> &commonFaults; &getFaults; &postPutFaults;
|
|
&inProgressFault;
|
|
</method>
|
|
<method name="PUT" id="setImageMetadataItem">
|
|
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
|
title="Create or update image metadata item">
|
|
<para role="shortdesc">Creates or updates a metadata item by key for a specified
|
|
image.
|
|
</para>
|
|
<para>
|
|
If this operation exceeds the metadata items quota,
|
|
the API throws an <code>overLimit (413)</code> fault.
|
|
</para>
|
|
</wadl:doc>
|
|
<request>
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/image-metadata-put-req.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:meta">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/image-metadata-put-req.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</request>
|
|
<response status="200">
|
|
<representation mediaType="application/json">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/image-metadata-put-resp.json"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
<representation mediaType="application/xml" element="csapi:meta">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<xsdxt:code href="../api_samples/image-metadata-put-resp.xml"/>
|
|
</wadl:doc>
|
|
</representation>
|
|
</response>
|
|
<!-- Common, GET, POST/PUT, inProgress Faults--> &commonFaults; &getFaults; &postPutFaults;
|
|
&inProgressFault;
|
|
</method>
|
|
<method name="DELETE" id="deleteServerMetadataItem">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
|
title="Delete server metadata item">
|
|
<para role="shortdesc">Deletes a metadata item by key for a specified server.</para>
|
|
</wadl:doc>
|
|
<response status="204"/>
|
|
<!-- Common, GET, inProgress Faults--> &commonFaults; &getFaults; &inProgressFault;
|
|
</method>
|
|
<method name="DELETE" id="deleteImageMetadataItem">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
|
title="Delete image metadata item">
|
|
<para role="shortdesc">Deletes a metadata item by key for a specified image.</para>
|
|
</wadl:doc>
|
|
<response status="204"/>
|
|
<!-- Common, GET, inProgress Faults--> &commonFaults; &getFaults; &inProgressFault;
|
|
</method>
|
|
</application>
|