openstack/api-site
Code Issues Proposed changes

Merge "Remove config-drive and server-usage section in v2.1 compute API doc"

Browse Source
This commit is contained in:
Jenkins 2015-10-22 15:55:12 +00:00 committed by Gerrit Code Review
commit 2bca9af37a
29 changed files with 3260 additions and 1285 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

395
api-ref/src/docbkx/ch_compute-v2.1.xml
View File

@ -12,65 +12,70 @@
version="5.0-extension RackBook-2.0"
xml:id="compute-v2.1"
role="api-reference">
<title>Compute API (CURRENT)</title>
<note>
<title>Compute API (CURRENT)</title>
<note>
<para>
Effective in the OpenStack Kilo release, XML support in requests and
responses was removed for the Compute API.
</para>
</note>
<para>
</note>
<para>
This documentation supports the API v2.1 base version. If all extensions
are enabled, the Compute API v1.1 and v2.0 requests and responses match
the API v2.1 requests and responses.
</para>
<para>
</para>
<para>
Each API version lists its required extensions for the full request and
responses to be available. API v2.1 must enable all extensions all the
time. It uses micro-version headers to expose any additional
functionality.
<!-- TODO - link for more details... -->
</para>
<para>
This page lists the Compute API operations in the following order:</para>
<itemizedlist role="compact">
<listitem>
<para>
<link
xlink:href="http://developer.openstack.org/api-ref-compute-v2.1.html#versions-v2.1">Versions</link>
</para>
</listitem>
<listitem>
<para>
<link
xlink:href="http://developer.openstack.org/api-ref-compute-v2.1.html#os-compute-v2.1">Servers</link>
</para>
</listitem>
<listitem>
<para>
<link
xlink:href="http://developer.openstack.org/api-ref-compute-v2.1.html#os-flavors">Flavors</link>
</para>
</listitem>
<listitem>
<para>
<link
xlink:href="http://developer.openstack.org/api-ref-compute-v2.1.html#keypairs-v2.1">Keypairs</link>
</para>
</listitem>
<listitem>
<para>
<link
xlink:href="http://developer.openstack.org/api-ref-compute-v2.1.html#limits-v2.1">Limits</link>
</para>
</listitem>
<listitem>
<para>
<link xlink:href="http://developer.openstack.org/api-ref-compute-v2.1.html#extensions-v2.1">Extensions</link> in alphabetical order by resource
</para>
</listitem>
</itemizedlist>
<section xml:id="versions-v2.1">
</para>
<para>
This page lists the Compute API operations in the following order:</para>
<itemizedlist role="compact">
<listitem>
<para>
<link
xlink:href="http://developer.openstack.org/api-ref-compute-v2.1.html#versions-v2.1">Versions</link>
</para>
</listitem>
<listitem>
<para>
<link
xlink:href="http://developer.openstack.org/api-ref-compute-v2.1.html#os-servers-v2.1">Servers</link>
</para>
</listitem>
<listitem>
<para>
<link
xlink:href="http://developer.openstack.org/api-ref-compute-v2.1.html#os-flavors-v2.1">Flavors</link>
</para>
</listitem>
<listitem>
<para>
<link xlink:href="http://developer.openstack.org/api-ref-compute-v2.1.html#compute_images-v2.1">Images</link>
</para>
</listitem>
<listitem>
<para>
<link
xlink:href="http://developer.openstack.org/api-ref-compute-v2.1.html#keypairs-v2.1">Keypairs</link>
</para>
</listitem>
<listitem>
<para>
<link
xlink:href="http://developer.openstack.org/api-ref-compute-v2.1.html#limits-v2.1">Limits</link>
</para>
</listitem>
<listitem>
<para>
<link xlink:href="http://developer.openstack.org/api-ref-compute-v2.1.html#extensions-v2.1">Extensions</link> in alphabetical order by resource
</para>
</listitem>
</itemizedlist>
<section xml:id="versions-v2.1">
<title>API versions</title>
<para>
Lists information for all API versions.
@ -81,8 +86,8 @@
<wadl:method href="#listVersionsv2.1"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="os-servers-v2.1">
</section>
<section xml:id="os-servers-v2.1">
<title>Servers</title>
<para>Lists, creates, gets details for, updates, and deletes servers.</para>
<para><emphasis role="bold">Passwords</emphasis></para>
@ -212,8 +217,8 @@
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/compute-api/src/v2.1/wadl/os-compute-2.1.wadl"/>
</section>
<section xml:id="os-multiple-create-v2.1">
</section>
<section xml:id="os-multiple-create-v2.1">
<title>Servers multiple create (servers)</title>
<para>
Creates one or more servers with an optional reservation ID. The
@ -223,28 +228,63 @@
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-multiple-create-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-server-actions-v2.1">
</section>
<section xml:id="os-server-actions-v2.1">
<title>Servers actions (servers, action)</title>
<para>
Performs actions on a server. Specify the action in the request body.
Performs actions on a server. Specify the action in the request body.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-server-actions-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-server-actions-add-v2.1">
<title>Servers action (servers, os-server-actions)</title>
<para>
Permits all users to list available server actions for a specified
server. Permits administrators to get details for a specified
server action for a specified server.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-server-actions-add-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-admin-actions-v2.1">
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/compute-api/src/v2.1/wadl/os-multinic-v2.1.wadl#action">
<wadl:method href="#addFixedIpServer"/>
</wadl:resource>
<wadl:resource href="../wadls/compute-api/src/v2.1/wadl/os-server-actions-v2.1.wadl#action">
<wadl:method href="#attachVolume"/>
<wadl:method href="#confirmResizeServer"/>
<wadl:method href="#createImage"/>
</wadl:resource>
<wadl:resource href="../wadls/compute-api/src/v2.1/wadl/os-remote-consoles-v2.1.wadl#action">
<wadl:method href="#get_spice_consoleServer"/>
<wadl:method href="#get_vnc_consoleServer"/>
</wadl:resource>
<wadl:resource href="../wadls/compute-api/src/v2.1/wadl/os-evacuate-v2.1.wadl#action">
<wadl:method href="#evacuateServer"/>
</wadl:resource>
<wadl:resource href="../wadls/compute-api/src/v2.1/wadl/os-deferred-delete-v2.1.wadl#action">
<wadl:method href="#forceDeleteServer"/>
</wadl:resource>
<wadl:resource href="../wadls/compute-api/src/v2.1/wadl/os-server-actions-v2.1.wadl#action">
<wadl:method href="#rebootServer"/>
<wadl:method href="#rebuildServer"/>
</wadl:resource>
<wadl:resource href="../wadls/compute-api/src/v2.1/wadl/os-multinic-v2.1.wadl#action">
<wadl:method href="#remove_fixed_ipServer"/>
</wadl:resource>
<wadl:resource href="../wadls/compute-api/src/v2.1/wadl/os-server-actions-v2.1.wadl#action">
<wadl:method href="#rescueServer"/>
<wadl:method href="#resizeServer"/>
</wadl:resource>
<wadl:resource href="../wadls/compute-api/src/v2.1/wadl/os-deferred-delete-v2.1.wadl#action">
<wadl:method href="#restoreServer"/>
</wadl:resource>
<wadl:resource href="../wadls/compute-api/src/v2.1/wadl/os-server-actions-v2.1.wadl#action">
<wadl:method href="#revertResizeServer"/>
</wadl:resource>
<wadl:resource href="../wadls/compute-api/src/v2.1/wadl/os-shelve-v2.1.wadl#action">
<wadl:method href="#shelveServer"/>
<wadl:method href="#shelveOffloadServer"/>
</wadl:resource>
<wadl:resource href="../wadls/compute-api/src/v2.1/wadl/os-server-actions-v2.1.wadl#action">
<wadl:method href="#os-startServer"/>
<wadl:method href="#os-stopServer"/>
<wadl:method href="#unrescueServer"/>
</wadl:resource>
<wadl:resource href="../wadls/compute-api/src/v2.1/wadl/os-shelve-v2.1.wadl#action">
<wadl:method href="#unshelveServer"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="os-admin-actions-v2.1">
<title>Servers admin actions (servers, action)</title>
<para>
Administrators only. Performs actions on a server. Specify the action
@ -253,97 +293,8 @@
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-admin-actions-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-admin-password-v2.1">
<title>Servers admin password (servers, action)</title>
<para>
Enables users with the administrative role or the owner of the server
to change the password of the administrative user.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-admin-password-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-console-output-v2.1">
<title>Servers console output (servers, action)</title>
<para>
Gets console output for a server instance.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/compute-api/src/v2.1/wadl/os-console-output-v2.1.wadl"
/>
</section>
<section xml:id="os-multinic-v2.1">
<title>Servers multiple fixed IP support (servers, action)</title>
<para>
Adds or removes fixed IP addresses from an instance.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-multinic-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-remote-consoles-v2.1">
<title>Servers remote console (servers, action)</title>
<para>
Provides interactive console support.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-remote-consoles-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-shelve-v2.1">
<title>Servers shelve (servers, action)</title>
<para>
Shelves servers, restores shelved servers, and removes
shelved servers.
</para>
<para>
Shelving is useful when you have an unused instance that you would
like to keep for later use. For example, at the end of a work week
you can shelve an instance and at the start of the next week you can
unshelve it.
</para>
<para>
Your cloud provider might bill you for a shelved server.
</para>
<para>
Use the <code>shelve</code> action to shelve a server. All
associated data and resources are kept but anything still in memory
is not retained.
</para>
<para>
Use the <code>unshelve</code> action to restore a shelved instance.
</para>
<para>
Use the <code>shelveOffload</code> action to remove a shelved
instance that you no longer need.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-shelve-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-deferred-delete-v2.1">
<title>Servers deferred delete (servers, action)</title>
<para>
Force-deletes a server or restores a soft-deleted server.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-deferred-delete-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-evacuate-v2.1">
<title>Servers evacuate (servers, action)</title>
<para>
Evacuates servers.
</para>
<para>
Specify the <code>evacuate</code> action in the request body.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-evacuate-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="diagnostics-v2.1">
</section>
<section xml:id="diagnostics-v2.1">
<title>Servers diagnostics (servers, diagnostics)</title>
<para>
Gets the usage data for a server.
@ -351,8 +302,8 @@
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/diagnostics-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="server-ips-v2.1">
</section>
<section xml:id="server-ips-v2.1">
<title>Servers IPs (servers, ips)</title>
<para>
Lists the IP addresses assigned to an instance or shows details for
@ -361,8 +312,8 @@
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/server-ips-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="server-metadata-v2.1">
</section>
<section xml:id="server-metadata-v2.1">
<title>Server metadata (servers, metadata)</title>
<para>
Lists metadata, creates or replaces one or more metadata
@ -375,18 +326,19 @@
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/server-metadata-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-config-drive-v2.1">
<title>Servers configuration drive (servers, os-config-drive)</title>
</section>
<section xml:id="os-server-actions-add-v2.1">
<title>Servers list actions (servers, os-server-actions)</title>
<para>
Shows server details including configuration drive information for a
specified server ID or user.
Permits all users to list available server actions for a specified
server. Permits administrators to get details for a specified server
action for a specified server.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-config-drive-v2.1.wadl"
href="../wadls/compute-api/src/v2.1/wadl/os-server-actions-add-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-server-password-v2.1">
</section>
<section xml:id="os-server-password-v2.1">
<title>Servers password (servers, os-server-password)</title>
<para>
Gets the encrypted administrative password set through the metadata
@ -395,29 +347,8 @@
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-server-password-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-server-usage-v2.1">
<title>Servers usage (servers, os-server-usage)</title>
<para>
Lists all servers and shows server details. Includes server usage
information.
</para>
<para>
Shows <code>OS-SRV-USG:launched_at</code> and <code>OS-SRV-
USG:terminated_at</code> attributes in server responses.
</para>
<para>
To hide <code>addresses</code> information for instances in a
specified state, set the
<code>osapi_hide_server_address_states</code> configuration option.
Set this option to a valid VM state in the <code>nova.conf</code>
configuration file.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-server-usage-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-virtual-interfaces-v2.1">
</section>
<section xml:id="os-virtual-interfaces-v2.1">
<title>Servers virtual interfaces (servers, os-virtual-interfaces)</title>
<para>
Lists virtual interfaces for a specified server instance.
@ -425,8 +356,8 @@
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-virtual-interfaces-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-flavors-v2.1">
</section>
<section xml:id="os-flavors-v2.1">
<title>Flavors with extended attributes (flavors)</title>
<para>
Shows information about flavors.
@ -434,8 +365,8 @@
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-flavors-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-flavor-access-v2.1">
</section>
<section xml:id="os-flavor-access-v2.1">
<title>Flavors access (flavors, os-flavor-access, action)</title>
<para>
Provides flavor access support.
@ -456,8 +387,8 @@
<wadl:method href="#list-flavor-accesslist-detail"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="flavor-extra-specs-v2.1">
</section>
<section xml:id="flavor-extra-specs-v2.1">
<title>Flavors extra-specs (flavors, os-flavor-extra-specs)</title>
<para>
Lists, creates, deletes, and updates the extra-specs or keys for a
@ -466,8 +397,8 @@
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-flavor-extra-specs-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-flavor-manage-v2.1">
</section>
<section xml:id="os-flavor-manage-v2.1">
<title>Flavors manage (flavors, os-flavor-manage)</title>
<para>
Creates and deletes flavors.
@ -475,33 +406,8 @@
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-flavor-manage-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="keypairs-v2.1">
<title>Keypairs (keypairs)</title>
<para>Generates, imports, and deletes SSH keys.</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/keypairs-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="limits-v2.1">
<title>Limits (limits)</title>
<para>
Shows all global and rate limit information.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/limits-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="extensions-v2.1">
<title>Extensions (extensions)</title>
<para>
Available extensions.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-extensions-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="compute_images-v2.1">
</section>
<section xml:id="images-v2.1">
<title>Images</title>
<para>
Lists, gets details for, and deletes images. Also sets, lists,
@ -531,7 +437,7 @@
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="compute_image_metadata-v2.1">
<section xml:id="images-metadata-v2.1">
<title>Image metadata</title>
<para>Shows details for, sets, updates, and deletes image metadata or metadata items.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
@ -548,6 +454,31 @@
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="keypairs-v2.1">
<title>Keypairs (keypairs)</title>
<para>Generates, imports, and deletes SSH keys.</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/keypairs-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="limits-v2.1">
<title>Limits (limits)</title>
<para>
Shows all global and rate limit information.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/limits-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="extensions-v2.1">
<title>Extensions (extensions)</title>
<para>
Available extensions.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-extensions-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-agents-v2.1">
<title>Guest agents (os-agents)</title>
<para>

