13f00a90e9
bug: #1097363 Patchset adds explanation of rxtx to first line displayed (rather than hiding it under details button). Change-Id: I9ce3e99ad63176d63ff428eb120b997bfec7b60f author: diane fleming
396 lines
17 KiB
XML
396 lines
17 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<book xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
version="5.0-extension RackBook-2.0" xml:id="api.openstack.org">
|
|
<info>
|
|
<title>OpenStack APIs</title>
|
|
<copyright>
|
|
<year>2010-2013</year>
|
|
</copyright>
|
|
<legalnotice role="apache2">
|
|
<para/>
|
|
</legalnotice>
|
|
</info>
|
|
<preface xml:id="Overview">
|
|
<title>OpenStack API Reference</title>
|
|
|
|
<para>Use the OpenStack APIs in your OpenStack cloud: Identity
|
|
service, Compute and Compute extensions, Image service, Volumes,
|
|
and Object Storage. You must install the packages for each API
|
|
separately. After you authenticate through the Identity service
|
|
API, you can use the other APIs and extensions to launch server
|
|
instances, create images, assign metadata to instances and
|
|
images, create containers and objects, and complete other
|
|
actions in your OpenStack cloud. </para>
|
|
<para>To get started with the APIs, see the <link
|
|
xlink:href="http://docs.openstack.org/api/quick-start/content/"
|
|
>API Quick Start Guide</link>. For detailed information, <link
|
|
xlink:href="http://docs.openstack.org/api/api-specs.html">read
|
|
descriptions or specifications</link> for each API. </para>
|
|
</preface>
|
|
<chapter xml:id="identity">
|
|
<title>Identity</title>
|
|
<para>Gets an authentication token that permits access to the
|
|
Compute API for 24 hours. The version of the Identity API is
|
|
2.0.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/identity-api/src/service/identity.wadl#tokens">
|
|
<wadl:method href="#authenticate"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/identity-api/src/service/identity.wadl#tenants">
|
|
<wadl:method href="#listTenants"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</chapter>
|
|
<chapter xml:id="compute">
|
|
<title>Compute</title>
|
|
<para>Launches virtual machines based on the images uploaded to
|
|
the system. Also, connects to a server instance securely through
|
|
SSH once it starts and reboots or resizes server instances as
|
|
needed. API v1.1 is identical to API v2.</para>
|
|
<wadl:resources href="../wadls/compute-api/src/os-compute-2.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</chapter>
|
|
<chapter xml:id="compute-ext">
|
|
<title>Compute Extensions</title>
|
|
<para>Adds capabilities to the Compute API beyond those defined in
|
|
the core API. Use extensions to add features, MIME types,
|
|
actions, states, headers, parameters, and resources to the core
|
|
API. Query the Compute API to list available extensions with a
|
|
GET request to v2/extensions.</para>
|
|
<section xml:id="ext-os-createserverext">
|
|
<title>Server - Extended Create</title>
|
|
<para>Shows extra information when you create a server.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-createserverext.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-multi-create">
|
|
<title>Servers - Multiple Create</title>
|
|
<para>Creates multiple servers with an optional reservation
|
|
ID.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-multi-server-create.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-console-output">
|
|
<title>Server Console Output</title>
|
|
<para>Gets the output from the console log for a server.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-console-output.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-server-diagnostics">
|
|
<title>Server Diagnostics</title>
|
|
<para>Gets the usage data for a server.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-diagnostics.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-consoles">
|
|
<title>Server VNC Console</title>
|
|
<para>Accesses a VNC console for a specified server.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-consoles.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-server-password">
|
|
<title>Server Password</title>
|
|
<para>This extension retrieves and resets the encrypted admin
|
|
password set through metadata service.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-server-password.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-server-start-stop">
|
|
<title>Server Start/Stop</title>
|
|
<para>Starts and stops a server.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-server-start-stop.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-rescue">
|
|
<title>Server Rescue</title>
|
|
<para>Rescues or unrescues a server.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-rescue.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-admin-actions">
|
|
<title>Admin Actions</title>
|
|
<para>Permits administrators to perform actions on a
|
|
server.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-admin-actions.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-disk-config">
|
|
<title>Disk Config</title>
|
|
<para>Extends servers and images with a diskConfig
|
|
attribute.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-disk-config.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-deferred-delete">
|
|
<title>Server Force Delete/Restore</title>
|
|
<para>Restores or force-deletes a server when you deploy nova
|
|
with deferred delete on.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-deferred-delete.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-extended-status">
|
|
<title>Extended Instance Status</title>
|
|
<para>Adds vm_state, task_state, and power_state to detailed
|
|
server responses.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-extended-status.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-extended-server-attributes">
|
|
<title>Extended Server Attributes</title>
|
|
<para>Adds metadata to and shows additional metadata for
|
|
servers.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-extended-server-attributes.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-fixed-ips">
|
|
<title>Fixed IPs</title>
|
|
<para>Shows data for a specified fixed IP, such as host name,
|
|
CIDR, and address. Also, reserves or frees a fixed IP.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-fixed-ips.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-floating-ip-addresses">
|
|
<title>Floating IPs</title>
|
|
<para>Assigns and allocates floating IP addresses to instances
|
|
that run in an OpenStack cloud. </para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-floating-ips.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-floating-ips-bulk">
|
|
<title>Floating IPs Bulk</title>
|
|
<para>Bulk creates, deletes, and lists floating IPs. By default,
|
|
the pool is named nova. Use the
|
|
<literal>os-floating-ip-pools</literal> extension to view
|
|
available pools.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-floating-ips-bulk.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-floating-ip-dns">
|
|
<title>Floating IP DNS</title>
|
|
<para>Manages DNS records associated with IP addresses allocated
|
|
by the Floating IPs extension. Requests are dispatched to a
|
|
DNS driver selected at startup. </para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-floating-ip-dns.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-floating-ip-pools">
|
|
<title>Floating IP Pools</title>
|
|
<para>Manages groups of floating IPs.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-floating-ip-pools.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="os-ext-ips">
|
|
<title>Server IP Type</title>
|
|
<para>This extension shows the type of the IPs assigned to an
|
|
instance, either fixed or floating.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-ext-ips.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-aggregates">
|
|
<title>Host 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/ext/os-aggregates.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-agents">
|
|
<title>Agents</title>
|
|
<para>Creates, updates, and deletes guest agents. Use guest
|
|
agents to access files on the disk, configure networking, or
|
|
run other applications or scripts in the guest while it runs.
|
|
This hypervisor-specific extension is not currently enabled
|
|
for KVM. Use of guest agents is possible only if the
|
|
underlying service provider uses the Xen driver.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-agents.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-cloudpipe">
|
|
<title>Cloudpipe</title>
|
|
<para>Manages virtual vpns for projects.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-cloudpipe.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-flavormanage">
|
|
<title>Flavors Create and Delete</title>
|
|
<para>Creates and deletes flavors.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-flavormanage.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="os-flavor-rxtx">
|
|
<title>Flavors with the rxtx_factor Extended Attribute</title>
|
|
<para>Creates a flavor, gets details for a specified flavor, and
|
|
lists details for available flavors. Includes the
|
|
<literal>rxtx_factor</literal> extended attribute, related
|
|
to configured bandwidth cap values. </para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-flavor-rxtx.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="os-flavorextradata">
|
|
<title>Flavors with Extended Attributes</title>
|
|
<para>Creates a flavor, gets details for a flavor, and
|
|
lists details for available flavors. Includes the
|
|
<literal>rxtx_factor</literal>,
|
|
<literal>OS-FLV-EXT-DATA:ephermeral</literal>, and
|
|
<literal>swap</literal> extended attributes.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-flavorextradata.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-keypairs">
|
|
<title>Keypairs</title>
|
|
<para>Generates, imports, and deletes SSH keys.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-keypairs.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-hosts">
|
|
<title>Hosts</title>
|
|
<para>Manages physical hosts.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-hosts.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-hypervisors">
|
|
<title>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/ext/os-hypervisors.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-networks">
|
|
<title>Networks</title>
|
|
<para>Shows network information and deletes networks. Also,
|
|
disassociates a network from a project if you use vlan mode. </para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-networks.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-quota-sets">
|
|
<title>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/ext/os-quota-sets.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-scheduler-hints">
|
|
<title>Scheduler Hints</title>
|
|
<para>Provides information directly to the scheduler when you
|
|
create a server. </para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-scheduler-hints.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-security-groups">
|
|
<title>Security Groups</title>
|
|
<para>Creates, modifies, and deletes security groups and
|
|
rules.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-security-groups.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-simple-tenant-usage">
|
|
<title>Simple Usage</title>
|
|
<para>Reports statistics on compute and storage
|
|
resources.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-simple-tenant-usage.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-virtual-interfaces">
|
|
<title>Virtual Interfaces</title>
|
|
<para>Lists the virtual interfaces for a specified server
|
|
instance.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-virtual-interfaces.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="ext-os-used-limits">
|
|
<title>Used Limits</title>
|
|
<para>Extends limits to show the usage of per project limits.
|
|
Shows information such as RAM or instance quotas usage.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-used-limits.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
</chapter>
|
|
<chapter xml:id="image">
|
|
<title>Image</title>
|
|
<para>Loads images for use at launch time by the Compute API. Some
|
|
cloud implementations do not expose this API and offer
|
|
pre-tested images only. Also, assigns metadata to images. </para>
|
|
<wadl:resources href="../wadls/image-api/src/os-image-1.0.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</chapter>
|
|
<chapter xml:id="volumes">
|
|
<title>Volumes</title>
|
|
<section xml:id="volume">
|
|
<title>Volume</title>
|
|
<para>Manages volumes and snapshots for use with the Volume API
|
|
(nova-volume or cinder services).</para>
|
|
<wadl:resources href="../wadls/volume-api/src/volume-api.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="os-volume">
|
|
<title>Volume Extension to Compute</title>
|
|
<para>Manages volumes and snapshots for use with the Compute
|
|
API.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-volume.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
<section xml:id="volume_attachments">
|
|
<title>Volume Attachments</title>
|
|
<para>Attaches volumes created through the volume API to server
|
|
instances. Also, lists volume attachments for a server
|
|
instance, gets volume details for a volume attachment, and
|
|
deletes a volume attachment.</para>
|
|
<wadl:resources
|
|
href="../wadls/compute-api/src/ext/os-volume_attachments.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</section>
|
|
</chapter>
|
|
<chapter xml:id="object">
|
|
<title>Object Storage</title>
|
|
<para>Manages the accounts, containers and objects in the object
|
|
storage system.</para>
|
|
<wadl:resources
|
|
href="../wadls/object-api/src/os-object-api-1.0.wadl"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
|
</chapter>
|
|
|
|
</book>
|