|
|
|
@ -9,37 +9,37 @@
|
|
|
|
|
xmlns:linkend="http://www.w3.org/1999/linkend"
|
|
|
|
|
xmlns:xref="http://www.w3.org/1999/xref"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
|
|
|
version="5.0-extension RackBook-2.0" xml:id="compute-ext-v3"
|
|
|
|
|
version="5.0-extension RackBook-2.0" xml:id="compute-ext-v2.1"
|
|
|
|
|
role="api-reference">
|
|
|
|
|
<title>Compute API v3 (EXPERIMENTAL)</title>
|
|
|
|
|
<note><para>XML support in requests and responses has been
|
|
|
|
|
deprecated for the Compute API v3.</para></note>
|
|
|
|
|
<!-- GET v3/extensions does not work -->
|
|
|
|
|
<title>Compute API v2.1 (EXPERIMENTAL)</title>
|
|
|
|
|
<note><para>XML support in requests and responses has been deprecated for the Compute
|
|
|
|
|
API v2.1 (originally referred to as v2.1).</para></note>
|
|
|
|
|
<!-- GET v2.1/extensions does not work -->
|
|
|
|
|
<!-- <para>Query the Compute API to list available extensions with a
|
|
|
|
|
&GET; request to <code>v3/extensions</code>.</para>-->
|
|
|
|
|
<section xml:id="v3versions">
|
|
|
|
|
&GET; request to <code>v2.1/extensions</code>.</para>-->
|
|
|
|
|
<section xml:id="v2.1versions">
|
|
|
|
|
<title>API versions</title>
|
|
|
|
|
<para>List information for all API versions.</para>
|
|
|
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
|
|
|
<wadl:resource
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-versions-v3.wadl#versions">
|
|
|
|
|
<wadl:method href="#listVersionsv3"/>
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-versions-v2.1.wadl#versions">
|
|
|
|
|
<wadl:method href="#listVersionsv2.1"/>
|
|
|
|
|
</wadl:resource>
|
|
|
|
|
<wadl:resource
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-versions-v3.wadl#version">
|
|
|
|
|
<wadl:method href="#showVersionDetailsv3"/>
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-versions-v2.1.wadl#version">
|
|
|
|
|
<wadl:method href="#showVersionDetailsv2.1"/>
|
|
|
|
|
</wadl:resource>
|
|
|
|
|
</wadl:resources>
|
|
|
|
|
</section>
|
|
|
|
|
<section xml:id="v3server">
|
|
|
|
|
<section xml:id="v2.1server">
|
|
|
|
|
<title>Server admin actions (servers)</title>
|
|
|
|
|
<para>Administrators only. Perform actions on a server. Specify
|
|
|
|
|
the action in the request body.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-admin-actions-v3.wadl"
|
|
|
|
|
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="v3agents">
|
|
|
|
|
<section xml:id="v2.1agents">
|
|
|
|
|
<title>Guest agents (os-agents)</title>
|
|
|
|
|
<para>Creates, updates, and deletes guest agents. Use guest agents
|
|
|
|
|
to access files on the disk, configure networking, or run other
|
|
|
|
@ -48,208 +48,208 @@
|
|
|
|
|
Use of guest agents is possible only if the underlying service
|
|
|
|
|
provider uses the Xen driver.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-agents-v3.wadl"
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-agents-v2.1.wadl"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
|
|
|
</section>
|
|
|
|
|
<section xml:id="v3aggregate">
|
|
|
|
|
<section xml:id="v2.1aggregate">
|
|
|
|
|
<title>Host aggregates (os-aggregates)</title>
|
|
|
|
|
<para>Creates and manages host aggregates. An aggregate assigns
|
|
|
|
|
metadata to groups of compute nodes. Aggregates are only visible
|
|
|
|
|
to the cloud provider.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-aggregates-v3.wadl"
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-aggregates-v2.1.wadl"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
|
|
|
</section>
|
|
|
|
|
<section xml:id="v3cell">
|
|
|
|
|
<section xml:id="v2.1cell">
|
|
|
|
|
<title>Cells (os-cells)</title>
|
|
|
|
|
<para>Enables cells-related functionality such as adding neighbor
|
|
|
|
|
cells, listing neighbor cells, and getting the capabilities of
|
|
|
|
|
the local cell.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-cells-v3.wadl"
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-cells-v2.1.wadl"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
|
|
|
</section>
|
|
|
|
|
<section xml:id="v3certificate">
|
|
|
|
|
<section xml:id="v2.1certificate">
|
|
|
|
|
<title>Root certificates (os-certificates)</title>
|
|
|
|
|
<para>Creates and shows details for a root certificate.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-certificates-v3.wadl"
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-certificates-v2.1.wadl"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
|
|
|
</section>
|
|
|
|
|
<section xml:id="v3configdrive">
|
|
|
|
|
<section xml:id="v2.1configdrive">
|
|
|
|
|
<title>Configuration drive (os-config-drive)</title>
|
|
|
|
|
<para>Returns server details for a specific service ID or
|
|
|
|
|
user.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-config-drive-v3.wadl"
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-config-drive-v2.1.wadl"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
|
|
|
</section>
|
|
|
|
|
<section xml:id="v3deferredelete">
|
|
|
|
|
<section xml:id="v2.1deferredelete">
|
|
|
|
|
<title>Server deferred delete (os-deferred-delete)</title>
|
|
|
|
|
<para>Force-deletes a server or restores a deleted server.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-deferred-delete-v3.wadl"
|
|
|
|
|
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="v3evaculation">
|
|
|
|
|
<section xml:id="v2.1evaculation">
|
|
|
|
|
<title>Evacuate (os-evacuate)</title>
|
|
|
|
|
<para>Enables server evacuation.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-evacuate-v3.wadl"
|
|
|
|
|
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="v3availzone">
|
|
|
|
|
<section xml:id="v2.1availzone">
|
|
|
|
|
<title>Servers with extended availability zones
|
|
|
|
|
(os-extended-availability-zone)</title>
|
|
|
|
|
<para>Shows the instance availability zone for compute nodes
|
|
|
|
|
(nova-compute). Internal services appear in their own internal
|
|
|
|
|
availability zone.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-extended-availability-zone-v3.wadl"
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-extended-availability-zone-v2.1.wadl"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
|
|
|
</section>
|
|
|
|
|
<section xml:id="v3extendattributes">
|
|
|
|
|
<section xml:id="v2.1extendattributes">
|
|
|
|
|
<title>Server extended attributes
|
|
|
|
|
(os-extended-server-attributes)</title>
|
|
|
|
|
<para>Shows metadata for servers.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-extended-server-attributes-v3.wadl"
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-extended-server-attributes-v2.1.wadl"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
|
|
|
</section>
|
|
|
|
|
<section xml:id="v3extendedstatus">
|
|
|
|
|
<section xml:id="v2.1extendedstatus">
|
|
|
|
|
<title>Server extended status (os-extended-status)</title>
|
|
|
|
|
<para>Shows extended status information, vm_state, task_state, and
|
|
|
|
|
power_state, in detailed server responses.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-extended-status-v3.wadl"
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-extended-status-v2.1.wadl"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
|
|
|
</section>
|
|
|
|
|
<section xml:id="v3flavoraccess">
|
|
|
|
|
<section xml:id="v2.1flavoraccess">
|
|
|
|
|
<title>Flavor access (os-flavor-access)</title>
|
|
|
|
|
<para>Flavor access support.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-flavor-access-v3.wadl"
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-flavor-access-v2.1.wadl"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
|
|
|
</section>
|
|
|
|
|
<section xml:id="v3flavorspecs">
|
|
|
|
|
<section xml:id="v2.1flavorspecs">
|
|
|
|
|
<title>Flavor extra-specs (flavor-extra-specs)</title>
|
|
|
|
|
<para>Lists, creates, deletes, and updates the extra-specs or keys
|
|
|
|
|
for a flavor.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-flavorspecs-v3.wadl"
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-flavorspecs-v2.1.wadl"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
|
|
|
</section>
|
|
|
|
|
<section xml:id="v3flavormanage">
|
|
|
|
|
<section xml:id="v2.1flavormanage">
|
|
|
|
|
<title>Flavors manage (flavor-manage)</title>
|
|
|
|
|
<para>Support for creating and deleting flavor.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-flavor-manage-v3.wadl"
|
|
|
|
|
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="v3flavortxtx">
|
|
|
|
|
<section xml:id="v2.1flavortxtx">
|
|
|
|
|
<title>Flavors with rxtx_factor extended attribute
|
|
|
|
|
(os-flavor-rxtx)</title>
|
|
|
|
|
<para>Support to show the rxtx status of a flavor.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-flavor-rxtx-v3.wadl"
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-flavor-rxtx-v2.1.wadl"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
|
|
|
</section>
|
|
|
|
|
<section xml:id="v3flavorextend">
|
|
|
|
|
<section xml:id="v2.1flavorextend">
|
|
|
|
|
<title>Flavors with extended attributes (flavors)</title>
|
|
|
|
|
<para>Returns information about Flavors.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-flavors-v3.wadl"
|
|
|
|
|
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="v3hosts">
|
|
|
|
|
<section xml:id="v2.1hosts">
|
|
|
|
|
<title>Hosts (os-hosts)</title>
|
|
|
|
|
<para>Manages physical hosts.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-hosts-v3.wadl"
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-hosts-v2.1.wadl"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
|
|
|
</section>
|
|
|
|
|
<section xml:id="v3hypervisors">
|
|
|
|
|
<section xml:id="v2.1hypervisors">
|
|
|
|
|
<title>Hypervisors (os-hypervisors)</title>
|
|
|
|
|
<para>Displays extra statistical information from the machine that
|
|
|
|
|
hosts the hypervisor through the API for the hypervisor (XenAPI
|
|
|
|
|
or KVM/libvirt).</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-hypervisors-v3.wadl"
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-hypervisors-v2.1.wadl"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
|
|
|
</section>
|
|
|
|
|
<section xml:id="v3instance">
|
|
|
|
|
<section xml:id="v2.1instance">
|
|
|
|
|
<title>Server actions (servers)</title>
|
|
|
|
|
<para>Permits all users to list available actions for a specified
|
|
|
|
|
server. Permits administrators to get details for a specified
|
|
|
|
|
action for a specified server.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-instance-actions-v3.wadl"
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-instance-actions-v2.1.wadl"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
|
|
|
</section>
|
|
|
|
|
<section xml:id="os-instance-usage-audit-log-v3">
|
|
|
|
|
<section xml:id="os-instance-usage-audit-log-v2.1">
|
|
|
|
|
<title>Instance usage audit log
|
|
|
|
|
(os-instance-usage-audit-log)</title>
|
|
|
|
|
<para>Admin-only task log monitoring.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-instance-usage-audit-log-v3.wadl"
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-instance-usage-audit-log-v2.1.wadl"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
|
|
|
</section>
|
|
|
|
|
<section xml:id="v3limits">
|
|
|
|
|
<section xml:id="v2.1limits">
|
|
|
|
|
<title>Limits (limits)</title>
|
|
|
|
|
<para>Provide all global and rate limit information.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-limits-v3.wadl"
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-limits-v2.1.wadl"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
|
|
|
</section>
|
|
|
|
|
<section xml:id="v3migrations">
|
|
|
|
|
<section xml:id="v2.1migrations">
|
|
|
|
|
<title>Migrations (os-migrations)</title>
|
|
|
|
|
<para>Provide data on migrations.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-migrations-v3.wadl"
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-migrations-v2.1.wadl"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
|
|
|
</section>
|
|
|
|
|
<section xml:id="v3multinic">
|
|
|
|
|
<section xml:id="v2.1multinic">
|
|
|
|
|
<title>Multinic (os-multinic)</title>
|
|
|
|
|
<para>Multiple network support.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-multinic-v3.wadl"
|
|
|
|
|
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="v3quotaclasses">
|
|
|
|
|
<section xml:id="v2.1quotaclasses">
|
|
|
|
|
<title>Quota class (os-quota-class-sets)</title>
|
|
|
|
|
<para>Quota classes management support.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-quota-class-sets-v3.wadl"
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-quota-class-sets-v2.1.wadl"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
|
|
|
</section>
|
|
|
|
|
<section xml:id="v3quotasets">
|
|
|
|
|
<section xml:id="v2.1quotasets">
|
|
|
|
|
<title>Quota sets (os-quota-sets)</title>
|
|
|
|
|
<para>Permits administrators, depending on policy settings, to
|
|
|
|
|
view quotas for a tenant and view and update default
|
|
|
|
|
quotas.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-quota-sets-v3.wadl"
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-quota-sets-v2.1.wadl"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
|
|
|
</section>
|
|
|
|
|
<section xml:id="v3remoteconsole">
|
|
|
|
|
<section xml:id="v2.1remoteconsole">
|
|
|
|
|
<title>Server remote console (os-remote-consoles)</title>
|
|
|
|
|
<para>Interactive console support.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-remote-consoles-v3.wadl"
|
|
|
|
|
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-server-usage-v3">
|
|
|
|
|
<section xml:id="os-server-usage-v2.1">
|
|
|
|
|
<title>Server usage (os-server-usage)</title>
|
|
|
|
|
<para>Adds launched_at and terminated_at to servers.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-server-usage-v3.wadl"
|
|
|
|
|
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="v3simpletenant">
|
|
|
|
|
<section xml:id="v2.1simpletenant">
|
|
|
|
|
<title>Usage reports (os-simple-tenant-usage)</title>
|
|
|
|
|
<para>Provide simple tenant usage for tenant.</para>
|
|
|
|
|
<wadl:resources
|
|
|
|
|
href="../wadls/compute-api/src/v3/wadl/os-simple-tenant-usage-v3.wadl"
|
|
|
|
|
href="../wadls/compute-api/src/v2.1/wadl/os-simple-tenant-usage-v2.1.wadl"
|
|
|
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
|
|
|
</section>
|
|
|
|
|
</chapter>
|