53
api-ref/src/wadls/common_project.ent
View File

@ -227,6 +227,32 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY updatedResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="updated" style="plain"
required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The date and time when the server was updated.
</para>
<para>
The date and time stamp format is <link
xlink:href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</link>:
</para>
<programlisting>CCYY-MM-DDThh:mm:ss±hh:mm</programlisting>
<para>
The <code>±hh:mm</code> value, if included, is the time zone as an
offset from UTC.
</para>
<para>
For example, <code>2015-08-27T09:49:58-05:00</code>.
</para>
<para>
The UTC time zone is assumed.
</para>
</wadl:doc>
</param>'>
<!-- ISO 8601 response parameters -->
<!ENTITY created_at-ResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="created_at" style="plain" required="true"
@ -254,6 +280,33 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY createdResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="created" style="plain" required="true"
type="xsd:dateTime">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The date and time when the server, image, or backup was created.
</para>
<para>
The date and time stamp format is <link
xlink:href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</link>:
</para>
<programlisting>CCYY-MM-DDThh:mm:ss±hh:mm</programlisting>
<para>
For example, <code>2015-08-27T09:49:58-05:00</code>.
</para>
<para>
The <code>±hh:mm</code> value, if included, is the time zone as an offset from UTC.
</para>
<para>
If the <code>updated_at</code> date and time stamp is not set, its value is
<code>null</code>.
</para>
</wadl:doc>
</param>'>
<!ENTITY Date-ResponseHeader '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Date" style="header" required="true"

804
api-ref/src/wadls/compute-api/src/v2.1/api_samples/all_extensions/extensions-list-resp-v2.json Normal file
View File

@ -0,0 +1,804 @@
{
"extensions": [
{
"alias": "NMN",
"description": "Multiple network support.",
"links": [],
"name": "Multinic",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-DCF",
"description": "Disk Management Extension.",
"links": [],
"name": "DiskConfig",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-EXT-AZ",
"description": "Extended Availability Zone support.",
"links": [],
"name": "ExtendedAvailabilityZone",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-EXT-IMG-SIZE",
"description": "Adds image size to image listings.",
"links": [],
"name": "ImageSize",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-EXT-IPS",
"description": "",
"links": [],
"name": "ExtendedIps",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-EXT-IPS-MAC",
"description": "",
"links": [],
"name": "ExtendedIpsMac",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-EXT-SRV-ATTR",
"description": "Extended Server Attributes support.",
"links": [],
"name": "ExtendedServerAttributes",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-EXT-STS",
"description": "",
"links": [],
"name": "ExtendedStatus",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-EXT-VIF-NET",
"description": "",
"links": [],
"name": "ExtendedVIFNet",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-FLV-DISABLED",
"description": "",
"links": [],
"name": "FlavorDisabled",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-FLV-EXT-DATA",
"description": "",
"links": [],
"name": "FlavorExtraData",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-SCH-HNT",
"description": "Pass arbitrary key/value pairs to the scheduler.",
"links": [],
"name": "SchedulerHints",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-SRV-USG",
"description": "Adds launched_at and terminated_at on Servers.",
"links": [],
"name": "ServerUsage",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-access-ips",
"description": "Access IPs support.",
"links": [],
"name": "AccessIPs",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-admin-actions",
"description": "Enable admin-only server actions\n\n Actions include: resetNetwork, injectNetworkInfo, os-resetState\n ",
"links": [],
"name": "AdminActions",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-admin-password",
"description": "Admin password management support.",
"links": [],
"name": "AdminPassword",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-agents",
"description": "Agents support.",
"links": [],
"name": "Agents",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-aggregates",
"description": "Admin-only aggregate administration.",
"links": [],
"name": "Aggregates",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-assisted-volume-snapshots",
"description": "Assisted volume snapshots.",
"links": [],
"name": "AssistedVolumeSnapshots",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-attach-interfaces",
"description": "Attach interface support.",
"links": [],
"name": "AttachInterfaces",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-availability-zone",
"description": "1. Add availability_zone to the Create Server API.\n 2. Add availability zones describing.\n ",
"links": [],
"name": "AvailabilityZone",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-baremetal-ext-status",
"description": "",
"links": [],
"name": "BareMetalExtStatus",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-baremetal-nodes",
"description": "Admin-only bare-metal node administration.",
"links": [],
"name": "BareMetalNodes",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-block-device-mapping",
"description": "Block device mapping boot support.",
"links": [],
"name": "BlockDeviceMapping",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-block-device-mapping-v2-boot",
"description": "",
"links": [],
"name": "BlockDeviceMappingV2Boot",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-cell-capacities",
"description": "",
"links": [],
"name": "CellCapacities",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-cells",
"description": "Enables cells-related functionality such as adding neighbor cells,\n listing neighbor cells, and getting the capabilities of the local cell.\n ",
"links": [],
"name": "Cells",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-certificates",
"description": "Certificates support.",
"links": [],
"name": "Certificates",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-cloudpipe",
"description": "Adds actions to create cloudpipe instances.\n\n When running with the Vlan network mode, you need a mechanism to route\n from the public Internet to your vlans. This mechanism is known as a\n cloudpipe.\n\n At the time of creating this class, only OpenVPN is supported. Support for\n a SSH Bastion host is forthcoming.\n ",
"links": [],
"name": "Cloudpipe",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-cloudpipe-update",
"description": "",
"links": [],
"name": "CloudpipeUpdate",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-config-drive",
"description": "Config Drive Extension.",
"links": [],
"name": "ConfigDrive",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-console-auth-tokens",
"description": "Console token authentication support.",
"links": [],
"name": "ConsoleAuthTokens",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-console-output",
"description": "Console log output support, with tailing ability.",
"links": [],
"name": "ConsoleOutput",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-consoles",
"description": "Interactive Console support.",
"links": [],
"name": "Consoles",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-create-backup",
"description": "Create a backup of a server.",
"links": [],
"name": "CreateBackup",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-create-server-ext",
"description": "",
"links": [],
"name": "Createserverext",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-deferred-delete",
"description": "Instance deferred delete.",
"links": [],
"name": "DeferredDelete",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-evacuate",
"description": "Enables server evacuation.",
"links": [],
"name": "Evacuate",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-extended-evacuate-find-host",
"description": "",
"links": [],
"name": "ExtendedEvacuateFindHost",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-extended-floating-ips",
"description": "",
"links": [],
"name": "ExtendedFloatingIps",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-extended-hypervisors",
"description": "",
"links": [],
"name": "ExtendedHypervisors",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-extended-networks",
"description": "",
"links": [],
"name": "ExtendedNetworks",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-extended-quotas",
"description": "",
"links": [],
"name": "ExtendedQuotas",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-extended-rescue-with-image",
"description": "",
"links": [],
"name": "ExtendedRescueWithImage",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-extended-services",
"description": "",
"links": [],
"name": "ExtendedServices",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-extended-services-delete",
"description": "",
"links": [],
"name": "ExtendedServicesDelete",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-extended-status",
"description": "Extended Status support.",
"links": [],
"name": "ExtendedStatus",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-extended-volumes",
"description": "Extended Volumes support.",
"links": [],
"name": "ExtendedVolumes",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-fixed-ips",
"description": "Fixed IPs support.",
"links": [],
"name": "FixedIPs",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-flavor-access",
"description": "Flavor access support.",
"links": [],
"name": "FlavorAccess",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-flavor-extra-specs",
"description": "Flavors extra specs support.",
"links": [],
"name": "FlavorExtraSpecs",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-flavor-manage",
"description": "Flavor create/delete API support.",
"links": [],
"name": "FlavorManage",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-flavor-rxtx",
"description": "Support to show the rxtx status of a flavor.",
"links": [],
"name": "FlavorRxtx",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-flavor-swap",
"description": "",
"links": [],
"name": "FlavorSwap",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-floating-ip-dns",
"description": "Floating IP DNS support.",
"links": [],
"name": "FloatingIpDns",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-floating-ip-pools",
"description": "Floating IPs support.",
"links": [],
"name": "FloatingIpPools",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-floating-ips",
"description": "Floating IPs support.",
"links": [],
"name": "FloatingIps",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-floating-ips-bulk",
"description": "Bulk handling of Floating IPs.",
"links": [],
"name": "FloatingIpsBulk",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-fping",
"description": "Fping Management Extension.",
"links": [],
"name": "Fping",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-hide-server-addresses",
"description": "Support hiding server addresses in certain states.",
"links": [],
"name": "HideServerAddresses",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-hosts",
"description": "Admin-only host administration.",
"links": [],
"name": "Hosts",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-hypervisor-status",
"description": "",
"links": [],
"name": "HypervisorStatus",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-hypervisors",
"description": "Admin-only hypervisor administration.",
"links": [],
"name": "Hypervisors",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-instance-actions",
"description": "View a log of actions and events taken on an instance.",
"links": [],
"name": "InstanceActions",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-instance_usage_audit_log",
"description": "Admin-only Task Log Monitoring.",
"links": [],
"name": "OSInstanceUsageAuditLog",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-keypairs",
"description": "Keypair Support.",
"links": [],
"name": "Keypairs",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-lock-server",
"description": "Enable lock/unlock server actions.",
"links": [],
"name": "LockServer",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-migrate-server",
"description": "Enable migrate and live-migrate server actions.",
"links": [],
"name": "MigrateServer",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-migrations",
"description": "Provide data on migrations.",
"links": [],
"name": "Migrations",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-multiple-create",
"description": "Allow multiple create in the Create Server v2.1 API.",
"links": [],
"name": "MultipleCreate",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-networks",
"description": "Admin-only Network Management Extension.",
"links": [],
"name": "Networks",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-networks-associate",
"description": "Network association support.",
"links": [],
"name": "NetworkAssociationSupport",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-pause-server",
"description": "Enable pause/unpause server actions.",
"links": [],
"name": "PauseServer",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-personality",
"description": "Personality support.",
"links": [],
"name": "Personality",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-preserve-ephemeral-rebuild",
"description": "Allow preservation of the ephemeral partition on rebuild.",
"links": [],
"name": "PreserveEphemeralOnRebuild",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-quota-class-sets",
"description": "Quota classes management support.",
"links": [],
"name": "QuotaClasses",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-quota-sets",
"description": "Quotas management support.",
"links": [],
"name": "Quotas",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-rescue",
"description": "Instance rescue mode.",
"links": [],
"name": "Rescue",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-security-group-default-rules",
"description": "Default rules for security group support.",
"links": [],
"name": "SecurityGroupDefaultRules",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-security-groups",
"description": "Security group support.",
"links": [],
"name": "SecurityGroups",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-server-diagnostics",
"description": "Allow Admins to view server diagnostics through server action.",
"links": [],
"name": "ServerDiagnostics",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-server-external-events",
"description": "Server External Event Triggers.",
"links": [],
"name": "ServerExternalEvents",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-server-group-quotas",
"description": "",
"links": [],
"name": "ServerGroupQuotas",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-server-groups",
"description": "Server group support.",
"links": [],
"name": "ServerGroups",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-server-list-multi-status",
"description": "",
"links": [],
"name": "ServerListMultiStatus",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-server-password",
"description": "Server password support.",
"links": [],
"name": "ServerPassword",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-server-sort-keys",
"description": "",
"links": [],
"name": "ServerSortKeys",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-server-start-stop",
"description": "",
"links": [],
"name": "ServerStartStop",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-services",
"description": "Services support.",
"links": [],
"name": "Services",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-shelve",
"description": "Instance shelve mode.",
"links": [],
"name": "Shelve",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-simple-tenant-usage",
"description": "Simple tenant usage extension.",
"links": [],
"name": "SimpleTenantUsage",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-suspend-server",
"description": "Enable suspend/resume server actions.",
"links": [],
"name": "SuspendServer",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-tenant-networks",
"description": "Tenant-based Network Management Extension.",
"links": [],
"name": "OSTenantNetworks",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-used-limits",
"description": "Provide data on limited resources that are being used.",
"links": [],
"name": "UsedLimits",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-used-limits-for-admin",
"description": "",
"links": [],
"name": "UsedLimitsForAdmin",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-user-data",
"description": "Add user_data to the Create Server API.",
"links": [],
"name": "UserData",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-user-quotas",
"description": "",
"links": [],
"name": "UserQuotas",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-virtual-interfaces",
"description": "Virtual interface support.",
"links": [],
"name": "VirtualInterfaces",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-volume-attachment-update",
"description": "",
"links": [],
"name": "VolumeAttachmentUpdate",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-volumes",
"description": "Volumes support.",
"links": [],
"name": "Volumes",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
}
]
}

804
api-ref/src/wadls/compute-api/src/v2.1/api_samples/all_extensions/extensions-list-resp-v21-compatible.json Normal file
View File

@ -0,0 +1,804 @@
{
"extensions": [
{
"alias": "NMN",
"description": "Multiple network support.",
"links": [],
"name": "Multinic",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-DCF",
"description": "Disk Management Extension.",
"links": [],
"name": "DiskConfig",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-EXT-AZ",
"description": "Extended Availability Zone support.",
"links": [],
"name": "ExtendedAvailabilityZone",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-EXT-IMG-SIZE",
"description": "Adds image size to image listings.",
"links": [],
"name": "ImageSize",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-EXT-IPS",
"description": "",
"links": [],
"name": "ExtendedIps",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-EXT-IPS-MAC",
"description": "",
"links": [],
"name": "ExtendedIpsMac",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-EXT-SRV-ATTR",
"description": "Extended Server Attributes support.",
"links": [],
"name": "ExtendedServerAttributes",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-EXT-STS",
"description": "",
"links": [],
"name": "ExtendedStatus",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-EXT-VIF-NET",
"description": "",
"links": [],
"name": "ExtendedVIFNet",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-FLV-DISABLED",
"description": "",
"links": [],
"name": "FlavorDisabled",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-FLV-EXT-DATA",
"description": "",
"links": [],
"name": "FlavorExtraData",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-SCH-HNT",
"description": "Pass arbitrary key/value pairs to the scheduler.",
"links": [],
"name": "SchedulerHints",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-SRV-USG",
"description": "Adds launched_at and terminated_at on Servers.",
"links": [],
"name": "ServerUsage",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-access-ips",
"description": "Access IPs support.",
"links": [],
"name": "AccessIPs",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-admin-actions",
"description": "Enable admin-only server actions\n\n Actions include: resetNetwork, injectNetworkInfo, os-resetState\n ",
"links": [],
"name": "AdminActions",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-admin-password",
"description": "Admin password management support.",
"links": [],
"name": "AdminPassword",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-agents",
"description": "Agents support.",
"links": [],
"name": "Agents",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-aggregates",
"description": "Admin-only aggregate administration.",
"links": [],
"name": "Aggregates",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-assisted-volume-snapshots",
"description": "Assisted volume snapshots.",
"links": [],
"name": "AssistedVolumeSnapshots",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-attach-interfaces",
"description": "Attach interface support.",
"links": [],
"name": "AttachInterfaces",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-availability-zone",
"description": "1. Add availability_zone to the Create Server API.\n 2. Add availability zones describing.\n ",
"links": [],
"name": "AvailabilityZone",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-baremetal-ext-status",
"description": "",
"links": [],
"name": "BareMetalExtStatus",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-baremetal-nodes",
"description": "Admin-only bare-metal node administration.",
"links": [],
"name": "BareMetalNodes",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-block-device-mapping",
"description": "Block device mapping boot support.",
"links": [],
"name": "BlockDeviceMapping",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-block-device-mapping-v2-boot",
"description": "",
"links": [],
"name": "BlockDeviceMappingV2Boot",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-cell-capacities",
"description": "",
"links": [],
"name": "CellCapacities",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-cells",
"description": "Enables cells-related functionality such as adding neighbor cells,\n listing neighbor cells, and getting the capabilities of the local cell.\n ",
"links": [],
"name": "Cells",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-certificates",
"description": "Certificates support.",
"links": [],
"name": "Certificates",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-cloudpipe",
"description": "Adds actions to create cloudpipe instances.\n\n When running with the Vlan network mode, you need a mechanism to route\n from the public Internet to your vlans. This mechanism is known as a\n cloudpipe.\n\n At the time of creating this class, only OpenVPN is supported. Support for\n a SSH Bastion host is forthcoming.\n ",
"links": [],
"name": "Cloudpipe",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-cloudpipe-update",
"description": "",
"links": [],
"name": "CloudpipeUpdate",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-config-drive",
"description": "Config Drive Extension.",
"links": [],
"name": "ConfigDrive",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-console-auth-tokens",
"description": "Console token authentication support.",
"links": [],
"name": "ConsoleAuthTokens",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-console-output",
"description": "Console log output support, with tailing ability.",
"links": [],
"name": "ConsoleOutput",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-consoles",
"description": "Interactive Console support.",
"links": [],
"name": "Consoles",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-create-backup",
"description": "Create a backup of a server.",
"links": [],
"name": "CreateBackup",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-create-server-ext",
"description": "",
"links": [],
"name": "Createserverext",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-deferred-delete",
"description": "Instance deferred delete.",
"links": [],
"name": "DeferredDelete",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-evacuate",
"description": "Enables server evacuation.",
"links": [],
"name": "Evacuate",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-extended-evacuate-find-host",
"description": "",
"links": [],
"name": "ExtendedEvacuateFindHost",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-extended-floating-ips",
"description": "",
"links": [],
"name": "ExtendedFloatingIps",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-extended-hypervisors",
"description": "",
"links": [],
"name": "ExtendedHypervisors",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-extended-networks",
"description": "",
"links": [],
"name": "ExtendedNetworks",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-extended-quotas",
"description": "",
"links": [],
"name": "ExtendedQuotas",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-extended-rescue-with-image",
"description": "",
"links": [],
"name": "ExtendedRescueWithImage",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-extended-services",
"description": "",
"links": [],
"name": "ExtendedServices",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-extended-services-delete",
"description": "",
"links": [],
"name": "ExtendedServicesDelete",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-extended-status",
"description": "Extended Status support.",
"links": [],
"name": "ExtendedStatus",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-extended-volumes",
"description": "Extended Volumes support.",
"links": [],
"name": "ExtendedVolumes",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-fixed-ips",
"description": "Fixed IPs support.",
"links": [],
"name": "FixedIPs",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-flavor-access",
"description": "Flavor access support.",
"links": [],
"name": "FlavorAccess",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-flavor-extra-specs",
"description": "Flavors extra specs support.",
"links": [],
"name": "FlavorExtraSpecs",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-flavor-manage",
"description": "Flavor create/delete API support.",
"links": [],
"name": "FlavorManage",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-flavor-rxtx",
"description": "Support to show the rxtx status of a flavor.",
"links": [],
"name": "FlavorRxtx",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-flavor-swap",
"description": "",
"links": [],
"name": "FlavorSwap",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-floating-ip-dns",
"description": "Floating IP DNS support.",
"links": [],
"name": "FloatingIpDns",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-floating-ip-pools",
"description": "Floating IPs support.",
"links": [],
"name": "FloatingIpPools",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-floating-ips",
"description": "Floating IPs support.",
"links": [],
"name": "FloatingIps",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-floating-ips-bulk",
"description": "Bulk handling of Floating IPs.",
"links": [],
"name": "FloatingIpsBulk",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-fping",
"description": "Fping Management Extension.",
"links": [],
"name": "Fping",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-hide-server-addresses",
"description": "Support hiding server addresses in certain states.",
"links": [],
"name": "HideServerAddresses",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-hosts",
"description": "Admin-only host administration.",
"links": [],
"name": "Hosts",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-hypervisor-status",
"description": "",
"links": [],
"name": "HypervisorStatus",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-hypervisors",
"description": "Admin-only hypervisor administration.",
"links": [],
"name": "Hypervisors",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-instance-actions",
"description": "View a log of actions and events taken on an instance.",
"links": [],
"name": "InstanceActions",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-instance_usage_audit_log",
"description": "Admin-only Task Log Monitoring.",
"links": [],
"name": "OSInstanceUsageAuditLog",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-keypairs",
"description": "Keypair Support.",
"links": [],
"name": "Keypairs",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-lock-server",
"description": "Enable lock/unlock server actions.",
"links": [],
"name": "LockServer",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-migrate-server",
"description": "Enable migrate and live-migrate server actions.",
"links": [],
"name": "MigrateServer",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-migrations",
"description": "Provide data on migrations.",
"links": [],
"name": "Migrations",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-multiple-create",
"description": "Allow multiple create in the Create Server v2.1 API.",
"links": [],
"name": "MultipleCreate",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-networks",
"description": "Admin-only Network Management Extension.",
"links": [],
"name": "Networks",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-networks-associate",
"description": "Network association support.",
"links": [],
"name": "NetworkAssociationSupport",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-pause-server",
"description": "Enable pause/unpause server actions.",
"links": [],
"name": "PauseServer",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-personality",
"description": "Personality support.",
"links": [],
"name": "Personality",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-preserve-ephemeral-rebuild",
"description": "Allow preservation of the ephemeral partition on rebuild.",
"links": [],
"name": "PreserveEphemeralOnRebuild",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-quota-class-sets",
"description": "Quota classes management support.",
"links": [],
"name": "QuotaClasses",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-quota-sets",
"description": "Quotas management support.",
"links": [],
"name": "Quotas",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-rescue",
"description": "Instance rescue mode.",
"links": [],
"name": "Rescue",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-security-group-default-rules",
"description": "Default rules for security group support.",
"links": [],
"name": "SecurityGroupDefaultRules",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-security-groups",
"description": "Security group support.",
"links": [],
"name": "SecurityGroups",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-server-diagnostics",
"description": "Allow Admins to view server diagnostics through server action.",
"links": [],
"name": "ServerDiagnostics",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-server-external-events",
"description": "Server External Event Triggers.",
"links": [],
"name": "ServerExternalEvents",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-server-group-quotas",
"description": "",
"links": [],
"name": "ServerGroupQuotas",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-server-groups",
"description": "Server group support.",
"links": [],
"name": "ServerGroups",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-server-list-multi-status",
"description": "",
"links": [],
"name": "ServerListMultiStatus",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-server-password",
"description": "Server password support.",
"links": [],
"name": "ServerPassword",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-server-sort-keys",
"description": "",
"links": [],
"name": "ServerSortKeys",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-server-start-stop",
"description": "",
"links": [],
"name": "ServerStartStop",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-services",
"description": "Services support.",
"links": [],
"name": "Services",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-shelve",
"description": "Instance shelve mode.",
"links": [],
"name": "Shelve",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-simple-tenant-usage",
"description": "Simple tenant usage extension.",
"links": [],
"name": "SimpleTenantUsage",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-suspend-server",
"description": "Enable suspend/resume server actions.",
"links": [],
"name": "SuspendServer",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-tenant-networks",
"description": "Tenant-based Network Management Extension.",
"links": [],
"name": "OSTenantNetworks",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-used-limits",
"description": "Provide data on limited resources that are being used.",
"links": [],
"name": "UsedLimits",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-used-limits-for-admin",
"description": "",
"links": [],
"name": "UsedLimitsForAdmin",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-user-data",
"description": "Add user_data to the Create Server API.",
"links": [],
"name": "UserData",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-user-quotas",
"description": "",
"links": [],
"name": "UserQuotas",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-virtual-interfaces",
"description": "Virtual interface support.",
"links": [],
"name": "VirtualInterfaces",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-volume-attachment-update",
"description": "",
"links": [],
"name": "VolumeAttachmentUpdate",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "os-volumes",
"description": "Volumes support.",
"links": [],
"name": "Volumes",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
}
]
}

8
api-ref/src/wadls/compute-api/src/v2.1/api_samples/all_extensions/extensions-list-resp.json
View File

@ -64,14 +64,6 @@
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-EXT-VIF-NET",
"description": "",
"links": [],
"name": "ExtendedVIFNet",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
},
{
"alias": "OS-FLV-DISABLED",
"description": "",

2
api-ref/src/wadls/compute-api/src/v2.1/api_samples/all_extensions/server-action-rebuild-resp.json
View File

@ -35,7 +35,7 @@
},
"links": [
{
"href": "http://openstack.example.com/v2.1/openstack/servers/27568e59-cfb7-4283-a00e-4af933f2d539",
"href": "http://openstack.example.com/v2/openstack/servers/27568e59-cfb7-4283-a00e-4af933f2d539",
"rel": "self"
},
{

2
api-ref/src/wadls/compute-api/src/v2.1/api_samples/all_extensions/server-action-rebuild.json
View File

@ -1,6 +1,6 @@
{
"rebuild": {
"imageRef": "http://openstack.example.com/v2.1/32278/images/70a599e0-31e7-49b7-b260-868f441e862b",
"imageRef": "http://openstack.example.com/v2/32278/images/70a599e0-31e7-49b7-b260-868f441e862b",
"name": "foobar",
"adminPass": "seekr3t",
"accessIPv4": "1.2.3.4",

8
api-ref/src/wadls/compute-api/src/v2.1/api_samples/all_extensions/server-get-resp.json
View File

@ -15,7 +15,7 @@
"id": "1",
"links": [
{
"href": "http://openstack.example.com/flavors/1",
"href": "http://openstack.example.com/openstack/flavors/1",
"rel": "bookmark"
}
]
@ -26,7 +26,7 @@
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
@ -34,7 +34,7 @@
"key_name": null,
"links": [
{
"href": "http://openstack.example.com/v2.1/openstack/servers/f474386b-4fb6-4e1f-b1d5-d6bf4437f7d5",
"href": "http://openstack.example.com/v2/openstack/servers/f474386b-4fb6-4e1f-b1d5-d6bf4437f7d5",
"rel": "self"
},
{
@ -48,7 +48,7 @@
"name": "new-server-test",
"accessIPv4": "",
"accessIPv6": "",
"config_drive": "test",
"config_drive": "",
"OS-DCF:diskConfig": "AUTO",
"OS-EXT-AZ:availability_zone": "nova",
"OS-EXT-SRV-ATTR:host": "b8b357f7100d4391828f2177c922ef93",

3
api-ref/src/wadls/compute-api/src/v2.1/api_samples/all_extensions/server-post-req.json
View File

@ -5,9 +5,6 @@
"flavorRef": "http://openstack.example.com/flavors/1",
"metadata": {
"My Server Name": "Apache1"
},
"os:scheduler_hints": {
"same_host": "48e6a9f6-30af-47e0-bc04-acaed113bb4e"
}
}
}

4
api-ref/src/wadls/compute-api/src/v2.1/api_samples/all_extensions/server-post-resp.json
View File

@ -5,11 +5,11 @@
"id": "8195065c-fea4-4d57-b93f-5c5c63fe90e8",
"links": [
{
"href": "http://openstack.example.com/v2.1/servers/8195065c-fea4-4d57-b93f-5c5c63fe90e8",
"href": "http://openstack.example.com/v2/openstack/servers/8195065c-fea4-4d57-b93f-5c5c63fe90e8",
"rel": "self"
},
{
"href": "http://openstack.example.com/servers/8195065c-fea4-4d57-b93f-5c5c63fe90e8",
"href": "http://openstack.example.com/openstack/servers/8195065c-fea4-4d57-b93f-5c5c63fe90e8",
"rel": "bookmark"
}
],

4
api-ref/src/wadls/compute-api/src/v2.1/api_samples/all_extensions/servers-list-resp.json
View File

@ -4,11 +4,11 @@
"id": "a291599e-6de2-41a6-88df-c443ddcef70d",
"links": [
{
"href": "http://openstack.example.com/v2.1/servers/a291599e-6de2-41a6-88df-c443ddcef70d",
"href": "http://openstack.example.com/v2/openstack/servers/a291599e-6de2-41a6-88df-c443ddcef70d",
"rel": "self"
},
{
"href": "http://openstack.example.com/servers/a291599e-6de2-41a6-88df-c443ddcef70d",
"href": "http://openstack.example.com/openstack/servers/a291599e-6de2-41a6-88df-c443ddcef70d",
"rel": "bookmark"
}
],

56
api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-config-drive/server-config-drive-get-resp.json
View File

@ -1,56 +0,0 @@
{
"server": {
"addresses": {
"private": [
{
"addr": "192.168.0.3",
"OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
"OS-EXT-IPS:type": "fixed",
"version": 4
}
]
},
"created": "2013-09-22T02:33:23Z",
"flavor": {
"id": "1",
"links": [
{
"href": "http://openstack.example.com/flavors/1",
"rel": "bookmark"
}
]
},
"hostId": "1642bbdbd61a0f1c513b4bb6e418326103172698104bfa278eca106b",
"id": "7838ff1b-b71f-48b9-91e9-7c08de20b249",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
},
"key_name": null,
"links": [
{
"href": "http://openstack.example.com/v2.1/servers/7838ff1b-b71f-48b9-91e9-7c08de20b249",
"rel": "self"
},
{
"href": "http://openstack.example.com/servers/7838ff1b-b71f-48b9-91e9-7c08de20b249",
"rel": "bookmark"
}
],
"metadata": {
"My Server Name": "Apache1"
},
"name": "new-server-test",
"config_drive": "",
"progress": 0,
"status": "ACTIVE",
"tenant_id": "openstack",
"updated": "2013-09-22T02:33:25Z",
"user_id": "fake"
}
}

58
api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-config-drive/servers-config-drive-details-resp.json
View File

@ -1,58 +0,0 @@
{
"servers": [
{
"addresses": {
"private": [
{
"addr": "192.168.0.3",
"OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
"OS-EXT-IPS:type": "fixed",
"version": 4
}
]
},
"created": "2013-09-22T02:33:17Z",
"flavor": {
"id": "1",
"links": [
{
"href": "http://openstack.example.com/flavors/1",
"rel": "bookmark"
}
]
},
"hostId": "1ed067c90341cd9d94bbe5da960922b56f107262cdc75719a0d97b78",
"id": "f0318e69-11eb-4aed-9840-59b6c72beee8",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
},
"key_name": null,
"links": [
{
"href": "http://openstack.example.com/v2.1/servers/f0318e69-11eb-4aed-9840-59b6c72beee8",
"rel": "self"
},
{
"href": "http://openstack.example.com/servers/f0318e69-11eb-4aed-9840-59b6c72beee8",
"rel": "bookmark"
}
],
"metadata": {
"My Server Name": "Apache1"
},
"name": "new-server-test",
"config_drive": "",
"progress": 0,
"status": "ACTIVE",
"tenant_id": "openstack",
"updated": "2013-09-22T02:33:19Z",
"user_id": "fake"
}
]
}

59
api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-server-usage/server-get-resp.json
View File

@ -1,59 +0,0 @@
{
"server": {
"accessIPv4": "1.2.3.4",
"accessIPv6": "80fe::",
"addresses": {
"private": [
{
"addr": "192.168.0.3",
"OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
"OS-EXT-IPS:type": "fixed",
"version": 4
}
]
},
"created": "2013-08-15T08:12:40Z",
"flavor": {
"id": "1",
"links": [
{
"href": "http://openstack.example.com/openstack/flavors/1",
"rel": "bookmark"
}
]
},
"hostId": "73cf3a40601b63f5992894be2daa3712dd599d1c919984951e21edda",
"id": "cee6d136-e378-4cfc-9eec-71797f025991",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
},
"key_name": null,
"links": [
{
"href": "http://openstack.example.com/v2/openstack/servers/cee6d136-e378-4cfc-9eec-71797f025991",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/servers/cee6d136-e378-4cfc-9eec-71797f025991",
"rel": "bookmark"
}
],
"metadata": {
"My Server Name": "Apache1"
},
"name": "new-server-test",
"OS-SRV-USG:launched_at": "2013-08-15T08:12:40.108903",
"OS-SRV-USG:terminated_at": null,
"progress": 0,
"status": "ACTIVE",
"tenant_id": "openstack",
"updated": "2013-08-15T08:12:40Z",
"user_id": "fake"
}
}

61
api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-server-usage/servers-detail-resp.json
View File

@ -1,61 +0,0 @@
{
"servers": [
{
"accessIPv4": "1.2.3.4",
"accessIPv6": "80fe::",
"addresses": {
"private": [
{
"addr": "192.168.0.3",
"OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
"OS-EXT-IPS:type": "fixed",
"version": 4
}
]
},
"created": "2013-08-15T12:04:04Z",
"flavor": {
"id": "1",
"links": [
{
"href": "http://openstack.example.com/openstack/flavors/1",
"rel": "bookmark"
}
]
},
"hostId": "117535ce0eda7ee02ebffe2c976173629385481ae3f2bded5e14a66b",
"id": "ae114799-9164-48f5-a036-6ef9310acbc4",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
},
"key_name": null,
"links": [
{
"href": "http://openstack.example.com/v2/openstack/servers/ae114799-9164-48f5-a036-6ef9310acbc4",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/servers/ae114799-9164-48f5-a036-6ef9310acbc4",
"rel": "bookmark"
}
],
"metadata": {
"My Server Name": "Apache1"
},
"name": "new-server-test",
"OS-SRV-USG:launched_at": "2013-08-15T12:04:05.368766",
"OS-SRV-USG:terminated_at": null,
"progress": 0,
"status": "ACTIVE",
"tenant_id": "openstack",
"updated": "2013-08-15T12:04:05Z",
"user_id": "fake"
}
]
}

824
api-ref/src/wadls/compute-api/src/v2.1/common.ent
View File

@ -172,7 +172,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>server.</para>
<para>server</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
@ -397,20 +397,7 @@
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="config_drive" style="plain"
type="xsd:boolean" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Enables metadata injection in a server through a configuration drive.
</para>
<para>
Specify <code>true</code> to enable a configuration drive. Otherwise,
specify <code>false</code>.
</para>
</wadl:doc>
</param>
&config_driveRequestParameter;
<param xmlns="http://wadl.dev.java.net/2009/02" name="key_name" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -433,6 +420,53 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY serverObjectParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="server" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A <code>server</code> object.</para>
</wadl:doc>
</param>'>
<!ENTITY serversObjectParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="servers" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A <code>servers</code> object.</para>
</wadl:doc>
</param>'>
<!ENTITY config_driveRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="config_drive" style="plain"
type="xsd:boolean" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Indicates whether metadata injection is enabled through a configuration
drive.
</para>
</wadl:doc>
</param>'>
<!ENTITY config_driveResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="config_drive" style="plain"
type="xsd:boolean" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Enables metadata injection in a server through a configuration drive.
</para>
<para>
Specify <code>true</code> to enable a configuration drive. Otherwise,
specify <code>false</code>.
</para>
</wadl:doc>
</param>'>
<!ENTITY imageRefRequestParameter '
<param name="imageRef" style="plain" required="false"
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
@ -450,6 +484,247 @@
</para>
</wadl:doc>
</param>'>
<!-- SERVER ACTIONS -->
<!ENTITY addFixedIpActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="addFixedIp" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>addFixedIp</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY attachActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="attach" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>attach</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY changePasswordActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="changePassword" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>changePassword</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY confirmBackupActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="confirmBackup" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>confirmBackup</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY confirmResizeActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="confirmResize" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>confirmResize</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY createImageActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="createImage" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>createImage</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY createBackupActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="createBackup" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>createBackup</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY forceDeleteServerActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="forceDeleteServer" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>forceDeleteServer</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY injectNetworkInfoActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="injectNetworkInfo" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>injectNetworkInfo</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY lockActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="lock" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>lock</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY migrateActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="migrate" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>migrate</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY os-getConsoleOutputActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="os-getConsoleOutput" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>os-getConsoleOutput</code>
action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY get_vnc_consoleActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="get_vnc_console" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>get_vnc_console</code>
action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY get_spice_consoleActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="get_spice_console" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>get_spice_console</code>
action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY os-migrateLiveActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-migrateLive" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>os-migrateLive</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY os-resetStateActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-resetState" style="plain" type="xsd:string"
required="true" id="os-start">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>os-resetState</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY os-startActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-start" style="plain" type="xsd:string"
required="true" id="os-start">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>os-start</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY os-stopActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-stop" style="plain" type="xsd:string"
required="true" id="os-stop">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>os-stop</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY pauseActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="pause" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>pause</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY rebootActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="reboot" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>reboot</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY rebuildActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="rebuild" style="plain" required="true"
@ -462,6 +737,177 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY remove_fixed_ipActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="remove_fixed_ip" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>remove_fixed_ip</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY rescueActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="rescueServer" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>rescue</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY resetNetworkServerActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="resetNetworkServer" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>resetNetworkServer</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY resizeActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="resize" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>resize</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY restoreActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="restore" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>restore</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY resumeActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="resume" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>resume</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY revertResizeActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="revertResize" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>revertResize</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY shelveActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="shelve" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>shelve</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY shelveOffloadActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="shelveOffload" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>shelveOffload</code>
action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY suspendActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="suspend" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>suspend</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY unlockActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="unlock" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>unlock</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY unrescueActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="unrescueServer" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>unrescue</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY unshelveActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="unshelve"
style="plain"
type="xsd:string"
required="true" id="os-unshelve">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>unshelve</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY unpauseActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="unpause" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>unpause</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY serverNameRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" required="true" type="xsd:string">
@ -625,6 +1071,275 @@
<para>Server links.</para>
</wadl:doc>
</param>'>
<!ENTITY hostIdResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="hostId" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID for the host.
</para>
</wadl:doc>
</param>'>
<!ENTITY idResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" required="true"
type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID for the server.
</para>
</wadl:doc>
</param>'>
<!ENTITY imageResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="image" style="plain" required="true"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The image ID and links for the image
for your server instance.
</para>
</wadl:doc>
</param>'>
<!ENTITY flavorResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="flavor" style="plain" required="true"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The flavor ID and links for the flavor
for your server instance. A flavor is a combination of memory,
disk size, and CPUs.
</para>
</wadl:doc>
</param>'>
<!ENTITY key_nameResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="key_name" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Name of associated key pair, if any.
</para>
</wadl:doc>
</param>'>
<!ENTITY serverLinksResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="links" style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Server links.</para>
</wadl:doc>
</param>'>
<!ENTITY serverMetadataResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
style="plain" name="metadata" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Associated metadata key-and-value pairs.</para>
</wadl:doc>
</param>'>
<!ENTITY serverNameResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" required="true"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The server name.</para>
</wadl:doc>
</param>'>
<!ENTITY diskConfigResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="OS-DCF:diskConfig" style="plain" type="csapi:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Disk configuration, which is <code>AUTO</code> or
<code>MANUAL</code>.</para>
</wadl:doc>
</param>'>
<!ENTITY availability_zoneResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="OS-EXT-AZ:availability_zone" style="plain" type="csapi:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The availability zone.</para>
</wadl:doc>
</param>'>
<!ENTITY hostResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="OS-EXT-SRV-ATTR:host" style="plain" type="csapi:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The host name.</para>
</wadl:doc>
</param>'>
<!ENTITY hypervisor_hostnameResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="OS-EXT-SRV-ATTR:hypervisor_hostname" style="plain" type="csapi:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The hypervisor host name.</para>
</wadl:doc>
</param>'>
<!ENTITY instance_nameResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="OS-EXT-SRV-ATTR:instance_name" style="plain"
type="csapi:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The instance name.</para>
</wadl:doc>
</param>'>
<!ENTITY power_stateResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="OS-EXT-STS:power_state" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The power state of the instance.</para>
</wadl:doc>
</param>'>
<!ENTITY task_stateResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="OS-EXT-STS:task_state" style="plain"
type="csapi:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The task state of the instance.</para>
</wadl:doc>
</param>'>
<!ENTITY vm_stateResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="OS-EXT-STS:vm_state" style="plain"
type="csapi:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The VM state.</para>
</wadl:doc>
</param>'>
<!ENTITY volumes_attachedResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-extended-volumes:volumes_attached" style="plain"
type="csapi:dict" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Attached volumes, if any.</para>
</wadl:doc>
</param>'>
<!ENTITY launched_at-ResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="OS-SRV-USG:launched_at" style="plain" required="true"
type="xsd:dateTime">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The date and time when the server was launched.
</para>
<para>
The date and time stamp format is <link
xlink:href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</link>:
</para>
<programlisting>CCYY-MM-DDThh:mm:ss±hh:mm</programlisting>
<para>
For example, <code>2015-08-27T09:49:58-05:00</code>.
</para>
<para>
The <code>±hh:mm</code> value, if included, is the time zone as an offset from UTC.
</para>
<para>
If the <code>deleted_at</code> date and time stamp is not set, its value is
<code>null</code>.
</para>
</wadl:doc>
</param>'>
<!ENTITY terminated_at-ResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="OS-SRV-USG:terminated_at" style="plain" required="true"
type="xsd:dateTime">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The date and time when the server was deleted.
</para>
<para>
The date and time stamp format is <link
xlink:href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</link>:
</para>
<programlisting>CCYY-MM-DDThh:mm:ss±hh:mm</programlisting>
<para>
For example, <code>2015-08-27T09:49:58-05:00</code>.
</para>
<para>
The <code>±hh:mm</code> value, if included, is the time zone as an offset from UTC.
</para>
<para>
If the <code>deleted_at</code> date and time stamp is not set, its value is
<code>null</code>.
</para>
</wadl:doc>
</param>'>
<!ENTITY progressResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="progress" style="plain" type="xsd:int" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A percentage value of the build progress.</para>
</wadl:doc>
</param>'>
<!ENTITY statusResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="status" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The server status.</para>
</wadl:doc>
</param>'>
<!ENTITY tenantIdResponseParameter '
<param name="tenant_id" style="plain" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The tenant ID in a multi-tenancy cloud.</para>
</wadl:doc>
</param>'>
<!ENTITY user_idResponseParameter '
<param name="user_id" style="plain" type="xsd:string"
required="true"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>
The user ID of the user who owns the server.
</para>
</wadl:doc>
</param>'>
<!-- tenantIdRequestParameter -->
<!ENTITY tenantIdRequestParameter '
<param name="tenant_id" style="template" type="csapi:UUID"
@ -975,8 +1690,11 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
The addresses for the server. If <code>osapi_hide_server_address_states</code> is set,
addresses information is hidden for any server in the specified state. By default,
The addresses for the server.
</para>
<para>
If <code>osapi_hide_server_address_states</code> is set, addresses
information is hidden for any server in the specified state. By default,
servers in <code>BUILDING</code> state hide their addresses information.
</para>
</wadl:doc>
@ -1587,48 +2305,8 @@
</para>
</wadl:doc>
</param>'>
<!-- Servers Shelve -->
<!ENTITY shelveAction '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="shelve" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>shelve</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY shelveOffloadAction '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="shelveOffload" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>shelveOffload</code>
action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY unshelveAction '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="unshelve"
style="plain"
type="xsd:string"
required="true" id="os-unshelve">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>unshelve</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY serverGroupParameters '
<!-- Security group parameters -->
<!ENTITY securityGroupParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" name="security_groups" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -2080,3 +2758,31 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY serverResponseParameters '
&serverAddressResponseParameters;
&createdResponseParameter;
&flavorResponseParameter;
&hostIdResponseParameter;
&idResponseParameter;
&imageResponseParameter;
&key_nameResponseParameter;
&serverLinksResponseParameter;
&serverMetadataResponseParameter;
&serverNameResponseParameter;
&diskConfigResponseParameter;
&availability_zoneResponseParameter;
&hostResponseParameter;
&hypervisor_hostnameResponseParameter;
&instance_nameResponseParameter;
&power_stateResponseParameter;
&task_stateResponseParameter;
&vm_stateResponseParameter;
&volumes_attachedResponseParameter;
&launched_at-ResponseParameter;
&terminated_at-ResponseParameter;
&progressResponseParameter;
&securityGroupParameters;
&statusResponseParameter;
&tenantIdResponseParameter;
&updatedResponseParameter;
&user_idResponseParameter;'>

194
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-admin-actions-v2.1.wadl
View File

@ -20,19 +20,19 @@
<resource id="server_id" path="{server_id}">
&serverIdRequestParameter;
<resource id="action" path="action">
<method href="#adminpassword"/>
<method href="#backupserver"/>
<method href="#adminservernetwork"/>
<method href="#livemigrate"/>
<method href="#lockserver"/>
<method href="#migrateserver"/>
<method href="#pauseserver"/>
<method href="#resetnetwork"/>
<method href="#resetserver"/>
<method href="#resumeserver"/>
<method href="#suspendserver"/>
<method href="#unlockserver"/>
<method href="#unpauseserver"/>
<method href="#changePasswordServer"/>
<method href="#createBackupServer"/>
<method href="#injectNetworkInfoServer"/>
<method href="#lockServer"/>
<method href="#migrateServer"/>
<method href="#os-migrateLiveServer"/>
<method href="#pauseServer"/>
<method href="#resetNetworkServer"/>
<method href="#os-resetStateServer"/>
<method href="#resumeServer"/>
<method href="#suspendServer"/>
<method href="#unlockServer"/>
<method href="#unpauseServer"/>
</resource>
</resource>
</resource>
@ -42,13 +42,15 @@
<!-- *******************************************************-->
<!-- Admin Actions -->
<!--*******************************************************-->
<method name="POST" id="adminpassword">
<wadl:doc xml:lang="EN" title="Change admin password"
<method name="POST" id="changePasswordServer">
<wadl:doc xml:lang="EN" title="Change administrative password (changePassword action)"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Changes the admin password.</para>
<para role="shortdesc">
Changes the administrative password for a specified server.
</para>
<para>
Specify the <code>changePassword</code> action in
the request body.
Specify the <code>changePassword</code> action in the request
body.
</para>
<para>
Policy defaults enable only users with the administrative role
@ -64,17 +66,20 @@
href="../api_samples/os-admin-password/admin-password-change-password.json"
/>
</wadl:doc>
&changePasswordActionRequestParameter;
</representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="backupserver">
<wadl:doc xml:lang="EN" title="Back up server"
<method name="POST" id="createBackupServer">
<wadl:doc xml:lang="EN" title="Back up server (createBackup action)"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Backs up a server instance.</para>
<para role="shortdesc">
Backs up a specified server instance.
</para>
<para>
Specify the <code>createBackup</code> action in
the request body.
Specify the <code>createBackup</code> action in the request
body.
</para>
<para>
Policy defaults enable only users with the administrative role
@ -90,20 +95,22 @@
href="../api_samples/os-create-backup/create-backup-req.json"
/>
</wadl:doc>
&createBackupActionRequestParameter;
</representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="adminservernetwork">
<wadl:doc xml:lang="EN" title="Inject network information"
<method name="POST" id="injectNetworkInfoServer">
<wadl:doc xml:lang="EN" title="Inject network information (injectNetworkInfo action)"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Injects network information into a
server.</para>
<para>
Specify the <code>injectNetworkInfo</code> action in
the request body.
<para role="shortdesc">
Injects network information into a server.
</para>
<para>
<para>
Specify the <code>injectNetworkInfo</code> action in the
request body.
</para>
<para>
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the <code>policy.json</code> file.
@ -117,18 +124,21 @@
href="../api_samples/os-admin-actions/admin-actions-inject-network-info.json"
/>
</wadl:doc>
&injectNetworkInfoActionRequestParameter;
</representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="livemigrate">
<wadl:doc xml:lang="EN" title="Live migrate to new host"
<method name="POST" id="os-migrateLiveServer">
<wadl:doc xml:lang="EN" title="Live migrate to new host (os-migrateLive action)"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Live-migrates a server to a new
host without rebooting.</para>
<para role="shortdesc">
Live-migrates a specified server to a new host without
rebooting.
</para>
<para>
Specify the <code>os-migrateLive</code> action in
the request body.
Specify the <code>os-migrateLive</code> action in the request
body.
</para>
<para>
Policy defaults enable only users with the administrative role
@ -144,17 +154,19 @@
href="../api_samples/os-migrate-server/live-migrate-server.json"
/>
</wadl:doc>
&os-migrateLiveActionRequestParameter;
</representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="lockserver">
<wadl:doc xml:lang="EN" title="Lock server"
<method name="POST" id="lockServer">
<wadl:doc xml:lang="EN" title="Lock server (lock action)"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Locks a server instance.</para>
<para role="shortdesc">
Locks a specified server instance.
</para>
<para>
Specify the <code>lock</code> action in
the request body.
Specify the <code>lock</code> action in the request body.
</para>
<para>
Policy defaults enable only users with the administrative role
@ -170,18 +182,20 @@
href="../api_samples/os-lock-server/lock-server.json"
/>
</wadl:doc>
&lockActionRequestParameter;
</representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="migrateserver">
<wadl:doc xml:lang="EN" title="Migrate server"
<method name="POST" id="migrateServer">
<wadl:doc xml:lang="EN" title="Migrate server (migrate action)"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Migrates a server to a host. The
scheduler chooses the host.</para>
<para role="shortdesc">
Migrates a specified server to a host. The scheduler chooses
the host.
</para>
<para>
Specify the <code>migrate</code> action in
the request body.
Specify the <code>migrate</code> action in the request body.
</para>
<para>
Policy defaults enable only users with the administrative role
@ -197,18 +211,18 @@
href="../api_samples/os-migrate-server/migrate-server.json"
/>
</wadl:doc>
&migrateActionRequestParameter;
</representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="pauseserver">
<wadl:doc xml:lang="EN" title="Pause server"
<method name="POST" id="pauseServer">
<wadl:doc xml:lang="EN" title="Pause server (pause action)"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Pauses a server. Changes its status
to PAUSED.</para>
<para role="shortdesc">Pauses a specified server. Changes its status
to <code>PAUSED</code>.</para>
<para>
Specify the <code>pause</code> action in
the request body.
Specify the <code>pause</code> action in the request body.
</para>
<para>
Policy defaults enable only users with the administrative role
@ -224,17 +238,19 @@
href="../api_samples/os-pause-server/pause-server.json"
/>
</wadl:doc>
&pauseActionRequestParameter;
</representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="resetnetwork">
<wadl:doc xml:lang="EN" title="Reset server networking"
<method name="POST" id="resetNetworkServer">
<wadl:doc xml:lang="EN" title="Reset networking on a server (resetNetworkServer action)"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Resets networking on a
server.</para>
<para role="shortdesc">
Resets networking on a specified server.
</para>
<para>
Specify the <code>resetNetwork</code> action in
Specify the <code>resetNetworkServer</code> action in
the request body.
</para>
<para>
@ -251,14 +267,15 @@
href="../api_samples/os-admin-actions/admin-actions-reset-network.json"
/>
</wadl:doc>
&resetNetworkServerActionRequestParameter;
</representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="resetserver">
<wadl:doc xml:lang="EN" title="Reset server state"
<method name="POST" id="os-resetStateServer">
<wadl:doc xml:lang="EN" title="Reset server state (os-resetState action)"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Resets the state of a server to a
<para role="shortdesc">Resets the state of a specified server to a
specified state.</para>
<para>
Specify the <code>os-resetState</code> action and the
@ -278,18 +295,20 @@
href="../api_samples/os-admin-actions/admin-actions-reset-server-state.json"
/>
</wadl:doc>
&os-resetStateActionRequestParameter;
</representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="resumeserver">
<wadl:doc xml:lang="EN" title="Resume server"
<method name="POST" id="resumeServer">
<wadl:doc xml:lang="EN" title="Resume server (resume action)"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Resumes a SUSPENDED server and
changes its status to ACTIVE.</para>
<para role="shortdesc">
Resumes a suspended server and changes its status to
<code>ACTIVE</code>.
</para>
<para>
Specify the <code>resume</code> action in
the request body.
Specify the <code>resume</code> action in the request body.
</para>
<para>
Policy defaults enable only users with the administrative role
@ -305,18 +324,20 @@
href="../api_samples/os-suspend-server/server-resume.json"
/>
</wadl:doc>
&resumeActionRequestParameter;
</representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="suspendserver">
<wadl:doc xml:lang="EN" title="Suspend server"
<method name="POST" id="suspendServer">
<wadl:doc xml:lang="EN" title="Suspend server (suspend action)"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Suspends a server and changes its
status to SUSPENDED.</para>
<para role="shortdesc">
Suspends a specified server and changes its status to
<code>SUSPENDED</code>.
</para>
<para>
Specify the <code>suspend</code> action in
the request body.
Specify the <code>suspend</code> action in the request body.
</para>
<para>
Policy defaults enable only users with the administrative role
@ -332,17 +353,17 @@
href="../api_samples/os-suspend-server/server-suspend.json"
/>
</wadl:doc>
&suspendActionRequestParameter;
</representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="unlockserver">
<wadl:doc xml:lang="EN" title="Unlock server"
<method name="POST" id="unlockServer">
<wadl:doc xml:lang="EN" title="Unlock server (unlock action)"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Unlocks a server instance.</para>
<para role="shortdesc">Unlocks a specified server instance.</para>
<para>
Specify the <code>unlock</code> action in
the request body.
Specify the <code>unlock</code> action in the request body.
</para>
<para>
Policy defaults enable only users with the administrative role
@ -358,18 +379,20 @@
href="../api_samples/os-lock-server/unlock-server.json"
/>
</wadl:doc>
&unlockActionRequestParameter;
</representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="unpauseserver">
<wadl:doc xml:lang="EN" title="Unpause server"
<method name="POST" id="unpauseServer">
<wadl:doc xml:lang="EN" title="Unpause server (unpause action)"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Unpauses a PAUSED server and
changes its status to ACTIVE.</para>
<para role="shortdesc">
Unpauses a paused server and changes its status to
<code>ACTIVE</code>.
</para>
<para>
Specify the <code>unpause</code> action in
the request body.
Specify the <code>unpause</code> action in the request body.
</para>
<para>
Policy defaults enable only users with the administrative role
@ -385,6 +408,7 @@
href="../api_samples/os-pause-server/unpause-server.json"
/>
</wadl:doc>
&unpauseActionRequestParameter;
</representation>
</request>
<response status="202"/>

60
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-admin-password-v2.1.wadl
View File

@ -1,60 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2015 OpenStack Foundation, All Rights Reserved -->
<!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-admin-password-v2.1">
<resource id="v2.1" path="//v2.1">
<resource id="tenant_id" path="{tenant_id}">
&tenantIdRequestParameter;
<resource id="servers" path="servers">
<resource id="server_id" path="{server_id}">
&serverIdRequestParameter;
<resource id="action" path="action">
<method href="#adminpassword"/>
</resource>
</resource>
</resource>
</resource>
</resource>
</resources>
<!-- *******************************************************-->
<!-- Admin password -->
<!--********************************************************-->
<method name="POST" id="adminpassword">
<wadl:doc xml:lang="EN" title="Change admin password"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Changes the admin password.</para>
<para>
Specify the <code>changePassword</code> action in
the request body.
</para>
<para>
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the <code>policy.json</code> file.
</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-admin-password/admin-password-change-password.json"
/>
</wadl:doc>
</representation>
</request>
<response status="202"/>
</method>
</application>

214
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-compute-2.1.wadl
View File

@ -12,24 +12,23 @@
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:csapi="http://docs.openstack.org/identity/api/v3"
xmlns:xlink="http://www.w3.org/1999/xlink">
<resources base="https://servers.api.openstack.com"
xml:id="os-compute-v2.1">
<resource id="v2.1" path="//v2.1">
<resource id="tenant_id" path="{tenant_id}">
&tenantIdRequestParameter;
<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}">
&serverIdRequestParameter;
<method href="#getServer"/>
<method href="#updateServer"/>
<method href="#deleteServer"/>
</resource>
<resources base="https://servers.api.openstack.com" xml:id="os-compute-v2.1">
<resource id="v2.1" path="//v2.1">
<resource id="tenant_id" path="{tenant_id}">
&tenantIdRequestParameter;
<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}">
&serverIdRequestParameter;
<method href="#getServer"/>
<method href="#updateServer"/>
<method href="#deleteServer"/>
</resource>
</resource>
</resource>
</resources>
</resource>
</resources>
<!--*******************************************************-->
<!-- Resource Types -->
@ -185,66 +184,86 @@
<itemizedlist xml:id="server_status">
<title>Server status values</title>
<listitem>
<para><code>ACTIVE</code>. The server is active.</para>
<para>
<code>ACTIVE</code>. The server is active.
</para>
</listitem>
<listitem>
<para><code>BUILDING</code>. The server has not finished the original build
<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>
<code>DELETED</code>. The server is permanently deleted.
</para>
</listitem>
<listitem>
<para><code>PASSWORD</code>. The password is being reset on the server.</para>
<para>
<code>ERROR</code>. The server is in error.
</para>
</listitem>
<listitem>
<para><code>PAUSED</code>. In a paused state, the state of the server is
<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
<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
<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
<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>
<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>
<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
<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
<para>
<code>STOPPED</code>. The server is powered off and the disk image
still persists.
</para>
</listitem>
@ -252,23 +271,25 @@
<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.
the XenServer/XCP, KVM, and ESXi hypervisors. Administrative
users can 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>
<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>
<code>VERIFY_RESIZE</code>. System is awaiting confirmation
that the server is operational after a move or resize.
</para>
</listitem>
</itemizedlist>
@ -301,6 +322,27 @@
your server runs on and can be used to determine this scenario if
it is relevant to your application.
</para>
<para>
For each server, shows server details including configuration
drive, extended status, and server usage information.
</para>
<para>
The extended status information appears in the
<code>OS-EXT-STS:vm_state</code>, <code>OS-EXT-STS:power_state</code>, and
<code>OS-EXT-STS:task_state</code> attributes.
</para>
<para>
The server usage information appears in the
<code>OS-SRV-USG:launched_at</code> and <code>OS-SRV-USG:terminated_at</code>
attributes.
</para>
<para>
To hide <code>addresses</code> information for instances in a
specified state, set the
<code>osapi_hide_server_address_states</code> configuration
option. Set this option to a valid VM state in the
<code>nova.conf</code> configuration file.
</para>
<note>
<para>
<property>HostId</property> is unique <emphasis>per
@ -319,13 +361,45 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/all_extensions/servers-details-resp.json"/>
</wadl:doc>
&serversObjectParameter;
&serverResponseParameters;
</representation>
</response>
<!-- Common Faults --> &commonFaults;
<!-- 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 role="shortdesc">
Shows details for a specified server.
</para>
<para>
Includes server details including configuration
drive, extended status, and server usage information.
</para>
<para>
The extended status information appears in the
<code>OS-EXT-STS:vm_state</code>, <code>OS-EXT-STS:power_state</code>, and
<code>OS-EXT-STS:task_state</code> attributes.
</para>
<para>
The server usage information appears in the
<code>OS-SRV-USG:launched_at</code> and <code>OS-SRV-USG:terminated_at</code>
attributes.
</para>
<para>
To hide <code>addresses</code> information for instances in a
specified state, set the
<code>osapi_hide_server_address_states</code> configuration
option. Set this option to a valid VM state in the
<code>nova.conf</code> configuration file.
</para>
<note>
<para>
<property>HostId</property> is unique <emphasis>per
account</emphasis> and is not globally unique.
</para>
</note>
<para>Preconditions</para>
<itemizedlist>
<listitem>
@ -339,6 +413,8 @@
<xsdxt:code href="../api_samples/all_extensions/server-get-resp.json"/>
</wadl:doc>
&x-compute-request-idHeader;
&serverObjectParameter;
&serverResponseParameters;
</representation>
</response>
<!-- Common and GET Faults--> &commonFaults; &getFaults;
@ -381,7 +457,8 @@
</wadl:doc>
</representation>
</response>
<!-- Common, GET, POST/PUT, inProgress Faults--> &commonFaults; &getFaults; &postPutFaults;
<!-- Common, GET, POST/PUT, inProgress Faults-->
&commonFaults; &getFaults; &postPutFaults;
&inProgressFault;
</method>
<method name="DELETE" id="deleteServer">
@ -390,20 +467,24 @@
<para>Preconditions</para>
<itemizedlist>
<listitem>
<para>The specified server must exist.</para>
<para>
The specified server must exist.</para>
</listitem>
<listitem>
<para>Anyone can delete a server when the server's
<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
<para>
You can delete a server which status is
not locked.
</para>
</listitem>
<listitem>
<para>If the specified server is locked, you need to
<para>
If the specified server is locked, you need to
have administrator privileges to delete the server.
</para>
</listitem>
@ -411,23 +492,27 @@
<para>Asynchronous postconditions</para>
<itemizedlist>
<listitem>
<para>With correct permissions, you can see the
<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
<para>
The port attached to the specified server
is deleted.
</para>
</listitem>
<listitem>
<para>The server is deleted from the list of
<para>
The server is deleted from the list of
servers returned by an API calls.
</para>
</listitem>
<listitem>
<para>The server managed by OpenStack Compute is
<para>
The server managed by OpenStack Compute is
deleted on the compute node.
</para>
</listitem>
@ -435,20 +520,23 @@
<para>Troubleshooting</para>
<itemizedlist>
<listitem>
<para>If server status remains in <code>deleting</code>
<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
<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
<para>
The server managed by OpenStack Compute is not
deleted from the compute node.
</para>
</listitem>

65
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-config-drive-v2.1.wadl
View File

@ -1,65 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2014-2015 OpenStack Foundation, All Rights Reserved -->
<!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:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:csapi="http://docs.openstack.org/identity/api/v3">
<resources base="https://servers.api.openstack.com"
xml:id="os-config-drive-v2.1">
<resource id="v2.1" path="//v2.1">
<resource id="tenant_id" path="{tenant_id}">
&tenantIdRequestParameter;
<resource id="servers" path="servers">
<resource id="server_id" path="{server_id}">
&serverIdRequestParameter;
<method href="#returnserver"/>
</resource>
<resource id="detail" path="detail">
<method href="#returnlist"/>
</resource>
</resource>
</resource>
</resource>
</resources>
<!-- *******************************************************-->
<!-- OS Configure Drive -->
<!--*******************************************************-->
<method name="GET" id="returnserver">
<wadl:doc xml:lang="EN" title="Show server details with configuration drive"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows details for a specified
server. Includes configuration drive information.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-config-drive/server-config-drive-get-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
</response>
</method>
<method name="GET" id="returnlist">
<wadl:doc xml:lang="EN" title="List servers with configuration drive"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists server details. Includes configuration drive information.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-config-drive/servers-config-drive-details-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
</response>
</method>
</application>

20
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-console-output-v2.1.wadl
View File

@ -20,18 +20,18 @@
<resource id="server_id" path="{server_id}">
&serverIdRequestParameter;
<resource path="action" id="action-os-console-output">
<method href="#getConsoleOutput"/>
<method href="#os-getConsoleOutputServer"/>
</resource>
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="POST" id="getConsoleOutput">
<method name="POST" id="os-getConsoleOutputServer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get console output for an instance">
title="Get console output for a server (os-getConsoleOutput action)">
<para role="shortdesc">
Gets console output for a server instance.
Gets console output for a specified server instance.
</para>
<para>
Specify the <code>os-getConsoleOutput</code> action in the
@ -47,17 +47,7 @@
href="../api_samples/os-console-output/console-output-post-req.json"
/>
</wadl:doc>
<param name="os-getConsoleOutput" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Get console output action">
<para>
Specify the <code>os-getConsoleOutput</code>
action in the request body.
</para>
</wadl:doc>
</param>
&os-getConsoleOutputActionRequestParameter;
<param name="length" style="plain">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Length">

22
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-deferred-delete-v2.1.wadl
View File

@ -20,8 +20,8 @@
<resource id="server_id" path="{server_id}">
&serverIdRequestParameter;
<resource id="action" path="action">
<method href="#forcedelete"/>
<method href="#restoredelete"/>
<method href="#forceDeleteServer"/>
<method href="#restoreServer"/>
</resource>
</resource>
</resource>
@ -31,14 +31,14 @@
<!--*******************************************************-->
<!-- OS Deferred Delete -->
<!--*******************************************************-->
<method name="POST" id="forcedelete">
<wadl:doc xml:lang="EN" title="Force delete instance"
<method name="POST" id="forceDeleteServer">
<wadl:doc xml:lang="EN" title="Force-delete server (forceDeleteServer action)"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">
Force deletes an instance before deferred cleanup.
Force-deletes a specified server before deferred cleanup.
</para>
<para>
Specify the <code>forceDelete</code> action in the request body.
Specify the <code>forceDeleteServer</code> action in the request body.
</para>
<para>
Policy defaults enable only users with the administrative role
@ -54,16 +54,17 @@
href="../api_samples/os-deferred-delete/force-delete-post-req.json"
/>
</wadl:doc>
&forceDeleteServerActionRequestParameter;
</representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="restoredelete">
<wadl:doc xml:lang="EN" title="Restore soft-deleted instance"
<method name="POST" id="restoreServer">
<wadl:doc xml:lang="EN" title="Restore soft-deleted instance (restore action)"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">
Restores a previously soft-deleted instance. You cannot use
this method to restore deleted instances.
Restores a previously soft-deleted server instance. You cannot
use this method to restore deleted instances.
</para>
<para>
Specify the <code>restore</code> action in the request body.
@ -82,6 +83,7 @@
href="../api_samples/os-deferred-delete/restore-post-req.json"
/>
</wadl:doc>
&restoreActionRequestParameter;
</representation>
</request>
<response status="202"/>

8
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-evacuate-v2.1.wadl
View File

@ -19,7 +19,7 @@
<resource id="server_id" path="{server_id}">
&serverIdRequestParameter;
<resource id="action" path="action">
<method href="#evacuateserver"/>
<method href="#evacuateServer"/>
</resource>
</resource>
</resource>
@ -29,11 +29,11 @@
<!-- *******************************************************-->
<!-- OS-evacuate -->
<!--*******************************************************-->
<method name="POST" id="evacuateserver">
<wadl:doc xml:lang="EN" title="Evacuate server"
<method name="POST" id="evacuateServer">
<wadl:doc xml:lang="EN" title="Evacuate server (evacuate action)"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">
Evacuates a server from a failed host to a new one.
Evacuates a specified server from a failed host to a new one.
</para>
<para>
Specify the <code>evacuate</code> action in the request body.

28
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-multinic-v2.1.wadl
View File

@ -20,8 +20,8 @@
<resource id="server_id" path="{server_id}">
&serverIdRequestParameter;
<resource id="action" path="action">
<method href="#removeip"/>
<method href="#addiptoinstance"/>
<method href="#addFixedIpServer"/>
<method href="#remove_fixed_ipServer"/>
</resource>
</resource>
</resource>
@ -31,14 +31,15 @@
<!-- *******************************************************-->
<!-- OS Multinic -->
<!--*******************************************************-->
<method name="POST" id="addiptoinstance">
<wadl:doc xml:lang="EN" title="Add IP to instance"
<method name="POST" id="addFixedIpServer">
<wadl:doc xml:lang="EN" title="Add fixed IP to server (addFixedIp action)"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Adds an IP to a specified network
on an instance.</para>
<para role="shortdesc">
Adds a fixed IP address to a specified network on a specified server instance.
</para>
<para>
Specify the <code>addFixedIp</code> action in the request
body.
Specify the <code>addFixedIp</code> action and the network ID
in the request body.
</para>
<para>
Policy defaults enable only users with the administrative role
@ -53,15 +54,17 @@
href="../api_samples/os-multinic/multinic-add-fixed-ip-req.json"
/>
</wadl:doc>
&addFixedIpActionRequestParameter;
</representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="removeip">
<wadl:doc xml:lang="EN" title="Remove IP from instance"
<method name="POST" id="remove_fixed_ipServer">
<wadl:doc xml:lang="EN" title="Remove fixed IP from server (remove_fixed_ip action)"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Removes an IP from a specified
instance.</para>
<para role="shortdesc">Removes a fixed IP address from a specified
server.
</para>
<para>
Specify the <code>remove_fixed_ip</code> action in the request
body.
@ -79,6 +82,7 @@
href="../api_samples/os-multinic/multinic-remove-fixed-ip-req.json"
/>
</wadl:doc>
&remove_fixed_ipActionRequestParameter;
</representation>
</request>
<response status="202"/>

20
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-remote-consoles-v2.1.wadl
View File

@ -20,8 +20,8 @@
<resource id="server_id" path="{server_id}">
&serverIdRequestParameter;
<resource id="action" path="action">
<method href="#getoutputspice"/>
<method href="#getoutputvnc"/>
<method href="#get_spice_consoleServer"/>
<method href="#get_vnc_consoleServer"/>
</resource>
</resource>
</resource>
@ -31,10 +31,11 @@
<!-- *******************************************************-->
<!-- OS Remote consoles -->
<!--*******************************************************-->
<method name="POST" id="getoutputspice">
<wadl:doc xml:lang="EN" title="Get output for spice"
<method name="POST" id="get_spice_consoleServer">
<wadl:doc xml:lang="EN" title="Get SPICE console for a server (get_spice_console action)"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Gets text console output.</para>
<para role="shortdesc">Gets a SPICE console for a specified server.
</para>
<para>
Specify the <code>get_spice_console</code> action in the request
body.
@ -47,6 +48,7 @@
href="../api_samples/os-remote-consoles/get-spice-console-post-req.json"
/>
</wadl:doc>
&get_spice_consoleActionRequestParameter;
</representation>
</request>
<response status="200">
@ -59,10 +61,11 @@
</representation>
</response>
</method>
<method name="POST" id="getoutputvnc">
<wadl:doc xml:lang="EN" title="Get console output"
<method name="POST" id="get_vnc_consoleServer">
<wadl:doc xml:lang="EN" title="Get VNC console for a server (get_vnc_console action)"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Gets text console output for VNC.</para>
<para role="shortdesc">Gets a VNC console for a specified server.
</para>
<para>
Specify the <code>get_vnc_console</code> action in the request
body.
@ -75,6 +78,7 @@
href="../api_samples/os-remote-consoles/get-vnc-console-post-req.json"
/>
</wadl:doc>
&get_vnc_consoleActionRequestParameter;
</representation>
</request>
<response status="200">

644
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-actions-v2.1.wadl
View File

@ -21,17 +21,17 @@
<resource id="server_id" path="{server_id}">
&serverIdRequestParameter;
<resource id="action" path="action">
<method href="#attachVolume"/>
<method href="#confirmResizeServer"/>
<method href="#createImage"/>
<method href="#rebootServer"/>
<method href="#rebuildServer"/>
<method href="#rescueServer"/>
<method href="#resizeServer"/>
<method href="#confirmServer"/>
<method href="#revertServer"/>
<method href="#createImage"/>
<method href="#start"/>
<method href="#stop"/>
<method href="#attachVolume"/>
<method href="#rescue"/>
<method href="#unrescue"/>
<method href="#revertResizeServer"/>
<method href="#os-startServer"/>
<method href="#os-stopServer"/>
<method href="#unrescueServer"/>
</resource>
</resource>
</resource>
@ -41,94 +41,93 @@
<!-- *******************************************************-->
<!-- Server Actions -->
<!--********************************************************-->
<method name="POST" id="rebootServer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Reboot server">
<method name="POST" id="attachVolume">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Attach volume (attach action)">
<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/servers/server-action-reboot.json"/>
</wadl:doc>
</representation>
</request>
<response status="202"/>
<!-- Common, GET, postput, 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.
Attaches a specified volume to a specified server.
</para>
<para>
To rebuild the specified server with preservation of the
ephemeral partition, set the <code>preserve_ephemeral</code>
parameter to <code>true</code>.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/servers/server-action-rebuild-preserve-ephemeral.json"/>
</wadl:doc>
&rebuildActionRequestParameter;
&imageRefRequestParameter;
&serverNameRequestParameter;
&adminPassRequestParameter;
&metadataRequestParameter;
&personalityRequestParameter;
&preserve_ephemeralRequestParameter;
</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/all_extensions/server-action-rebuild-resp.json"/>
</wadl:doc>
</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.
Specify the <code>attach</code> action in the request body.
</para>
<para>
A successfully resized server shows a
<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.
If the attach operation succeeds, the volume status
is <code>in-use</code>.
</para>
<para>Preconditions</para>
<itemizedlist>
<listitem><para>You can only resize a server when its status is
<code>ACTIVE</code> or <code>SHUTOFF</code>.</para></listitem>
<listitem><para>If the specified server is locked, you must have
administrator privileges to resize the server.</para></listitem>
<itemizedlist>
<listitem><para>The specified server must exist.</para></listitem>
<listitem><para>You can only attach a volume to the server
when its status is <code>available</code>.</para></listitem>
<listitem><para>The connection to the Block Storage service is valid.
</para></listitem>
</itemizedlist>
<para>Troubleshooting</para>
<itemizedlist>
<listitem>
<para>
If the request fails due to an OpenStack Compute service
error, 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/servers/server-action-resize.json"/>
<xsdxt:code href="../api_samples/servers/server-action-attach-volume.json"/>
</wadl:doc>
&attachActionRequestParameter;
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_id" style="plain" type="csapi:UUID"
required="true" id="volume_id">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>The volume ID.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="device" style="plain" type="xsd:string"
required="false" id="device">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>The device name.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="disk_bus" style="plain" type="xsd:string"
required="false" id="disk_bus">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>The disk bus name.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="device_type" style="plain" type="xsd:string"
required="false" id="device_type">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>The device type name.</para>
</wadl:doc>
</param>
</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">
<response status="409">
<representation mediaType="application/json"/>
</response>
&commonFaults;
&getFaults; &postPutFaults; &buildFaults; &inProgressFault;
</method>
<method name="POST" id="confirmResizeServer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Confirm resized server (confirmResize action)">
<para role="shortdesc">
Confirms a pending resize action. Specify the
Confirms a pending resize action for a specified server.
</para>
<para>
Specify the
<code>confirmResize</code> action in the request body.
</para>
<para>
@ -163,59 +162,21 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/servers/server-action-confirm-resize.json"/>
</wadl:doc>
&confirmResizeActionRequestParameter;
</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">
&commonFaults;
&getFaults; &postPutFaults; &buildFaults; &inProgressFault;
</method>
<method name="POST" id="createImage">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create image (createImage action)">
<para role="shortdesc">
Cancels and reverts a pending resize action. Specify the
<code>revertResize</code> action in the request body.
Creates an image from a specified server.
</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
a status of <code>ACTIVE</code> or <code>SHUTOFF</code>
and a migration_status of <code>reverted</code>. You can
also see the reverted server in the compute node that
OpenStack Compute manages.
</para>
<para>Preconditions</para>
<itemizedlist>
<listitem><para>You can only confirm the resized server where the status
is <code>VERIFY_RESIZE</code> and the 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/servers/server-action-revert-resize.json"/>
</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="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.
Specify the <code>createImage</code> action in the request body.
</para>
<para>
After you make this request, you typically must keep polling
@ -263,194 +224,83 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/servers/server-action-create-image.json"/>
</wadl:doc>
&createImageActionRequestParameter;
</representation>
</request>
<response status="202">
</response>
<response status="202"/>
<response status="409">
<representation mediaType="application/json"/>
</response>
<!-- All other faults, build, common, get, post/put, and inProgress --> &commonFaults;
&commonFaults;
&getFaults; &postPutFaults; &buildFaults; &inProgressFault; </method>
<method name="POST" id="start">
<method name="POST" id="rebootServer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Start server">
<para role="shortdesc">Starts a stopped server and changes
its status to <code>ACTIVE</code>.</para>
<para>Preconditions</para>
<itemizedlist>
<listitem><para>The server status must be <code>SHUTOFF</code>.
</para></listitem>
<listitem><para>If the specified server is locked, you
must have administrator privileges to start the server.
</para></listitem>
</itemizedlist>
<para>Asynchronous Postconditions</para>
<itemizedlist>
<listitem><para>After you successfully start a server,
its status changes to <code>ACTIVE</code>. The server appears on the compute
node that the Compute service manages.</para></listitem>
</itemizedlist>
<para>Troubleshooting</para>
<itemizedlist>
<listitem>
<para>
If the server status does not change to
<code>ACTIVE</code>, the start operation failed.
Ensure that you meet the preconditions and run the
request again. If the request fails again, investigate
whether another operation is running that causes a
race condition.
</para>
</listitem>
</itemizedlist>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/wadl:docbook"
xml:lang="EN" title="Start server: JSON request">
<xsdxt:code
href="../api_samples/servers/server-action-start.json"
/>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-start" style="plain" type="xsd:string"
required="true" id="os-start">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Specify the
<code>os-start</code> action in the
request body.</para></wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="stop">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Stop server">
<para role="shortdesc">Stops a running server and changes
its status to <code>SHUTOFF</code>.</para>
<para>Preconditions</para>
<itemizedlist>
<listitem><para>The server status must be
<code>ACTIVE</code> or <code>ERROR</code>.
</para></listitem>
<listitem><para>If the specified server is locked,
you must have administrator privileges to stop
the server.</para></listitem>
</itemizedlist>
<para>Asynchronous Postconditions</para>
<itemizedlist>
<listitem><para>After you successfully stop a server,
its status changes to <code>SHUTOFF</code>. The server instance data appears
only on the compute node that Compute service manages.
</para></listitem>
</itemizedlist>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/wadl:docbook"
xml:lang="EN" title="Stop server: JSON request">
<xsdxt:code
href="../api_samples/servers/server-action-stop.json"
/>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-stop" style="plain" type="xsd:string"
required="true" id="os-stop">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Specify the
<code>os-stop</code> action in the
request body.</para></wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="attachVolume">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Attach volume">
title="Reboot server (reboot action)">
<para role="shortdesc">
Attaches a specified volume. Specify the <code>attach</code>
action in the request body.
Reboots a specified server.
</para>
<para>
If the attach operation succeeds, the volume status
is <code>in-use</code>.
Specify the <code>reboot</code> action in the request body.
</para>
<para>Preconditions</para>
<itemizedlist>
<listitem><para>The specified server must exist.</para></listitem>
<listitem><para>You can only attach a volume to the server
when its status is <code>available</code>.</para></listitem>
<listitem><para>The connection to the Block storage service is valid.
</para></listitem>
</itemizedlist>
<para>Troubleshooting</para>
<itemizedlist>
<listitem><para>If the request fails due to an OpenStack
Compute service error, 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/servers/server-action-attach-volume.json"/>
<xsdxt:code href="../api_samples/servers/server-action-reboot.json"/>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_id" style="plain" type="csapi:UUID"
required="true" id="volume_id">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>The volume ID.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="device" style="plain" type="xsd:string"
required="false" id="device">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>The device name.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="disk_bus" style="plain" type="xsd:string"
required="false" id="disk_bus">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>The disk bus name.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="device_type" style="plain" type="xsd:string"
required="false" id="device_type">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>The device type name.</para>
</wadl:doc>
</param>
&rebootActionRequestParameter;
</representation>
</request>
<response status="202"/>
&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 (rebuild action)">
<para role="shortdesc">
Rebuilds a specified server.
</para>
<para>
Specify the <code>rebuild</code> action in the request body.
</para>
<para>
To rebuild the specified server with preservation of the
ephemeral partition, set the <code>preserve_ephemeral</code>
parameter to <code>true</code>.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/servers/server-action-rebuild-preserve-ephemeral.json"/>
</wadl:doc>
&rebuildActionRequestParameter;
&imageRefRequestParameter;
&serverNameRequestParameter;
&adminPassRequestParameter;
&metadataRequestParameter;
&personalityRequestParameter;
&preserve_ephemeralRequestParameter;
</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/all_extensions/server-action-rebuild-resp.json"/>
</wadl:doc>
</representation>
</response>
<response status="409">
<representation mediaType="application/json"/>
</response>
<!-- All other faults, build, common, get, post/put, and inProgress --> &commonFaults;
&getFaults; &postPutFaults; &buildFaults; &inProgressFault;
</method>
<method name="POST" id="rescue">
&commonFaults;
&getFaults; &postPutFaults; &buildFaults; &inProgressFault; </method>
<method name="POST" id="rescueServer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Rescue server">
title="Rescue server (rescue action)">
<para role="shortdesc">
Puts a server in rescue mode and changes its status to
Puts a specified server in rescue mode and changes its status to
<code>RESCUE</code>.
</para>
<para>
Specify the <code>rescue</code> action in the request body.
</para>
<para>
If you specify the <code>rescue_image_ref</code> extended
attribute, the specified image is used to rescue the instance.
@ -482,17 +332,7 @@
href="../api_samples/os-rescue/server-rescue-req-with-image-ref.json"
/>
</wadl:doc>
<param name="rescue" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Rescue action"
>
<para>
Specify the <code>rescue</code> action in the
request body.
</para>
</wadl:doc>
</param>
&rescueActionRequestParameter;
<param name="adminPass" style="plain"
type="csapi:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -542,13 +382,199 @@
</representation>
</response>
</method>
<method name="POST" id="unrescue">
<method name="POST" id="resizeServer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Unrescue server">
title="Resize server (resize action)">
<para role="shortdesc">
Resizes a specified server.
</para>
<para>
Specify the <code>resize</code> action in the request body.
</para>
<para>
A successfully resized server shows a
<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> or <code>SHUTOFF</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/all_extensions/server-action-resize.json"/>
</wadl:doc>
&resizeActionRequestParameter;
</representation>
</request>
<response status="202"/>
&commonFaults; &getFaults; &postPutFaults; &buildFaults; &inProgressFault;
</method>
<method name="POST" id="revertResizeServer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Revert resized server (revertResize action)">
<para role="shortdesc">
Cancels and reverts a pending resize action for a specified server.
</para>
<para>
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
a status of <code>ACTIVE</code> or <code>SHUTOFF</code>
and a migration_status of <code>reverted</code>. You can
also see the reverted server in the compute node that
OpenStack Compute manages.
</para>
<para>Preconditions</para>
<itemizedlist>
<listitem><para>You can only confirm the resized server where the status
is <code>VERIFY_RESIZE</code> and the 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/servers/server-action-revert-resize.json"/>
</wadl:doc>
&revertResizeActionRequestParameter;
</representation>
</request>
<response status="202"/>
&commonFaults;
&getFaults; &postPutFaults; &buildFaults; &inProgressFault;
</method>
<method name="POST" id="os-startServer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Start server (os-start action)">
<para role="shortdesc">
Starts a specified stopped server and changes
its status to <code>ACTIVE</code>.
</para>
<para>
Specify the <code>os-start</code> action in the request body.</para>
<para>Preconditions</para>
<itemizedlist>
<listitem><para>The server status must be <code>SHUTOFF</code>.
</para></listitem>
<listitem><para>If the specified server is locked, you
must have administrator privileges to start the server.
</para></listitem>
</itemizedlist>
<para>Asynchronous Postconditions</para>
<itemizedlist>
<listitem><para>After you successfully start a server,
its status changes to <code>ACTIVE</code>. The server appears on the compute
node that the Compute service manages.</para></listitem>
</itemizedlist>
<para>Troubleshooting</para>
<itemizedlist>
<listitem>
<para>
If the server status does not change to
<code>ACTIVE</code>, the start operation failed.
Ensure that you meet the preconditions and run the
request again. If the request fails again, investigate
whether another operation is running that causes a
race condition.
</para>
</listitem>
</itemizedlist>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/wadl:docbook"
xml:lang="EN" title="Start server: JSON request">
<xsdxt:code
href="../api_samples/servers/server-action-start.json"
/>
</wadl:doc>
&os-startActionRequestParameter;
</representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="os-stopServer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Stop server (os-stop action)">
<para role="shortdesc">Stops a running server and changes
its status to <code>SHUTOFF</code>.
</para>
<para>
Specify the <code>os-stop</code>
action in the request body.</para>
<para>Preconditions</para>
<itemizedlist>
<listitem><para>The server status must be
<code>ACTIVE</code> or <code>ERROR</code>.
</para></listitem>
<listitem><para>If the specified server is locked,
you must have administrator privileges to stop
the server.</para></listitem>
</itemizedlist>
<para>Asynchronous Postconditions</para>
<itemizedlist>
<listitem><para>After you successfully stop a server,
its status changes to <code>SHUTOFF</code>. The server instance data appears
only on the compute node that Compute service manages.
</para></listitem>
</itemizedlist>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/wadl:docbook"
xml:lang="EN" title="Stop server: JSON request">
<xsdxt:code
href="../api_samples/servers/server-action-stop.json"
/>
</wadl:doc>
&os-stopActionRequestParameter;
</representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="unrescueServer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Unrescue server (unrescue action)">
<para role="shortdesc">
Unrescues a specified server. Changes status to
<code>ACTIVE</code>.
</para>
<para>
Specify the <code>unrescue</code>
action in the request body.
</para>
<para>Preconditions</para>
<itemizedlist>
<listitem><para>The specified server must exist.</para></listitem>
@ -575,17 +601,7 @@
href="../api_samples/os-rescue/server-unrescue-req.json"
/>
</wadl:doc>
<param name="unrescue" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Unrescue action"
>
<para>
Specify the <code>unrescue</code>
action in the request body.
</para>
</wadl:doc>
</param>
&unrescueActionRequestParameter;
</representation>
</request>
<response status="202"/>

4
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-groups-v2.1.wadl
View File

@ -88,7 +88,7 @@
href="../api_samples/os-server-groups/server-groups-post-resp.json"
/>
</wadl:doc>
&serverGroupParameters; </representation>
&securityGroupParameters; </representation>
</response>
</method>
<method name="GET" id="listServerGroups">
@ -149,7 +149,7 @@
href="../api_samples/os-server-groups/server-groups-get-resp.json"
/>
</wadl:doc>
&serverGroupParameters; </representation>
&securityGroupParameters; </representation>
</response>
</method>
<method name="DELETE" id="deleteServerGroup">

80
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-usage-v2.1.wadl
View File

@ -1,80 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2014-2015 OpenStack Foundation, All Rights Reserved -->
<!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:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
xmlns:csapi="http://docs.openstack.org/identity/api/v3"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:db="http://docbook.org/ns/docbook">
<resources base="https://servers.api.openstack.com"
xml:id="os-server-usage-v2.1">
<resource id="v2.1" path="//v2.1">
<resource id="tenant_id" path="{tenant_id}">
&tenantIdRequestParameter;
<resource id="servers" path="servers">
<resource id="detail" path="detail">
<method href="#listServersWithDetails"/>
</resource>
<resource id="server_id" path="{server_id}">
&serverIdRequestParameter;
<method href="#showServer"/>
</resource>
</resource>
</resource>
</resource>
</resources>
<!-- *******************************************************-->
<!-- OS Server Usage -->
<!--*******************************************************-->
<method name="GET" id="showServer">
<wadl:doc xml:lang="EN" title="Show server details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows details for a specified
server. Includes server usage information.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-server-usage/server-get-resp.json"
/>
</wadl:doc>
&x-openstack-request-idHeader;
&serverListDetailsResponseParameters;
&serverAddressResponseParameters;
</representation>
</response>
</method>
<method name="GET" id="listServersWithDetails">
<wadl:doc xml:lang="EN" title="List servers with details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">
Lists servers. Includes server usage details.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
&serverListDetailsParameters;
</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-server-usage/servers-detail-resp.json"
/>
</wadl:doc>
&x-openstack-request-idHeader;
&serverListDetailsResponseParameters;
&serverAddressResponseParameters;
</representation>
</response>
</method>
</application>

41
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-shelve-v2.1.wadl
View File

@ -20,22 +20,22 @@
<resource id="server_id" path="{server_id}">
&serverIdRequestParameter;
<resource id="action" path="action">
<method href="#shelve"/>
<method href="#unshelve"/>
<method href="#shelve-offload"/>
<method href="#shelveServer"/>
<method href="#shelveOffloadServer"/>
<method href="#unshelveServer"/>
</resource>
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="POST" id="shelve">
<method name="POST" id="shelveServer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Shelve server">
<para role="shortdesc">Shelves a server.</para>
title="Shelve server (shelve action)">
<para role="shortdesc">Shelves a specified server.</para>
<para>
Specify the <code>shelve</code> action in the request
body.
Specify the <code>shelve</code> action in the request
body.
</para>
<para>
All associated data and resources are kept but anything still in
@ -107,18 +107,18 @@
href="../api_samples/os-shelve/os-shelve.json"
/>
</wadl:doc>
&shelveAction; </representation>
&shelveActionRequestParameter; </representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="shelve-offload">
<method name="POST" id="shelveOffloadServer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Remove shelved instance">
<para role="shortdesc">Removes an instance from the
server.</para>
title="Remove shelved server (shelveOffload action)">
<para role="shortdesc">
Removes a specified shelved server.
</para>
<para>
Specify the <code>shelveOffload</code> action in the request
body.
Specify the <code>shelveOffload</code> action in the request body.
</para>
<para>Data and resource associations are deleted. If an
instance is no longer needed, you can remove that
@ -164,15 +164,14 @@
href="../api_samples/os-shelve/os-shelve-offload.json"
/>
</wadl:doc>
&shelveOffloadAction; </representation>
&shelveOffloadActionRequestParameter; </representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="unshelve">
<method name="POST" id="unshelveServer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Restore shelved server">
<para role="shortdesc">Restores a shelved server.</para>
<para>
title="Restore shelved server (unshelve action)">
<para role="shortdesc">Restores a shelved server.
Specify the <code>unshelve</code> action in the request
body.
</para>
@ -218,7 +217,7 @@
href="../api_samples/os-shelve/os-unshelve.json"
/>
</wadl:doc>
&unshelveAction; </representation>
&unshelveActionRequestParameter; </representation>
</request>
<response status="202"/>
</method>