Set up API page to generate comprehensive PDF of methods
Update formatting as necessary. Create book files for each API service. Chunk information so it's reusable. Clean up WADLs as necessary. Change-Id: Iea3d3a69be8d0904427c480cc6930ba2b5d2f029 Partial-Bug: #1258208 author: Diane Fleming
This commit is contained in:
Diane Fleming
parent
2d9ba521d6
commit
7ecdfab2e0
134
api-ref/pom.xml
134
api-ref/pom.xml
@ -32,22 +32,144 @@
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> api-ref.xml, api-ref-identity.xml,
|
||||
api-ref-compute.xml, api-ref-compute-ext.xml, api-ref-image.xml,
|
||||
api-ref-networking.xml, api-ref-objectstorage.xml,
|
||||
api-ref-blockstorage.xml, api-ref-orchestration.xml,
|
||||
api-ref-telemetry.xml </includes>
|
||||
<profileSecurity>reviewer</profileSecurity>
|
||||
<highlightSource>false</highlightSource>
|
||||
<enableGoogleAnalytics>1</enableGoogleAnalytics>
|
||||
<googleAnalyticsId>UA-17511903-1</googleAnalyticsId>
|
||||
</configuration>
|
||||
</execution>
|
||||
<!-- Configuration for OpenStack API References (pdf) -->
|
||||
<!-- <execution>
|
||||
<id>os-api-ref</id>
|
||||
<goals>
|
||||
<goal>generate-webhelp</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> bk-api-ref.xml </includes>
|
||||
<pdfFilenameBase>api-ref</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution> -->
|
||||
<execution>
|
||||
<id>os-api-ref-blockstorage</id>
|
||||
<goals>
|
||||
<goal>generate-webhelp</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> bk-api-ref-blockstorage.xml </includes>
|
||||
<pdfFilenameBase>api-ref-blockstorage</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-compute</id>
|
||||
<goals>
|
||||
<goal>generate-webhelp</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> bk-api-ref-compute.xml </includes>
|
||||
<pdfFilenameBase>api-ref-compute</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-compute-ext</id>
|
||||
<goals>
|
||||
<goal>generate-webhelp</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> bk-api-ref-compute-ext.xml </includes>
|
||||
<pdfFilenameBase>api-ref-compute-ext</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-identity</id>
|
||||
<goals>
|
||||
<goal>generate-webhelp</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> bk-api-ref-identity.xml </includes>
|
||||
<pdfFilenameBase>api-ref-identity</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-image</id>
|
||||
<goals>
|
||||
<goal>generate-webhelp</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> bk-api-ref-image.xml </includes>
|
||||
<pdfFilenameBase>api-ref-image</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-objectstorage</id>
|
||||
<goals>
|
||||
<goal>generate-webhelp</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> bk-api-ref-objectstorage.xml </includes>
|
||||
<pdfFilenameBase>api-ref-objectstorage</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-networking</id>
|
||||
<goals>
|
||||
<goal>generate-webhelp</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> bk-api-ref-networking.xml </includes>
|
||||
<pdfFilenameBase>api-ref-networking</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-orchestration</id>
|
||||
<goals>
|
||||
<goal>generate-webhelp</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> bk-api-ref-orchestration.xml </includes>
|
||||
<pdfFilenameBase>api-ref-orchestration</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-telemetry</id>
|
||||
<goals>
|
||||
<goal>generate-webhelp</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> bk-api-ref-telemetry.xml </includes>
|
||||
<pdfFilenameBase>api-ref-telemetry</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
<configuration>
|
||||
<!-- These parameters apply to pdf and webhelp -->
|
||||
<generateToc> appendix toc,title
|
||||
article/appendix nop
|
||||
article toc,title
|
||||
book toc,title
|
||||
chapter toc,title
|
||||
section toc, title
|
||||
part toc,title
|
||||
qandadiv toc
|
||||
qandaset toc
|
||||
reference toc,title
|
||||
set toc,title </generateToc>
|
||||
<xincludeSupported>true</xincludeSupported>
|
||||
<sourceDirectory>src/docbkx</sourceDirectory>
|
||||
<includes> api-ref.xml, api-ref-identity.xml,
|
||||
api-ref-compute.xml, api-ref-image.xml,
|
||||
api-ref-networking.xml, api-ref-objectstorage.xml,
|
||||
api-ref-blockstorage.xml, api-ref-orchestration.xml,
|
||||
api-ref-telemetry.xml </includes>
|
||||
<profileSecurity>reviewer</profileSecurity>
|
||||
<branding>openstack</branding>
|
||||
<trimWadlUriCount>1</trimWadlUriCount>
|
||||
<showXslMessages>true</showXslMessages>
|
||||
|
||||
@ -18,9 +18,10 @@
|
||||
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="api.openstack.org">
|
||||
version="5.0-extension RackBook-2.0"
|
||||
xml:id="api.openstack.org-blockstorage">
|
||||
<info>
|
||||
<title>OpenStack Block Storage Service APIs</title>
|
||||
<title>OpenStack Block Storage APIs</title>
|
||||
<copyright>
|
||||
<year>2010-2013</year>
|
||||
</copyright>
|
||||
@ -28,28 +29,5 @@
|
||||
<para/>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<!--<preface xml:id="blockstorage_Overview">
|
||||
<title>OpenStack Block Storage Service API Reference</title>
|
||||
<para>Use the following OpenStack APIs in your OpenStack cloud.
|
||||
You must install the packages for each API separately. After you
|
||||
authenticate through the <link
|
||||
xlink:href="api-ref-identity.html"
|
||||
>Identity Service API</link>, you can use the
|
||||
other APIs and extensions.</para>
|
||||
<para>To get started with the APIs, see the <link
|
||||
xlink:href="http://docs.openstack.org/api/quick-start/content/"
|
||||
>OpenStack API Quick Start</link>. For detailed information,
|
||||
see <link
|
||||
xlink:href="http://docs.openstack.org/api/openstack-block-storage/2.0/content/"
|
||||
><citetitle>OpenStack Block Storage API
|
||||
Reference</citetitle></link>.</para>
|
||||
<para> </para>
|
||||
</preface> -->
|
||||
<chapter xml:id="volumes-api">
|
||||
<title>Block Storage Service API v2.0</title>
|
||||
<para>Manages volumes and snapshots for use with the Block Storage
|
||||
Service API (cinder services).</para>
|
||||
<wadl:resources href="../wadls/volume-api/src/v2/volume-api.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</chapter>
|
||||
<xi:include href="ch_blockstorage-api.xml"/>
|
||||
</book>
|
||||
|
||||
@ -1,442 +1,20 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter[
|
||||
<!-- Some useful entities borrowed from HTML --><!ENTITY ndash "–"><!ENTITY mdash "—"><!ENTITY hellip "…"><!ENTITY plusmn "±"><!ENTITY nbsp " "><!-- Useful for describing APIs --><!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'><!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'><!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'><!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>]>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
<book xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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">
|
||||
<title>Compute API v2 Extensions</title>
|
||||
<para>Adds capabilities to the core Compute 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="action">
|
||||
<title>Server admin actions (action)</title>
|
||||
<para>Permits administrators to perform actions on a server.
|
||||
Specify the action in the request body.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-admin-actions.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
href="../wadls/compute-api/src/ext/os-console-output.wadl"/>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-consoles.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-deferred-delete.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-rescue.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
<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="diagnostics">
|
||||
<title>Server diagnostics (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-flavor-access">
|
||||
<title>Flavor access (flavors)</title>
|
||||
<para>Creates and gets details for private flavors. Also,
|
||||
lists, adds and removes tenants' access to private
|
||||
flavors.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-flavor-access.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-flv-disabled">
|
||||
<title>Flavors with FlavorDisabled attribute (flavors)</title>
|
||||
<para>Gets details for a flavor, and lists
|
||||
details for available flavors. Includes the
|
||||
<literal>OS-FLV-DISABLED:disabled</literal> extended attribute.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-flv-disabled.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-flavor-extra-specs">
|
||||
<title>Flavor extra-specs (os-extra-specs)</title>
|
||||
<para>Lists, creates, and updates the extra-specs or keys for
|
||||
a flavor.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-flavor-extra-specs.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-flavor-rxtx">
|
||||
<title>Flavors with rxtx_factor extended attribute
|
||||
(flavors)</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="ext-os-flavorextradata">
|
||||
<title>Flavors with extended attributes (flavors)</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:ephemeral</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-flavormanage">
|
||||
<title>Flavors create or delete (flavors)</title>
|
||||
<para>Creates or 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="ext-os-ext-img-size">
|
||||
<title>Images with size attribute (images)</title>
|
||||
<para>Lists details for available images or gets details for a
|
||||
specified image. Includes the
|
||||
<code>OS-EXT-IMG-SIZE:size</code> extended attribute,
|
||||
which shows the image size.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-ext-img-size.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-disk-config-images">
|
||||
<title>Images with disk config (images)</title>
|
||||
<para>Extends images with a diskConfig attribute.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/compute-api/src/ext/os-disk-config.wadl#images"
|
||||
/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="limits">
|
||||
<title>Limits with project usage (limits)</title>
|
||||
<para>Extends limits to show the project usage. 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>
|
||||
<section xml:id="compute_limits_admins">
|
||||
<title>Limits with project usage for administrators
|
||||
(limits)</title>
|
||||
<para>Extends limits to enable administrators to show the
|
||||
project usage for a specified customer project ID. Shows
|
||||
information such as RAM or instance quotas usage.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
href="../wadls/compute-api/src/ext/os-used-limits-for-admins.wadl"
|
||||
/>
|
||||
</section>
|
||||
<section xml:id="os-agents">
|
||||
<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 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="os-aggregates">
|
||||
<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/ext/os-aggregates.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-attach-interfaces">
|
||||
<title>Attach interfaces (os-attach-interfaces)</title>
|
||||
<para>Creates, lists, and gets details for port
|
||||
interfaces.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-attach-interfaces.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-certificates">
|
||||
<title>Root certificates (os-certificates)</title>
|
||||
<para>Creates and shows details for a root certificate.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-certificates.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-cloudpipe">
|
||||
<title>Cloudpipe (os-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="os-coverage">
|
||||
<title>Coverage reports (os-coverage)</title>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-coverage.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-fixed-ips">
|
||||
<title>Fixed IPs (os-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="os-floating-ip-dns">
|
||||
<title>Floating IP DNS records (os-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="os-floating-ip-pools">
|
||||
<title>Floating IP pools (os-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-floating-ips">
|
||||
<title>Floating IPs (os-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="os-floating-ips-bulk">
|
||||
<title>Floating IPs bulk (os-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="os-hosts">
|
||||
<title>Hosts (os-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="os-hypervisors">
|
||||
<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/ext/os-hypervisors.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-instance-actions">
|
||||
<title>Server actions (os-instance-actions)</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/ext/os-instance-actions.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-keypairs">
|
||||
<title>Keypairs (os-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="os-migrations">
|
||||
<title>Migrations (os-migrations)</title>
|
||||
<para>Enables administrative users to fetch in-progress
|
||||
migrations for a region or a specified cell in a
|
||||
region.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-migrations.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-networks">
|
||||
<title>Networks (os-networks)</title>
|
||||
<para>Shows network information for or 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="os-quota-sets">
|
||||
<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/ext/os-quota-sets.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-security-groups">
|
||||
<title>Security groups (os-security-groups)</title>
|
||||
<para>Lists, shows information for, creates, and deletes
|
||||
security groups.</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="os-security-group-default-rules">
|
||||
<title>Default security group rules
|
||||
(os-security-group-default-rules)</title>
|
||||
<para>Lists, shows information for, and creates default
|
||||
security group rules.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-security-group-default-rules.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-server-password">
|
||||
<title>Server password (os-server-password)</title>
|
||||
<para>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="os-services">
|
||||
<title>Manage services (os-services)</title>
|
||||
<para>Lists, enables, and disables Compute services in all
|
||||
hosts.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-services.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-simple-tenant-usage">
|
||||
<title>Usage reports (os-simple-tenant-usage)</title>
|
||||
<para>Reports usage 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="os-virtual-interfaces">
|
||||
<title>Virtual interfaces (os-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="os-volume">
|
||||
<title>Volume extension to Compute (os-volumes,
|
||||
os-snapshots)</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="os-volume_attachments">
|
||||
<title>Volume attachments (os-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>
|
||||
<section xml:id="ext-os-block-device-mapping-v2-boot">
|
||||
<title>Servers with block device mapping format
|
||||
(servers)</title>
|
||||
<para>Creates a server with a block device mapping.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-block-device-mapping-v2-boot.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-server-os-ext-ips-mac">
|
||||
<title>Server OS-EXT-IPS-MAC:mac_addr extended attribute
|
||||
(servers)</title>
|
||||
<para>Adds OS-EXT-IPS-MAC:mac_addr extended attribute when you
|
||||
create, show information for, or list servers.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-server-OS-EXT-IPS-MAC.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-disk-config">
|
||||
<title>Disk Config (servers, images)</title>
|
||||
<para>Extends servers and images with a diskConfig
|
||||
attribute.</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-ext-az">
|
||||
<title>Servers with extended availability zones
|
||||
(servers)</title>
|
||||
<para>Shows the instance availability zone for compute nodes
|
||||
(nova-compute). Internal services appear in their own
|
||||
<emphasis role="italic">internal</emphasis>
|
||||
availability zone.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-ext-az.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-disk-config-servers">
|
||||
<title>Servers with disk config (servers)</title>
|
||||
<para>Extends servers with the diskConfig attribute.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/compute-api/src/ext/os-disk-config.wadl#Servers"
|
||||
/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="ext-os-ext-ips">
|
||||
<title>Server IP type (servers)</title>
|
||||
<para>Shows the type of the IP addresses assigned to an
|
||||
instance. Type is 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-extended-server-attributes">
|
||||
<title>Server extended attributes (servers)</title>
|
||||
<para>Shows 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-extended-status">
|
||||
<title>Server extended status (servers)</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/ext/os-extended-status.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-scheduler-hints">
|
||||
<title>Servers with scheduler hints (servers)</title>
|
||||
<para>Creates a server with scheduler hints.</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-multi-server-create">
|
||||
<title>Servers multiple create (servers)</title>
|
||||
<para>Creates one or more servers with an optional reservation
|
||||
ID. The request and response examples show how to create
|
||||
multiple servers with or without a 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>
|
||||
</chapter>
|
||||
version="5.0-extension RackBook-2.0"
|
||||
xml:id="api.openstack.org-compute-ext">
|
||||
<info>
|
||||
<title>OpenStack Compute API extensions</title>
|
||||
<copyright>
|
||||
<year>2010-2014</year>
|
||||
</copyright>
|
||||
<legalnotice role="apache2">
|
||||
<para/>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="ch_compute-ext.xml"/>
|
||||
</book>
|
||||
|
||||
@ -1,21 +1,20 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE book[
|
||||
<!-- Some useful entities borrowed from HTML --><!ENTITY ndash "–"><!ENTITY mdash "—"><!ENTITY hellip "…"><!ENTITY plusmn "±"><!ENTITY nbsp " "><!-- Useful for describing APIs --><!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'><!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'><!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'><!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>]>
|
||||
<?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: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="api.openstack.org">
|
||||
version="5.0-extension RackBook-2.0"
|
||||
xml:id="api.openstack.org-compute">
|
||||
<info>
|
||||
<title>OpenStack Compute APIs and Extensions</title>
|
||||
<title>OpenStack Compute API</title>
|
||||
<copyright>
|
||||
<year>2010-2013</year>
|
||||
<year>2010-2014</year>
|
||||
</copyright>
|
||||
<legalnotice role="apache2">
|
||||
<para/>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="api-ref-compute-core.xml"/>
|
||||
<xi:include href="api-ref-compute-ext.xml"/>
|
||||
<xi:include href="ch_compute-core.xml"/>
|
||||
</book>
|
||||
|
||||
@ -18,9 +18,10 @@
|
||||
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="api.openstack.org">
|
||||
version="5.0-extension RackBook-2.0"
|
||||
xml:id="api.openstack.org-identity">
|
||||
<info>
|
||||
<title>OpenStack Identity Service APIs</title>
|
||||
<title>OpenStack Identity Service APIs and extensions</title>
|
||||
<copyright>
|
||||
<year>2010-2013</year>
|
||||
</copyright>
|
||||
@ -28,405 +29,9 @@
|
||||
<para/>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<chapter xml:id="identity-v3" xlink:href="#identity">
|
||||
<title>Identity Service API v3</title>
|
||||
<para>Gets an authentication token that permits access to the
|
||||
Compute API for 24 hours.</para>
|
||||
<section xml:id="Version_Calls">
|
||||
<title>Versions</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- list version -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#versions"
|
||||
/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<!-- Tokens -->
|
||||
<section xml:id="Token_Calls">
|
||||
<title>Tokens</title>
|
||||
<para>Enables service developers to manage tokens.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- authenticate token -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#tokens"/>
|
||||
<!--<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#token_calls"
|
||||
/> -->
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<!-- Catalog -->
|
||||
<section xml:id="Catalog_Calls">
|
||||
<title>Service catalog</title>
|
||||
<para>Enables service developers to manage the catalog of
|
||||
services.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create service -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#catalog"/>
|
||||
<!-- <wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#listservices"/> -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#catalogID"
|
||||
/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<!-- Endpoints -->
|
||||
<section xml:id="Endpoint_Calls">
|
||||
<title>Endpoints</title>
|
||||
<para>Enables service developers to manage endpoints.</para>
|
||||
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create endpoint -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#endpoints"/>
|
||||
<!-- <wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#listendpoints"/>-->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#endpointsID"/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<!-- Domains -->
|
||||
<section xml:id="Domain_Calls">
|
||||
<title>Domains</title>
|
||||
<para>Enables service developers to manage domains.</para>
|
||||
<para>Domains represent collections of users, groups, and
|
||||
projects. Each is owned by exactly one domain. Users, however,
|
||||
can be associated with multiple projects by granting roles to
|
||||
the user on a project, including projects owned by other
|
||||
domains.</para>
|
||||
<para>Each domain defines a namespace where certain API-visible
|
||||
name attributes exist, which affects whether those names must
|
||||
be globally unique or unique within that domain. In the
|
||||
Identity API, the uniqueness of the following attributes is as
|
||||
follows:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><emphasis role="italic">Domain Name</emphasis>:
|
||||
Globally unique across all domains.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><emphasis role="italic">Role Name</emphasis>: Globally
|
||||
unique across all domains.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><emphasis role="italic">User Name</emphasis>: Unique
|
||||
within the owning domain.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><emphasis role="italic">Project Name</emphasis>:
|
||||
Unique within the owning domain.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><emphasis role="italic">Group Name</emphasis>: Unique
|
||||
within the owning domain.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create domain -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#domains"/>
|
||||
<!-- <wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#listdomains"/> -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#domainID"/>
|
||||
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#domainIDUserIDRoles"/>
|
||||
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#domainIDUserIDRoleID"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#domainIDGroupIDRoles"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#domainIDGroupIDRoleID"/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
|
||||
<!-- Projects -->
|
||||
<section xml:id="Project_Calls">
|
||||
<title>Projects</title>
|
||||
<para>Enables service developers to manage projects.</para>
|
||||
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create project -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projects"/>
|
||||
<!-- <wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#listprojects"/> -->
|
||||
<!-- get project -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projectID"/>
|
||||
|
||||
<!-- list project users -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projectIDUsers"/>
|
||||
|
||||
<!-- list project user roles -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projectIDUserIDRoles"/>
|
||||
|
||||
<!-- check project user role -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projectIDUserIDRoleID"/>
|
||||
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projectIDGroupIDRoles"/>
|
||||
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projectIDGroupIDRoleID"/>
|
||||
|
||||
</wadl:resources>
|
||||
</section>
|
||||
|
||||
<!-- Users -->
|
||||
<section xml:id="User_Calls">
|
||||
<title>Users</title>
|
||||
<para>Enables service developers to manage users.</para>
|
||||
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create user -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#users"/>
|
||||
<!-- <wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#listusers"/> -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#userID"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#userIDGroups"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#userIDProjects"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#userIDRoles"
|
||||
/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
|
||||
<!-- Groups -->
|
||||
<section xml:id="Group_Calls">
|
||||
<title>Groups</title>
|
||||
<para>Enables service developers to manage groups.</para>
|
||||
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create group -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#groups"/>
|
||||
<!-- <wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#listgroups"/>-->
|
||||
<!-- get group -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#groupID"/>
|
||||
|
||||
<!-- list group users -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#groupIDUsers"/>
|
||||
|
||||
<!-- add user to group -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#groupIDUserIDs"/>
|
||||
|
||||
</wadl:resources>
|
||||
</section>
|
||||
|
||||
<!-- Credentials -->
|
||||
<section xml:id="Credential_Calls">
|
||||
<title>Credentials</title>
|
||||
<para>Enables service developers to manage credentials.</para>
|
||||
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create credential -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#credentials"/>
|
||||
<!-- <wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#listcredentials"/>-->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#credentialID"/>
|
||||
|
||||
</wadl:resources>
|
||||
</section>
|
||||
|
||||
<!-- Roles -->
|
||||
<section xml:id="Role_Calls">
|
||||
<title>Roles</title>
|
||||
<para>Enables service developers to manage roles.</para>
|
||||
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create role -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#roles"/>
|
||||
<!-- <wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#listroles"/>-->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#roleID"/>
|
||||
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#roleIDUsers"/>
|
||||
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<!-- Policies -->
|
||||
<section xml:id="Policy_Calls">
|
||||
<title>Policies</title>
|
||||
<para>Enables service developers to manage policies.</para>
|
||||
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create policy -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#policies"/>
|
||||
<!-- <wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#listPolicies"/>-->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#policyID"/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
</chapter>
|
||||
<chapter xml:id="identity_v3_extensions">
|
||||
<title>Identity Service API v3 extensions</title>
|
||||
<para>Adds capabilities to the core Identity Service Admin API
|
||||
v3.</para>
|
||||
<para>Query the Identity Service API to list available extensions
|
||||
with a &GET; request to <code>v3/extensions</code>.</para>
|
||||
<section xml:id="identity_v3_OS-OAUTH1-ext">
|
||||
<title>OS-OAUTH1 extension</title>
|
||||
<para>Enables users to delegate roles to third-party consumers
|
||||
through the <link xlink:href="http://oauth.net/core/1.0a/"
|
||||
>OAuth 1.0a specification</link>.</para>
|
||||
<para>A user is an Identity Service API user who delegates its
|
||||
roles and who authorizes request tokens. A consumer is a
|
||||
third-party application that uses OAuth to access a protected
|
||||
resource. An OAuth-derived token enables admin users to act on
|
||||
behalf of the authorizing user. A request token is a token
|
||||
that the consumer uses to get authorization from the user and
|
||||
exchanges with an OAuth verifier for an access token. The
|
||||
OAuth verifier is a required string that is provided with the
|
||||
corresponding request token in exchange for an access token.
|
||||
An access token is a token that the consumer uses to request
|
||||
Identity Service API tokens on behalf of the authorizing user
|
||||
instead of using the credentials for the user.</para>
|
||||
<para>Request and access tokens use token keys to identify
|
||||
themselves. For OpenStack purposes, the token key is the token
|
||||
ID. The consumer uses a token secret to establish ownership of
|
||||
a specified token. Both request and access tokens have token
|
||||
secrets.</para>
|
||||
<para>Delegated authentication through OAuth occurs as
|
||||
follows:</para>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>A user creates a consumer.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>The consumer gets an unauthorized request token. Then,
|
||||
the consumer uses the request token to initiate user
|
||||
authorization.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>The user authorizes the request token.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>The consumer exchanges the authorized request token
|
||||
and the OAuth verifier for an access token.</para>
|
||||
<para>The authorizing user receives the request token key
|
||||
from the consumer out-of-band.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>The consumer uses the access token to request a
|
||||
Identity Service API token.</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
href="../wadls/identity-api/src/v3/wadl/OS-OAUTH1.wadl"/>
|
||||
</section>
|
||||
</chapter>
|
||||
<chapter xml:id="identity" xlink:href="#identity">
|
||||
<title>Identity Service API v2.0</title>
|
||||
<para>Gets an authentication token that permits access to the
|
||||
Compute API for 24 hours.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/identity.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</chapter>
|
||||
<chapter xml:id="identity-admin-v2.0"
|
||||
xlink:href="#identity-admin-v2.0">
|
||||
<title>Identity Service admin API v2.0</title>
|
||||
<para>Gets an authentication token that permits access to the
|
||||
Compute API for 24 hours.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#tokenById"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#users"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#tenants"
|
||||
/>
|
||||
</wadl:resources>
|
||||
</chapter>
|
||||
<chapter xml:id="identity-v2.0-ext" xlink:href="#identity-v2.0-ext">
|
||||
<title>Identity Service API v2.0 extensions</title>
|
||||
<para>Adds capabilities to the core Identity Service Admin API
|
||||
v2.0.</para>
|
||||
<para>Query the Identity Service API to list available extensions
|
||||
with a &GET; request to <code>v2.0/extensions</code>.</para>
|
||||
<section xml:id="hp-idm-admin-ext">
|
||||
<title>HP-IDM-serviceId extended parameter</title>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/HP-IDM-admin.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-ksadm-admin-ext">
|
||||
<title>OS-KSADM admin extension</title>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-kscatalog-ext">
|
||||
<title>OS-KSCATALOG admin extension</title>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/OS-KSCATALOG-admin.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-ksec2-admin-ext">
|
||||
<title>OS-KSEC2 admin extension</title>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/OS-KSEC2-admin.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-kss3-admin-ext">
|
||||
<title>OS-KSS3 admin extension</title>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/OS-KSS3-admin.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-ksvalidate-ext">
|
||||
<title>OS-KSVALIDATE admin extension</title>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/OS-KSVALIDATE-admin.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="rax-grpadm-ext">
|
||||
<title>RAX-GRPADM admin extension</title>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/RAX-GRPADM.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="rax-ksgrp-admin-ext">
|
||||
<title>RAX-KSGRP admin extension</title>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/RAX-KSGRP-admin.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="rax-kskey-admin-ext">
|
||||
<title>RAX-KSKEY admin extension</title>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/RAX-KSKEY-admin.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="rax-ksqa-admin-ext">
|
||||
<title>RAX-KSQA admin extension</title>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/RAX-KSQA-admin.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
</chapter>
|
||||
<xi:include href="ch_identity-v3.xml"/>
|
||||
<xi:include href="ch_identity-v3-ext.xml"/>
|
||||
<xi:include href="ch_identity-v2.xml"/>
|
||||
<xi:include href="ch_identity-admin-v2.xml"/>
|
||||
<xi:include href="ch_identity-v2-ext.xml"/>
|
||||
</book>
|
||||
|
||||
@ -18,7 +18,8 @@
|
||||
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="api.openstack.org">
|
||||
version="5.0-extension RackBook-2.0"
|
||||
xml:id="api.openstack.org-image">
|
||||
<info>
|
||||
<title>OpenStack Image Service APIs</title>
|
||||
<copyright>
|
||||
@ -28,34 +29,6 @@
|
||||
<para/>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<chapter xml:id="os-images-v2">
|
||||
<title>Image Service API v2</title>
|
||||
<para>Image Service API v2.0, API v2.1, and API v2.2.</para>
|
||||
<section xml:id="image-v2">
|
||||
<title>Images</title>
|
||||
<para>Creates, updates, and deletes image metadata records.
|
||||
Enables users to share images with each other.
|
||||
Also, uploads and downloads raw image data.
|
||||
</para>
|
||||
<wadl:resources
|
||||
href="../wadls/image-api/src/v2/os-image-v2.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="image-schemas-v2">
|
||||
<title>Image Schemas</title>
|
||||
<para>Gets a JSON-schema document that represents an images or
|
||||
image entity.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/image-api/src/v2/os-image-schemas-v2.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
</chapter>
|
||||
<chapter xml:id="os-images-v1">
|
||||
<title>Image Service API v1</title>
|
||||
<para>Loads images for use at launch time by the Compute API.
|
||||
Also, assigns metadata to images. Some cloud implementations do
|
||||
not expose this API and offer pretested images only.</para>
|
||||
<wadl:resources href="../wadls/image-api/src/v1/os-image-1.0.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</chapter>
|
||||
<xi:include href="ch_images-v2.xml"/>
|
||||
<xi:include href="ch_images-v1.xml"/>
|
||||
</book>
|
||||
|
||||
@ -1,26 +1,14 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE book[
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
<!ENTITY nbsp " ">
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
]>
|
||||
<book xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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="api.openstack.org">
|
||||
version="5.0-extension RackBook-2.0"
|
||||
xml:id="api.openstack.org-networking">
|
||||
<info>
|
||||
<title>OpenStack Networking APIs and Extensions</title>
|
||||
<title>OpenStack Networking APIs and extensions</title>
|
||||
<copyright>
|
||||
<year>2010-2014</year>
|
||||
</copyright>
|
||||
@ -28,67 +16,6 @@
|
||||
<para/>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<chapter xml:id="netconn-api">
|
||||
<title>Networking API v2.0</title>
|
||||
<para>Provides virtual networking services among devices that are
|
||||
managed by the OpenStack Compute service. The Networking API
|
||||
v2.0 combines the API v1.1 functionality with some essential
|
||||
Internet Protocol Address Management (IPAM) functionality.
|
||||
Enables users to associate IP address blocks and other network
|
||||
configuration settings with a neutron network. You can choose a
|
||||
specific IP address from the block or let neutron choose the
|
||||
first available IP address.</para>
|
||||
<section xml:id="networks">
|
||||
<title>Networks</title>
|
||||
<para>Lists, shows information for, creates, updates, and
|
||||
deletes networks.</para>
|
||||
<wadl:resources href="../wadls/netconn-api/src/os-networks.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="subnets">
|
||||
<title>Subnets</title>
|
||||
<para>Lists, shows information for, creates, updates, and
|
||||
deletes subnet resources.</para>
|
||||
<wadl:resources href="../wadls/netconn-api/src/os-subnets.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ports">
|
||||
<title>Ports</title>
|
||||
<para>Lists, shows information for, creates, updates, and
|
||||
deletes ports.</para>
|
||||
<wadl:resources href="../wadls/netconn-api/src/os-ports.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
</chapter>
|
||||
<chapter xml:id="netconn-api-ext">
|
||||
<title>Networking API v2.0 Extensions</title>
|
||||
<section xml:id="quotas">
|
||||
<title>Quotas Extension</title>
|
||||
<para>Lists, shows information for, updates, and resets
|
||||
quotas.</para>
|
||||
<wadl:resources href="../wadls/netconn-api/src/os-quotas.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="network_provider">
|
||||
<title>Networks provider extended attributes</title>
|
||||
<wadl:resources
|
||||
href="../wadls/netconn-api/src/os-networks-provider-ext.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="port_binding">
|
||||
<title>Ports binding extended attributes</title>
|
||||
<wadl:resources
|
||||
href="../wadls/netconn-api/src/os-ports-binding-ext.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="security-groups-ext"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<title>Security groups and rules</title>
|
||||
<para>Creates, modifies, and deletes OpenStack Networking
|
||||
security groups and rules.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/netconn-api/src/security-groups.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
</chapter>
|
||||
<xi:include href="ch_netconn-v2.xml"/>
|
||||
<xi:include href="ch_netconn-ext-v2.xml"/>
|
||||
</book>
|
||||
|
||||
@ -18,7 +18,8 @@
|
||||
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="api.openstack.org">
|
||||
version="5.0-extension RackBook-2.0"
|
||||
xml:id="api.openstack.org-objectstorage">
|
||||
<info>
|
||||
<title>OpenStack Object Storage API</title>
|
||||
<copyright>
|
||||
@ -28,12 +29,5 @@
|
||||
<para/>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<chapter xml:id="os-object-api-1.0">
|
||||
<title>Object Storage API v1</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>
|
||||
<xi:include href="ch_objectstorage-v1.xml"/>
|
||||
</book>
|
||||
|
||||
@ -18,7 +18,8 @@
|
||||
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="api.openstack.org">
|
||||
version="5.0-extension RackBook-2.0"
|
||||
xml:id="api.openstack.org-orchestration">
|
||||
<info>
|
||||
<title>OpenStack Orchestration API</title>
|
||||
<copyright>
|
||||
@ -28,12 +29,5 @@
|
||||
<para/>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<chapter xml:id="orchestration-api">
|
||||
<title>Orchestration API v1.0</title>
|
||||
<para>Orchestrates OpenStack services by using a template
|
||||
language.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</chapter>
|
||||
<xi:include href="ch_orchestration-v1.xml"/>
|
||||
</book>
|
||||
|
||||
@ -5,21 +5,16 @@
|
||||
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="api.openstack.org">
|
||||
version="5.0-extension RackBook-2.0"
|
||||
xml:id="api.openstack.org-telemetry">
|
||||
<info>
|
||||
<title>OpenStack Telemetry API</title>
|
||||
<copyright>
|
||||
<year>2013-2013</year>
|
||||
<year>2010-2013</year>
|
||||
</copyright>
|
||||
<legalnotice role="apache2">
|
||||
<para/>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<chapter xml:id="telemetry-api">
|
||||
<title>Telemetry API v2.0</title>
|
||||
<para>Manages all telemetry operations.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</chapter>
|
||||
<xi:include href="ch_telemetry-v2.xml"/>
|
||||
</book>
|
||||
|
||||
@ -1,17 +1,4 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE book[
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
<!ENTITY nbsp " ">
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
]>
|
||||
<book xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
@ -21,68 +8,29 @@
|
||||
xml:id="api.openstack.org">
|
||||
<!-- version="5.0-extension RackBook-2.0" -->
|
||||
<info>
|
||||
<title>OpenStack APIs</title>
|
||||
<title>OpenStack API Reference</title>
|
||||
<titleabbrev>API Reference</titleabbrev>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname/>
|
||||
<surname/>
|
||||
</personname>
|
||||
<affiliation>
|
||||
<orgname>OpenStack Foundation</orgname>
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2010-2013</year>
|
||||
<holder>OpenStack Foundation</holder>
|
||||
</copyright>
|
||||
<productname>OpenStack</productname>
|
||||
<pubdate/>
|
||||
<legalnotice role="apache2">
|
||||
<legalnotice role="cc-by">
|
||||
<annotation>
|
||||
<remark>Copyright details are filled in by the
|
||||
template.</remark>
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<preface xml:id="Overview">
|
||||
<title>OpenStack API Reference</title>
|
||||
<para>Use the following OpenStack APIs in your OpenStack
|
||||
cloud:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><link xlink:href="api-ref-identity.html">Identity
|
||||
Service APIs</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="api-ref-compute.html">Compute API and
|
||||
Extensions</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="api-ref-image.html">Image Service
|
||||
APIs</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="api-ref-blockstorage.html">Block
|
||||
Storage Service API</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="api-ref-networking.html">Networking
|
||||
API</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="api-ref-objectstorage.html">Object
|
||||
Storage API</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="api-ref-orchestration.html"
|
||||
>Orchestration API</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="api-ref-telemetry.html"
|
||||
>Telemetry API</link></para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>You must install the packages for each API separately. After
|
||||
you authenticate through the <link
|
||||
xlink:href="api-ref-identity.html">Identity Service
|
||||
API</link>, 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/"
|
||||
>OpenStack API Quick Start</link>. For detailed information,
|
||||
<link xlink:href="http://docs.openstack.org">read the
|
||||
references</link> for each API.</para>
|
||||
<para> </para>
|
||||
</preface>
|
||||
<xi:include href="preface.xml"/>
|
||||
</book>
|
||||
|
||||
50
api-ref/src/docbkx/bk-api-ref-blockstorage.xml
Normal file
50
api-ref/src/docbkx/bk-api-ref-blockstorage.xml
Normal file
@ -0,0 +1,50 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE book[
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
<!ENTITY nbsp " ">
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
]>
|
||||
<book xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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="api.openstack.org-blockstorage-pdf">
|
||||
<info>
|
||||
<title>OpenStack Block Storage API v2.0 Reference</title>
|
||||
<titleabbrev>API Reference</titleabbrev>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname/>
|
||||
<surname/>
|
||||
</personname>
|
||||
<affiliation>
|
||||
<orgname>OpenStack Foundation</orgname>
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2010-2013</year>
|
||||
<holder>OpenStack Foundation</holder>
|
||||
</copyright>
|
||||
<productname>OpenStack Block Storage</productname>
|
||||
<pubdate/>
|
||||
<legalnotice role="cc-by">
|
||||
<annotation>
|
||||
<remark>Copyright details are filled in by the
|
||||
template.</remark>
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
<xi:include href="ch_blockstorage-api.xml"/>
|
||||
</book>
|
||||
38
api-ref/src/docbkx/bk-api-ref-compute-ext.xml
Normal file
38
api-ref/src/docbkx/bk-api-ref-compute-ext.xml
Normal file
@ -0,0 +1,38 @@
|
||||
<?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: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="api.openstack.org-compute-ext-pdf">
|
||||
<info>
|
||||
<title>OpenStack Compute API v2 Extensions Reference</title>
|
||||
<titleabbrev>API Reference</titleabbrev>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname/>
|
||||
<surname/>
|
||||
</personname>
|
||||
<affiliation>
|
||||
<orgname>OpenStack Foundation</orgname>
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2010-2014</year>
|
||||
<holder>OpenStack Foundation</holder>
|
||||
</copyright>
|
||||
<productname>OpenStack Compute</productname>
|
||||
<pubdate/>
|
||||
<legalnotice role="cc-by">
|
||||
<annotation>
|
||||
<remark>Copyright details are filled in by the
|
||||
template.</remark>
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
<xi:include href="ch_compute-ext.xml"/>
|
||||
</book>
|
||||
|
||||
50
api-ref/src/docbkx/bk-api-ref-compute.xml
Normal file
50
api-ref/src/docbkx/bk-api-ref-compute.xml
Normal file
@ -0,0 +1,50 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE book[
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
<!ENTITY nbsp " ">
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
]>
|
||||
<book xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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="api.openstack.org-compute-pdf">
|
||||
<info>
|
||||
<title>OpenStack Compute API v2 Reference</title>
|
||||
<titleabbrev>API Reference</titleabbrev>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname/>
|
||||
<surname/>
|
||||
</personname>
|
||||
<affiliation>
|
||||
<orgname>OpenStack Foundation</orgname>
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2010-2014</year>
|
||||
<holder>OpenStack Foundation</holder>
|
||||
</copyright>
|
||||
<productname>OpenStack Compute</productname>
|
||||
<pubdate/>
|
||||
<legalnotice role="cc-by">
|
||||
<annotation>
|
||||
<remark>Copyright details are filled in by the
|
||||
template.</remark>
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
<xi:include href="ch_compute-core.xml"/>
|
||||
</book>
|
||||
53
api-ref/src/docbkx/bk-api-ref-identity.xml
Normal file
53
api-ref/src/docbkx/bk-api-ref-identity.xml
Normal file
@ -0,0 +1,53 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE book[
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
<!ENTITY nbsp " ">
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
]>
|
||||
<book xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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="api.openstack.org-identity-pdf">
|
||||
<info>
|
||||
<title>OpenStack Identity Service API Reference</title>
|
||||
<titleabbrev>Identity Service API Reference</titleabbrev>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname/>
|
||||
<surname/>
|
||||
</personname>
|
||||
<affiliation>
|
||||
<orgname>OpenStack Foundation</orgname>
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2010-2013</year>
|
||||
<holder>OpenStack Foundation</holder>
|
||||
</copyright>
|
||||
<productname>OpenStack Identity Service</productname>
|
||||
<pubdate/>
|
||||
<legalnotice role="cc-by">
|
||||
<annotation>
|
||||
<remark>Copyright details are filled in by the
|
||||
template.</remark>
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
<xi:include href="ch_identity-v3.xml"/>
|
||||
<xi:include href="ch_identity-v3-ext.xml"/>
|
||||
<xi:include href="ch_identity-v2.xml"/>
|
||||
<xi:include href="ch_identity-admin-v2.xml"/>
|
||||
<xi:include href="ch_identity-v2-ext.xml"/>
|
||||
</book>
|
||||
38
api-ref/src/docbkx/bk-api-ref-image.xml
Normal file
38
api-ref/src/docbkx/bk-api-ref-image.xml
Normal file
@ -0,0 +1,38 @@
|
||||
<?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: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="api.openstack.org-image-pdf">
|
||||
<info>
|
||||
<title>OpenStack Image Service API v2 and API v1 Reference</title>
|
||||
<titleabbrev>API Reference</titleabbrev>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname/>
|
||||
<surname/>
|
||||
</personname>
|
||||
<affiliation>
|
||||
<orgname>OpenStack Foundation</orgname>
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2010-2013</year>
|
||||
<holder>OpenStack Foundation</holder>
|
||||
</copyright>
|
||||
<productname>OpenStack Image Service</productname>
|
||||
<pubdate/>
|
||||
<legalnotice role="cc-by">
|
||||
<annotation>
|
||||
<remark>Copyright details are filled in by the
|
||||
template.</remark>
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
<xi:include href="ch_images-v2.xml"/>
|
||||
<xi:include href="ch_images-v1.xml"/>
|
||||
</book>
|
||||
41
api-ref/src/docbkx/bk-api-ref-networking.xml
Normal file
41
api-ref/src/docbkx/bk-api-ref-networking.xml
Normal file
@ -0,0 +1,41 @@
|
||||
<?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: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="api.openstack.org-networking-pdf">
|
||||
<info>
|
||||
<title>OpenStack Networking API v2.0 and Extensions
|
||||
Reference</title>
|
||||
<?rax title.font.size="32px"?>
|
||||
<?rax subtitle.font.size="32px"?>
|
||||
<titleabbrev>Networking API Reference</titleabbrev>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname/>
|
||||
<surname/>
|
||||
</personname>
|
||||
<affiliation>
|
||||
<orgname>OpenStack Foundation</orgname>
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2010-2013</year>
|
||||
<holder>OpenStack Foundation</holder>
|
||||
</copyright>
|
||||
<productname>OpenStack Networking</productname>
|
||||
<pubdate/>
|
||||
<legalnotice role="cc-by">
|
||||
<annotation>
|
||||
<remark>Copyright details are filled in by the
|
||||
template.</remark>
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
<xi:include href="ch_netconn-v2.xml"/>
|
||||
<xi:include href="ch_netconn-ext-v2.xml"/>
|
||||
</book>
|
||||
37
api-ref/src/docbkx/bk-api-ref-objectstorage.xml
Normal file
37
api-ref/src/docbkx/bk-api-ref-objectstorage.xml
Normal file
@ -0,0 +1,37 @@
|
||||
<?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: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="api.openstack.org-objectstorage-pdf">
|
||||
<info>
|
||||
<title>OpenStack Object Storage API v1 Reference</title>
|
||||
<titleabbrev>API Reference</titleabbrev>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname/>
|
||||
<surname/>
|
||||
</personname>
|
||||
<affiliation>
|
||||
<orgname>OpenStack Foundation</orgname>
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2010-2013</year>
|
||||
<holder>OpenStack Foundation</holder>
|
||||
</copyright>
|
||||
<productname>OpenStack Object Storage</productname>
|
||||
<pubdate/>
|
||||
<legalnotice role="cc-by">
|
||||
<annotation>
|
||||
<remark>Copyright details are filled in by the
|
||||
template.</remark>
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
<xi:include href="ch_objectstorage-v1.xml"/>
|
||||
</book>
|
||||
37
api-ref/src/docbkx/bk-api-ref-orchestration.xml
Normal file
37
api-ref/src/docbkx/bk-api-ref-orchestration.xml
Normal file
@ -0,0 +1,37 @@
|
||||
<?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: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="api.openstack.org-orchestration-pdf">
|
||||
<info>
|
||||
<title>OpenStack Orchestration API v1.0 Reference</title>
|
||||
<titleabbrev>Orchestration API Reference</titleabbrev>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname/>
|
||||
<surname/>
|
||||
</personname>
|
||||
<affiliation>
|
||||
<orgname>OpenStack Foundation</orgname>
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2010-2013</year>
|
||||
<holder>OpenStack Foundation</holder>
|
||||
</copyright>
|
||||
<productname>OpenStack Orchestration</productname>
|
||||
<pubdate/>
|
||||
<legalnotice role="cc-by">
|
||||
<annotation>
|
||||
<remark>Copyright details are filled in by the
|
||||
template.</remark>
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
<xi:include href="ch_orchestration-v1.xml"/>
|
||||
</book>
|
||||
37
api-ref/src/docbkx/bk-api-ref-telemetry.xml
Normal file
37
api-ref/src/docbkx/bk-api-ref-telemetry.xml
Normal file
@ -0,0 +1,37 @@
|
||||
<?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: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="api.openstack.org-telemetry-pdf">
|
||||
<info>
|
||||
<title>OpenStack Metering API v2.0 Reference</title>
|
||||
<titleabbrev>Metering API Reference</titleabbrev>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname/>
|
||||
<surname/>
|
||||
</personname>
|
||||
<affiliation>
|
||||
<orgname>OpenStack Foundation</orgname>
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2010-2013</year>
|
||||
<holder>OpenStack Foundation</holder>
|
||||
</copyright>
|
||||
<productname>OpenStack Metering</productname>
|
||||
<pubdate/>
|
||||
<legalnotice role="cc-by">
|
||||
<annotation>
|
||||
<remark>Copyright details are filled in by the
|
||||
template.</remark>
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
<xi:include href="ch_telemetry-v2.xml"/>
|
||||
</book>
|
||||
51
api-ref/src/docbkx/bk-api-ref.xml
Normal file
51
api-ref/src/docbkx/bk-api-ref.xml
Normal file
@ -0,0 +1,51 @@
|
||||
<?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: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="api.openstack.org-pdf">
|
||||
<info>
|
||||
<title>OpenStack API Reference</title>
|
||||
<titleabbrev>API Reference</titleabbrev>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname/>
|
||||
<surname/>
|
||||
</personname>
|
||||
<affiliation>
|
||||
<orgname>OpenStack Foundation</orgname>
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2010-2013</year>
|
||||
<holder>OpenStack Foundation</holder>
|
||||
</copyright>
|
||||
<productname>OpenStack</productname>
|
||||
<pubdate/>
|
||||
<legalnotice role="cc-by">
|
||||
<annotation>
|
||||
<remark>Copyright details are filled in by the
|
||||
template.</remark>
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
<xi:include href="ch_blockstorage-api.xml"/>
|
||||
<xi:include href="ch_compute-core.xml"/>
|
||||
<xi:include href="ch_compute-ext.xml"/>
|
||||
<xi:include href="ch_identity-v3.xml"/>
|
||||
<xi:include href="ch_identity-v3-ext.xml"/>
|
||||
<xi:include href="ch_identity-v2.xml"/>
|
||||
<xi:include href="ch_identity-admin-v2.xml"/>
|
||||
<xi:include href="ch_identity-v2-ext.xml"/>
|
||||
<xi:include href="ch_images-v2.xml"/>
|
||||
<xi:include href="ch_images-v1.xml"/>
|
||||
<xi:include href="ch_netconn-v2.xml"/>
|
||||
<xi:include href="ch_netconn-ext-v2.xml"/>
|
||||
<xi:include href="ch_objectstorage-v1.xml"/>
|
||||
<xi:include href="ch_orchestration-v1.xml"/>
|
||||
<xi:include href="ch_telemetry-v2.xml"/>
|
||||
</book>
|
||||
78
api-ref/src/docbkx/ch_blockstorage-api.xml
Normal file
78
api-ref/src/docbkx/ch_blockstorage-api.xml
Normal file
@ -0,0 +1,78 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter[
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
<!ENTITY nbsp " ">
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
]>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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="blockstorage-v2">
|
||||
<title>Block Storage API v2.0</title>
|
||||
<para>Manages volumes and snapshots for use with the Block Storage
|
||||
API, also known as cinder services.</para>
|
||||
<section xml:id="volumes">
|
||||
<title>Volumes</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/volume-api/src/v2/volume-api.wadl#volumes">
|
||||
<wadl:method href="#createVolume"/>
|
||||
<wadl:method href="#getVolumesSimple"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/volume-api/src/v2/volume-api.wadl#detail">
|
||||
<wadl:method href="#getVolumesDetail"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/volume-api/src/v2/volume-api.wadl#volume_id">
|
||||
<wadl:method href="#getVolume"/>
|
||||
<wadl:method href="#updateVolume"/>
|
||||
<wadl:method href="#deleteVolume"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="volume_types">
|
||||
<title>Volume types</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/volume-api/src/v2/volume-api.wadl#types">
|
||||
<wadl:method href="#getVolumeTypes"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/volume-api/src/v2/volume-api.wadl#volume_type_id">
|
||||
<wadl:method href="#getVolumeType"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="snapshots">
|
||||
<title>Snapshots</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/volume-api/src/v2/volume-api.wadl#snapshots">
|
||||
<wadl:method href="#createSnapshot"/>
|
||||
<wadl:method href="#getSnapshotsSimple"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/volume-api/src/v2/volume-api.wadl#detail-snapshot">
|
||||
<wadl:method href="#getSnapshotsDetail"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/volume-api/src/v2/volume-api.wadl#snapshot_id">
|
||||
<wadl:method href="#getSnapshot"/>
|
||||
<wadl:method href="#updateSnapshot"/>
|
||||
<wadl:method href="#deleteSnapshot"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
</chapter>
|
||||
@ -1,19 +1,30 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter[
|
||||
<!-- Some useful entities borrowed from HTML --><!ENTITY ndash "–"><!ENTITY mdash "—"><!ENTITY hellip "…"><!ENTITY plusmn "±"><!ENTITY nbsp " "><!-- Useful for describing APIs --><!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'><!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'><!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'><!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>]>
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
<!ENTITY nbsp " ">
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
]>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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">
|
||||
version="5.0-extension RackBook-2.0" xml:id="compute-core-v2">
|
||||
<title>Compute API v2</title>
|
||||
<para>Launches virtual machines from images or images stored on
|
||||
persistent volumes. API v1.1 is identical to API v2.</para>
|
||||
<section xml:id="compute_versions">
|
||||
<title>Versions</title>
|
||||
<para>Get information about a specific version of the
|
||||
<para>Gets information about a specific version of the
|
||||
API.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
@ -72,7 +83,7 @@
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="compute_server_metadata">
|
||||
<title>Server Metadata</title>
|
||||
<title>Server metadata</title>
|
||||
<para>Sets, lists, gets details for, and deletes server
|
||||
metadata or metadata items.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
@ -92,7 +103,7 @@
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="compute_server-addresses">
|
||||
<title>Server Addresses</title>
|
||||
<title>Server addresses</title>
|
||||
<para>Lists addresses for a specified server or a specified
|
||||
server and network.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
@ -104,7 +115,7 @@
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="compute_server-actions">
|
||||
<title>Server Actions</title>
|
||||
<title>Server actions</title>
|
||||
<para>Performs actions for a specified server, including
|
||||
change administrator password, reboot, rebuild, resize,
|
||||
and create image from server.</para>
|
||||
@ -170,7 +181,7 @@
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="compute_image_metadata">
|
||||
<title>Image Metadata</title>
|
||||
<title>Image metadata</title>
|
||||
<para>Sets, lists, gets details for, and deletes image
|
||||
metadata or metadata items.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
466
api-ref/src/docbkx/ch_compute-ext.xml
Normal file
466
api-ref/src/docbkx/ch_compute-ext.xml
Normal file
@ -0,0 +1,466 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter[
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
<!ENTITY nbsp " ">
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
]>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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-v2">
|
||||
<title>Compute API v2 extensions</title>
|
||||
<para>Adds capabilities to the core Compute 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-action">
|
||||
<title>Server admin actions (action)</title>
|
||||
<para>Permits administrators to perform actions on a server.
|
||||
Specify the action in the request body.</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-console-output">
|
||||
<title>Server console output (os-console-output)</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/ext/os-console-output.wadl"
|
||||
/>
|
||||
</section>
|
||||
<section xml:id="ext-os-consoles">
|
||||
<title>Server console (os-consoles)</title>
|
||||
<para>Gets a console for a server instance.</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-deferred-delete">
|
||||
<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/ext/os-deferred-delete.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-diagnostics">
|
||||
<title>Server diagnostics (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-flavor-access">
|
||||
<title>Flavor access (flavors)</title>
|
||||
<para>Creates and gets details for private flavors. Also,
|
||||
lists, adds and removes tenants' access to private
|
||||
flavors.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-flavor-access.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-flv-disabled">
|
||||
<title>Flavors with FlavorDisabled attribute (flavors)</title>
|
||||
<para>Gets details for a flavor, and lists details for
|
||||
available flavors. Includes the
|
||||
<literal>OS-FLV-DISABLED:disabled</literal> extended
|
||||
attribute.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-flv-disabled.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-flavor-extra-specs">
|
||||
<title>Flavor extra-specs (os-extra-specs)</title>
|
||||
<para>Lists, creates, and updates the extra-specs or keys for
|
||||
a flavor.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-flavor-extra-specs.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-flavor-rxtx">
|
||||
<title>Flavors with rxtx_factor extended attribute
|
||||
(flavors)</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="ext-os-flavorextradata">
|
||||
<title>Flavors with extended attributes (flavors)</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:ephemeral</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-flavormanage">
|
||||
<title>Flavors create or delete (flavors)</title>
|
||||
<para>Creates or 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="ext-os-ext-img-size">
|
||||
<title>Images with size attribute (images)</title>
|
||||
<para>Lists details for available images or gets details for a
|
||||
specified image. Includes the
|
||||
<code>OS-EXT-IMG-SIZE:size</code> extended attribute,
|
||||
which shows the image size.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-ext-img-size.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-limits">
|
||||
<title>Limits with project usage (limits)</title>
|
||||
<para>Extends limits to show the project usage. 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>
|
||||
<section xml:id="ext-compute_limits_admins">
|
||||
<title>Limits with project usage for administrators
|
||||
(limits)</title>
|
||||
<para>Extends limits to enable administrators to show the
|
||||
project usage for a specified customer project ID. Shows
|
||||
information such as RAM or instance quotas usage.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
href="../wadls/compute-api/src/ext/os-used-limits-for-admins.wadl"
|
||||
/>
|
||||
</section>
|
||||
<section xml:id="ext-os-agents">
|
||||
<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 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-aggregates">
|
||||
<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/ext/os-aggregates.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-attach-interfaces">
|
||||
<title>Attach interfaces (os-attach-interfaces)</title>
|
||||
<para>Creates, lists, and gets details for port
|
||||
interfaces.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-attach-interfaces.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-certificates">
|
||||
<title>Root certificates (os-certificates)</title>
|
||||
<para>Creates and shows details for a root certificate.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-certificates.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-cloudpipe">
|
||||
<title>Cloudpipe (os-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-coverage">
|
||||
<title>Coverage reports (os-coverage)</title>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-coverage.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-fixed-ips">
|
||||
<title>Fixed IPs (os-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-os-floating-ip-dns">
|
||||
<title>Floating IP DNS records (os-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-os-floating-ip-pools">
|
||||
<title>Floating IP pools (os-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="ext-os-floating-ips">
|
||||
<title>Floating IPs (os-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-os-floating-ips-bulk">
|
||||
<title>Floating IPs bulk (os-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-hosts">
|
||||
<title>Hosts (os-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 (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/ext/os-hypervisors.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-instance-actions">
|
||||
<title>Server actions (os-instance-actions)</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/ext/os-instance-actions.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-keypairs">
|
||||
<title>Keypairs (os-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-migrations">
|
||||
<title>Migrations (os-migrations)</title>
|
||||
<para>Enables administrative users to fetch in-progress
|
||||
migrations for a region or a specified cell in a
|
||||
region.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-migrations.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-networks">
|
||||
<title>Networks (os-networks)</title>
|
||||
<para>Shows network information for or 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 (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/ext/os-quota-sets.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-rescue">
|
||||
<title>Server rescue and unrescue (os-rescue)</title>
|
||||
<para>Puts a server into rescue mode or unrescues a server in
|
||||
rescue mode.</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-server-start-stop">
|
||||
<title>Server start and stop (os-server-start-stop)</title>
|
||||
<para>Starts a stopped server or stops a running
|
||||
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-security-groups">
|
||||
<title>Security groups (os-security-groups)</title>
|
||||
<para>Lists, shows information for, creates, and deletes
|
||||
security groups.</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-security-group-default-rules">
|
||||
<title>Rules for default security group
|
||||
(os-security-group-default-rules)</title>
|
||||
<para>Lists, shows information for, and creates default
|
||||
security group rules.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-security-group-default-rules.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-server-password">
|
||||
<title>Server password (os-server-password)</title>
|
||||
<para>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-services">
|
||||
<title>Manage services (os-services)</title>
|
||||
<para>Lists, enables, and disables Compute services in all
|
||||
hosts.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-services.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-simple-tenant-usage">
|
||||
<title>Usage reports (os-simple-tenant-usage)</title>
|
||||
<para>Reports usage 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 (os-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-volume">
|
||||
<title>Volume extension (os-volumes, os-snapshots)</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="ext-os-volume_attachments">
|
||||
<title>Volume attachments (os-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>
|
||||
<section xml:id="ext-os-block-device-mapping-v2-boot">
|
||||
<title>Servers with block device mapping format
|
||||
(servers)</title>
|
||||
<para>Creates a server with a block device mapping.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-block-device-mapping-v2-boot.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-server-os-ext-ips-mac">
|
||||
<title>Server OS-EXT-IPS-MAC:mac_addr extended attribute
|
||||
(servers)</title>
|
||||
<para>Adds OS-EXT-IPS-MAC:mac_addr extended attribute when you
|
||||
create, show information for, or list servers.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-server-OS-EXT-IPS-MAC.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-createserverext">
|
||||
<title>Configuration drive (servers)</title>
|
||||
<para>Extends servers and images with a configuration
|
||||
drive.</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-ext-az">
|
||||
<title>Servers with extended availability zones
|
||||
(servers)</title>
|
||||
<para>Shows the instance availability zone for compute nodes
|
||||
(nova-compute). Internal services appear in their own
|
||||
<emphasis role="italic">internal</emphasis>
|
||||
availability zone.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/ext/os-ext-az.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-disk-config-servers">
|
||||
<title>Servers and images with disk config (servers,
|
||||
images)</title>
|
||||
<para>Extends servers with the diskConfig attribute.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
href="../wadls/compute-api/src/ext/os-disk-config.wadl"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-ext-ips">
|
||||
<title>Server IP type (servers)</title>
|
||||
<para>Shows the type of the IP addresses assigned to an
|
||||
instance. Type is 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-extended-server-attributes">
|
||||
<title>Server extended attributes (servers)</title>
|
||||
<para>Shows 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-extended-status">
|
||||
<title>Server extended status (servers)</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/ext/os-extended-status.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-scheduler-hints">
|
||||
<title>Servers with scheduler hints (servers)</title>
|
||||
<para>Creates a server with scheduler hints.</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-multi-server-create">
|
||||
<title>Servers multiple create (servers)</title>
|
||||
<para>Creates one or more servers with an optional reservation
|
||||
ID. The request and response examples show how to create
|
||||
multiple servers with or without a 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>
|
||||
</chapter>
|
||||
24
api-ref/src/docbkx/ch_identity-admin-v2.xml
Normal file
24
api-ref/src/docbkx/ch_identity-admin-v2.xml
Normal file
@ -0,0 +1,24 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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="identity-admin-v2"
|
||||
xlink:href="#identity-admin-v2">
|
||||
<title>Identity Service admin API v2.0</title>
|
||||
<para>Gets an authentication token that permits access to the
|
||||
Compute API for 24 hours.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#tokenById"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#users"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#tenants"
|
||||
/>
|
||||
</wadl:resources>
|
||||
</chapter>
|
||||
88
api-ref/src/docbkx/ch_identity-v2-ext.xml
Normal file
88
api-ref/src/docbkx/ch_identity-v2-ext.xml
Normal file
@ -0,0 +1,88 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter[
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
<!ENTITY nbsp " ">
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
]>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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="identity-v2-ext"
|
||||
xlink:href="#identity-v2-ext">
|
||||
<title>Identity Service API v2.0 extensions</title>
|
||||
<para>Adds capabilities to the core Identity Service Admin API
|
||||
v2.0.</para>
|
||||
<para>Query the Identity Service API to list available extensions
|
||||
with a &GET; request to <code>v2.0/extensions</code>.</para>
|
||||
<section xml:id="hp-idm-admin-ext">
|
||||
<title>HP-IDM-serviceId extended parameter</title>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/HP-IDM-admin.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-ksadm-admin-ext">
|
||||
<title>OS-KSADM admin extension</title>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-kscatalog-ext">
|
||||
<title>OS-KSCATALOG admin extension</title>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/OS-KSCATALOG-admin.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-ksec2-admin-ext">
|
||||
<title>OS-KSEC2 admin extension</title>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/OS-KSEC2-admin.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-kss3-admin-ext">
|
||||
<title>OS-KSS3 admin extension</title>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/OS-KSS3-admin.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="os-ksvalidate-ext">
|
||||
<title>OS-KSVALIDATE admin extension</title>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/OS-KSVALIDATE-admin.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="rax-grpadm-ext">
|
||||
<title>RAX-GRPADM admin extension</title>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/RAX-GRPADM.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="rax-ksgrp-admin-ext">
|
||||
<title>RAX-KSGRP admin extension</title>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/RAX-KSGRP-admin.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="rax-kskey-admin-ext">
|
||||
<title>RAX-KSKEY admin extension</title>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/RAX-KSKEY-admin.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="rax-ksqa-admin-ext">
|
||||
<title>RAX-KSQA admin extension</title>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/RAX-KSQA-admin.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
</chapter>
|
||||
29
api-ref/src/docbkx/ch_identity-v2.xml
Normal file
29
api-ref/src/docbkx/ch_identity-v2.xml
Normal file
@ -0,0 +1,29 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter[
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
<!ENTITY nbsp " ">
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
]>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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="identity-v2"
|
||||
xlink:href="#identity-v2">
|
||||
<title>Identity Service API v2.0</title>
|
||||
<para>Gets an authentication token that permits access to the
|
||||
Compute API for 24 hours.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v2.0/wadl/identity.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</chapter>
|
||||
80
api-ref/src/docbkx/ch_identity-v3-ext.xml
Normal file
80
api-ref/src/docbkx/ch_identity-v3-ext.xml
Normal file
@ -0,0 +1,80 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter [
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
<!ENTITY nbsp " ">
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
]>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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="identity-v3-ext"
|
||||
xlink:href="#identity-v3-ext">
|
||||
<title>Identity Service API v3 extensions</title>
|
||||
<para>Adds capabilities to the core Identity Service Admin API
|
||||
v3.</para>
|
||||
<para>Query the Identity Service API to list available extensions
|
||||
with a &GET; request to <code>v3/extensions</code>.</para>
|
||||
<section xml:id="identity_v3_OS-OAUTH1-ext">
|
||||
<title>OS-OAUTH1 extension</title>
|
||||
<para>Enables users to delegate roles to third-party consumers
|
||||
through the <link xlink:href="http://oauth.net/core/1.0a/"
|
||||
>OAuth 1.0a specification</link>.</para>
|
||||
<para>A user is an Identity Service API user who delegates its
|
||||
roles and who authorizes request tokens. A consumer is a
|
||||
third-party application that uses OAuth to access a
|
||||
protected resource. An OAuth-derived token enables admin
|
||||
users to act on behalf of the authorizing user. A request
|
||||
token is a token that the consumer uses to get
|
||||
authorization from the user and exchanges with an OAuth
|
||||
verifier for an access token. The OAuth verifier is a
|
||||
required string that is provided with the corresponding
|
||||
request token in exchange for an access token. An access
|
||||
token is a token that the consumer uses to request
|
||||
Identity Service API tokens on behalf of the authorizing
|
||||
user instead of using the credentials for the user.</para>
|
||||
<para>Request and access tokens use token keys to identify
|
||||
themselves. For OpenStack purposes, the token key is the
|
||||
token ID. The consumer uses a token secret to establish
|
||||
ownership of a specified token. Both request and access
|
||||
tokens have token secrets.</para>
|
||||
<para>Delegated authentication through OAuth occurs as
|
||||
follows:</para>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>A user creates a consumer.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>The consumer gets an unauthorized request token.
|
||||
Then, the consumer uses the request token to
|
||||
initiate user authorization.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>The user authorizes the request token.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>The consumer exchanges the authorized request
|
||||
token and the OAuth verifier for an access
|
||||
token.</para>
|
||||
<para>The authorizing user receives the request token
|
||||
key from the consumer out-of-band.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>The consumer uses the access token to request a
|
||||
Identity Service API token.</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
<!--<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
href="../wadls/identity-api/src/v3/wadl/OS-OAUTH1.wadl"/>-->
|
||||
</section>
|
||||
</chapter>
|
||||
233
api-ref/src/docbkx/ch_identity-v3.xml
Normal file
233
api-ref/src/docbkx/ch_identity-v3.xml
Normal file
@ -0,0 +1,233 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter [
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
<!ENTITY nbsp " ">
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
]>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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="identity-v3"
|
||||
xlink:href="#identity-v3">
|
||||
<title>Identity Service API v3</title>
|
||||
<para>Gets an authentication token that permits access to the
|
||||
Compute API for 24 hours.</para>
|
||||
<section xml:id="Version_Calls">
|
||||
<title>Versions</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- list version -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#versions"
|
||||
/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<!-- Tokens -->
|
||||
<section xml:id="Token_Calls">
|
||||
<title>Tokens</title>
|
||||
<para>Enables service developers to manage tokens.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- authenticate token -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#tokens"
|
||||
/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<!-- Catalog -->
|
||||
<section xml:id="Catalog_Calls">
|
||||
<title>Service catalog</title>
|
||||
<para>Enables service developers to manage the catalog of
|
||||
services.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create service -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#catalog"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#catalogID"
|
||||
/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<!-- Endpoints -->
|
||||
<section xml:id="Endpoint_Calls">
|
||||
<title>Endpoints</title>
|
||||
<para>Enables service developers to manage endpoints.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create endpoint -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#endpoints"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#endpointsID"
|
||||
/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<!-- Domains -->
|
||||
<section xml:id="Domain_Calls">
|
||||
<title>Domains</title>
|
||||
<para>Enables service developers to manage domains.</para>
|
||||
<para>Domains represent collections of users, groups, and
|
||||
projects. Each is owned by exactly one domain. Users,
|
||||
however, can be associated with multiple projects by
|
||||
granting roles to the user on a project, including
|
||||
projects owned by other domains.</para>
|
||||
<para>Each domain defines a namespace where certain
|
||||
API-visible name attributes exist, which affects whether
|
||||
those names must be globally unique or unique within that
|
||||
domain. In the Identity API, the uniqueness of the
|
||||
following attributes is as follows:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><emphasis role="italic">Domain Name</emphasis>:
|
||||
Globally unique across all domains.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><emphasis role="italic">Role Name</emphasis>:
|
||||
Globally unique across all domains.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><emphasis role="italic">User Name</emphasis>:
|
||||
Unique within the owning domain.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><emphasis role="italic">Project Name</emphasis>:
|
||||
Unique within the owning domain.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><emphasis role="italic">Group Name</emphasis>:
|
||||
Unique within the owning domain.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create domain -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#domains"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#domainID"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#domainIDUserIDRoles"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#domainIDUserIDRoleID"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#domainIDGroupIDRoles"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#domainIDGroupIDRoleID"
|
||||
/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<!-- Projects -->
|
||||
<section xml:id="Project_Calls">
|
||||
<title>Projects</title>
|
||||
<para>Enables service developers to manage projects.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create project -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projects"/>
|
||||
<!-- get project -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projectID"/>
|
||||
<!-- list project users -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projectIDUsers"/>
|
||||
<!-- list project user roles -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projectIDUserIDRoles"/>
|
||||
<!-- check project user role -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projectIDUserIDRoleID"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projectIDGroupIDRoles"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projectIDGroupIDRoleID"
|
||||
/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<!-- Users -->
|
||||
<section xml:id="User_Calls">
|
||||
<title>Users</title>
|
||||
<para>Enables service developers to manage users.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create user -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#users"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#userID"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#userIDGroups"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#userIDProjects"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#userIDRoles"
|
||||
/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<!-- Groups -->
|
||||
<section xml:id="Group_Calls">
|
||||
<title>Groups</title>
|
||||
<para>Enables service developers to manage groups.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create group -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#groups"/>
|
||||
<!-- get group -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#groupID"/>
|
||||
<!-- list group users -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#groupIDUsers"/>
|
||||
<!-- add user to group -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#groupIDUserIDs"
|
||||
/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<!-- Credentials -->
|
||||
<section xml:id="Credential_Calls">
|
||||
<title>Credentials</title>
|
||||
<para>Enables service developers to manage credentials.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create credential -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#credentials"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#credentialID"
|
||||
/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<!-- Roles -->
|
||||
<section xml:id="Role_Calls">
|
||||
<title>Roles</title>
|
||||
<para>Enables service developers to manage roles.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create role -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#roles"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#roleID"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#roleIDUsers"
|
||||
/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<!-- Policies -->
|
||||
<section xml:id="Policy_Calls">
|
||||
<title>Policies</title>
|
||||
<para>Enables service developers to manage policies.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create policy -->
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#policies"/>
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#policyID"
|
||||
/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
</chapter>
|
||||
28
api-ref/src/docbkx/ch_images-v1.xml
Normal file
28
api-ref/src/docbkx/ch_images-v1.xml
Normal file
@ -0,0 +1,28 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter[
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
<!ENTITY nbsp " ">
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
]>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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="image-v1">
|
||||
<title>Image Service API v1</title>
|
||||
<para>Loads images for use at launch time by the Compute API.
|
||||
Also, assigns metadata to images. Some cloud implementations
|
||||
do not expose this API and offer pretested images only.</para>
|
||||
<wadl:resources href="../wadls/image-api/src/v1/os-image-1.0.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</chapter>
|
||||
40
api-ref/src/docbkx/ch_images-v2.xml
Normal file
40
api-ref/src/docbkx/ch_images-v2.xml
Normal file
@ -0,0 +1,40 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter[
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
<!ENTITY nbsp " ">
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
]>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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="image-v2">
|
||||
<title>Image Service API v2</title>
|
||||
<para>Image Service API v2.0, API v2.1, and API v2.2.</para>
|
||||
<section xml:id="images-v2">
|
||||
<title>Images</title>
|
||||
<para>Creates, updates, and deletes image metadata records.
|
||||
Enables users to share images with each other. Also,
|
||||
uploads and downloads raw image data.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
href="../wadls/image-api/src/v2/os-image-v2.wadl"/>
|
||||
</section>
|
||||
<section xml:id="image-schemas-v2">
|
||||
<title>Image schemas</title>
|
||||
<para>Gets a JSON-schema document that represents an images or
|
||||
image entity.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/image-api/src/v2/os-image-schemas-v2.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
</chapter>
|
||||
48
api-ref/src/docbkx/ch_netconn-ext-v2.xml
Normal file
48
api-ref/src/docbkx/ch_netconn-ext-v2.xml
Normal file
@ -0,0 +1,48 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter[
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
<!ENTITY nbsp " ">
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
]>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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="netconn-v2-ext">
|
||||
<title>Networking API v2.0 extensions</title>
|
||||
<section xml:id="quotas-ext">
|
||||
<title>Quotas extension</title>
|
||||
<para>Lists, shows information for, updates, and resets
|
||||
quotas.</para>
|
||||
<wadl:resources href="../wadls/netconn-api/src/os-quotas.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="network_provider-ext">
|
||||
<title>Networks provider extended attributes</title>
|
||||
<wadl:resources
|
||||
href="../wadls/netconn-api/src/os-networks-provider-ext.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="port_binding-ext">
|
||||
<title>Ports binding extended attributes</title>
|
||||
<wadl:resources
|
||||
href="../wadls/netconn-api/src/os-ports-binding-ext.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="security_groups">
|
||||
<title>Security groups and rules</title>
|
||||
<wadl:resources
|
||||
href="../wadls/netconn-api/src/security-groups.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
</chapter>
|
||||
54
api-ref/src/docbkx/ch_netconn-v2.xml
Normal file
54
api-ref/src/docbkx/ch_netconn-v2.xml
Normal file
@ -0,0 +1,54 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter[
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
<!ENTITY nbsp " ">
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
]>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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="netconn-v2">
|
||||
<title>Networking API v2.0</title>
|
||||
<para>Provides virtual networking services among devices that are
|
||||
managed by the OpenStack Compute service. The Networking API
|
||||
v2.0 combines the API v1.1 functionality with some essential
|
||||
Internet Protocol Address Management (IPAM) functionality.
|
||||
Enables users to associate IP address blocks and other network
|
||||
configuration settings with a neutron network. You can choose
|
||||
a specific IP address from the block or let neutron choose the
|
||||
first available IP address.</para>
|
||||
<section xml:id="networks">
|
||||
<title>Networks</title>
|
||||
<para>Lists, shows information for, creates, updates, and
|
||||
deletes networks.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/netconn-api/src/os-networks.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="subnets">
|
||||
<title>Subnets</title>
|
||||
<para>Lists, shows information for, creates, updates, and
|
||||
deletes subnet resources.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/netconn-api/src/os-subnets.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ports">
|
||||
<title>Ports</title>
|
||||
<para>Lists, shows information for, creates, updates, and
|
||||
deletes ports.</para>
|
||||
<wadl:resources href="../wadls/netconn-api/src/os-ports.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
</chapter>
|
||||
28
api-ref/src/docbkx/ch_objectstorage-v1.xml
Normal file
28
api-ref/src/docbkx/ch_objectstorage-v1.xml
Normal file
@ -0,0 +1,28 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter[
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
<!ENTITY nbsp " ">
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
]>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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="objectstorage-v1">
|
||||
<title>Object Storage API v1</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>
|
||||
91
api-ref/src/docbkx/ch_orchestration-v1.xml
Normal file
91
api-ref/src/docbkx/ch_orchestration-v1.xml
Normal file
@ -0,0 +1,91 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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="orchestration-v1">
|
||||
<title>Orchestration API v1.0</title>
|
||||
<para>Uses a template language to orchestrate OpenStack
|
||||
services.</para>
|
||||
<section xml:id="stacks">
|
||||
<title>Stacks</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#stacks">
|
||||
<wadl:method href="#stack_create"/>
|
||||
<wadl:method href="#stack_list"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#stack_name">
|
||||
<wadl:method href="#stack_find"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#stack_id">
|
||||
<wadl:method href="#stack_show"/>
|
||||
<wadl:method href="#stack_update"/>
|
||||
<wadl:method href="#stack_delete"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="stack-resources">
|
||||
<title>Stack resources</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#resources">
|
||||
<wadl:method href="#stack_resources_find"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#resources2">
|
||||
<wadl:method href="#resource_list"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#resource_name">
|
||||
<wadl:method href="#resource_show"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#metadata">
|
||||
<wadl:method href="#resource_metadata"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#resource_types">
|
||||
<wadl:method href="#resource_type_list"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="stack-events">
|
||||
<title>Stack events</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#events">
|
||||
<wadl:method href="#stack_events_find"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#events2">
|
||||
<wadl:method href="#stack_event_list"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#events3">
|
||||
<wadl:method href="#resource_event_list"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#event_id">
|
||||
<wadl:method href="#event_show"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="stack-templates">
|
||||
<title>Templates</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#template">
|
||||
<wadl:method href="#stack_template"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#validate_template">
|
||||
<wadl:method href="#template_validate"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
</chapter>
|
||||
83
api-ref/src/docbkx/ch_telemetry-v2.xml
Normal file
83
api-ref/src/docbkx/ch_telemetry-v2.xml
Normal file
@ -0,0 +1,83 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter[
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
<!ENTITY nbsp " ">
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
]>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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="telemetry-v2">
|
||||
<title>Telemetry API v2.0</title>
|
||||
<para>Manages telemetry operations.</para>
|
||||
<section xml:id="alarms">
|
||||
<title>Alarms</title>
|
||||
<para>Lists, creates, gets details for, updates, and deletes
|
||||
alarms.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl#alarms">
|
||||
<wadl:method href="#listAlarms"/>
|
||||
<wadl:method href="#createAlarm"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl#alarm_id">
|
||||
<wadl:method href="#showAlarm"/>
|
||||
<wadl:method href="#updateAlarm"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl#state">
|
||||
<wadl:method href="#updateAlarmState"/>
|
||||
<wadl:method href="#showAlarmState"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl#history">
|
||||
<wadl:method href="#showAlarmHistory"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="meters">
|
||||
<title>Meters</title>
|
||||
<para>Gets information for meters.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl#meters">
|
||||
<wadl:method href="#listMeters"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl#meter_id">
|
||||
<wadl:method href="#showMeter"/>
|
||||
<wadl:method href="#createMeter"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl#statistics">
|
||||
<wadl:method href="#showMeterStatistics"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="resources">
|
||||
<title>Resources</title>
|
||||
<para>Gets information for resources.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl#resources">
|
||||
<wadl:method href="#listResources"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl#resource_id">
|
||||
<wadl:method href="#showResource"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
</chapter>
|
||||
82
api-ref/src/docbkx/preface.xml
Normal file
82
api-ref/src/docbkx/preface.xml
Normal file
@ -0,0 +1,82 @@
|
||||
<!DOCTYPE preface[
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
<!ENTITY nbsp " ">
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
]>
|
||||
<preface xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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="Overview">
|
||||
<title>Preface</title>
|
||||
<para>Use these OpenStack APIs and extensions in your OpenStack
|
||||
cloud:</para>
|
||||
<itemizedlist role="compact">
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://api.openstack.org/api-ref-blockstorage.html"
|
||||
>Block Storage Service API</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://api.openstack.org/api-ref-compute.html"
|
||||
>Compute API</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://api.openstack.org/api-ref-compute-ext.html"
|
||||
>Compute API extensions</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://api.openstack.org/api-ref-identity.html"
|
||||
>Identity Service API and extensions</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://api.openstack.org/api-ref-image.html"
|
||||
>Image Service API</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://api.openstack.org/api-ref-networking.html"
|
||||
>Networking API and extensions</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="api-ref-objectstorage.html">Object
|
||||
Storage API</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://api.openstack.org/api-ref-orchestration.html"
|
||||
>Orchestration API</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://api.openstack.org/api-ref-telemetry.html"
|
||||
>Telemetry API</link></para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>You must install the packages for each API separately. After
|
||||
you authenticate through the <link
|
||||
xlink:href="http://api.openstack.org/api-ref-identity.html"
|
||||
>Identity Service API</link>, 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/"
|
||||
>OpenStack API Quick Start</link>.</para>
|
||||
<para> </para>
|
||||
</preface>
|
||||
@ -1,19 +1,21 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<server xmlns="http://docs.openstack.org/compute/api/v1.1" imageRef="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" flavorRef="http://openstack.example.com/openstack/flavors/1" name="new-server-test">
|
||||
<server xmlns="http://docs.openstack.org/compute/api/v1.1"
|
||||
imageRef="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b"
|
||||
flavorRef="http://openstack.example.com/openstack/flavors/1"
|
||||
name="new-server-test">
|
||||
<metadata>
|
||||
<meta key="My Server Name">Apache1</meta>
|
||||
</metadata>
|
||||
<personality>
|
||||
<file path="/etc/banner.txt">
|
||||
ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp
|
||||
dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k
|
||||
IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs
|
||||
c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g
|
||||
QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo
|
||||
ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv
|
||||
dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy
|
||||
c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6
|
||||
b25zLiINCg0KLVJpY2hhcmQgQmFjaA==
|
||||
</file>
|
||||
ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp
|
||||
dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k
|
||||
IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs
|
||||
c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g
|
||||
QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo
|
||||
ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv
|
||||
dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy
|
||||
c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6
|
||||
b25zLiINCg0KLVJpY2hhcmQgQmFjaA== </file>
|
||||
</personality>
|
||||
</server>
|
||||
</server>
|
||||
|
||||
@ -1,6 +1,12 @@
|
||||
<?xml version='1.0' encoding='UTF-8'?>
|
||||
<server xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" id="37443b33-eb80-4eea-90d8-f90778f53dea" adminPass="ffV6E5gsNPpi">
|
||||
<server xmlns:atom="http://www.w3.org/2005/Atom"
|
||||
xmlns="http://docs.openstack.org/compute/api/v1.1"
|
||||
id="37443b33-eb80-4eea-90d8-f90778f53dea" adminPass="ffV6E5gsNPpi">
|
||||
<metadata/>
|
||||
<atom:link href="http://openstack.example.com/v2/openstack/servers/37443b33-eb80-4eea-90d8-f90778f53dea" rel="self"/>
|
||||
<atom:link href="http://openstack.example.com/openstack/servers/37443b33-eb80-4eea-90d8-f90778f53dea" rel="bookmark"/>
|
||||
</server>
|
||||
<atom:link
|
||||
href="http://openstack.example.com/v2/openstack/servers/37443b33-eb80-4eea-90d8-f90778f53dea"
|
||||
rel="self"/>
|
||||
<atom:link
|
||||
href="http://openstack.example.com/openstack/servers/37443b33-eb80-4eea-90d8-f90778f53dea"
|
||||
rel="bookmark"/>
|
||||
</server>
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
<?xml version='1.0' encoding='UTF-8'?>
|
||||
<virtual_interfaces
|
||||
xmlns:OS-EXT-VIF-NET="http://docs.openstack.org/compute/ext/extended-virtual-interfaces-net/api/v1.1"
|
||||
xmlns="http://docs.openstack.org/compute/api/v1.1">
|
||||
xmlns:OS-EXT-VIF-NET="http://docs.openstack.org/compute/ext/extended-virtual-interfaces-net/api/v1.1"
|
||||
xmlns="http://docs.openstack.org/compute/api/v1.1">
|
||||
<virtual_interface id="94edf7aa-565a-469a-8f45-656b4acf8229"
|
||||
mac_address="fa:16:3e:7d:31:9a"
|
||||
OS-EXT-VIF-NET:net_id="94edf7aa-565a-469a-8f45-656b4acf8230"/>
|
||||
mac_address="fa:16:3e:7d:31:9a"
|
||||
OS-EXT-VIF-NET:net_id="94edf7aa-565a-469a-8f45-656b4acf8230"/>
|
||||
</virtual_interfaces>
|
||||
|
||||
@ -85,310 +85,606 @@
|
||||
|
||||
<!ENTITY imageListParameters
|
||||
'
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="changes-since" style="query" required="false" type="xsd:dateTime"><doc><p xmlns="http://www.w3.org/1999/xhtml">A time/date stamp for when the image last changed status.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="server" style="query" required="false" type="xsd:anyURI"><doc><p xmlns="http://www.w3.org/1999/xhtml">Name of the server in URL format.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="name" style="query" required="false" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">Name of the image as a string.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="status" style="query" required="false" type="csapi:ImageStatus"><doc><p xmlns="http://www.w3.org/1999/xhtml">Value of the status of the image so that you can filter on "ACTIVE" for example.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="marker" style="query" required="false" type="csapi:UUID"><doc><p xmlns="http://www.w3.org/1999/xhtml">UUID of the image at which you want to set a marker.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="limit" style="query" required="false" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Integer value for the limit of values to return.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="type" style="query" required="false" type="xsd:string" default="ALL"><doc><p xmlns="http://www.w3.org/1999/xhtml">Value of the type of image, such as BASE, SERVER, or ALL.</p></doc>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="changes-since" style="query" required="false" type="xsd:dateTime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>A time/date stamp for when the image last changed status.</para></wadl:doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="server" style="query" required="false" type="xsd:anyURI">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Name of the server in URL format.</para></wadl:doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="name" style="query" 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>Name of the image as a string.</para></wadl:doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="status" style="query" required="false" type="csapi:ImageStatus">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Value of the status of the image so that you can filter on "ACTIVE" for example.</para></wadl:doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="marker" style="query" required="false" type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>UUID of the image at which you want to set a marker.</para></wadl:doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="limit" style="query" required="false" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Integer value for the limit of values to return.</para></wadl:doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="type" style="query" required="false" type="xsd:string" default="ALL">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Value of the type of image, such as BASE, SERVER, or ALL.</para></wadl:doc>
|
||||
<option value="BASE"/>
|
||||
<option value="SERVER"/>
|
||||
<option value="ALL"/>
|
||||
</param>
|
||||
'>
|
||||
<!-- Server Create Parameters -->
|
||||
|
||||
<!ENTITY serverCreateParameters
|
||||
'
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="security_group" style="query" required="true" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">The name of the security group. If blank, the server is created in the "default" security group.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="user_data" style="query" required="false" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">Configuration information or scripts to use upon launch. Must be Base64 encoded.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="availability_zone" style="query" required="false" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">The availability zone in which to launch the server.</p></doc></param>
|
||||
<param name="server" style="plain" required="true" xmlns:csapi="http://docs.openstack.org/compute/api/v2" xmlns="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="security_group" style="query" 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 name
|
||||
of the security group. If blank, the server is
|
||||
created in the "default" security
|
||||
group.</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="user_data" style="query" 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>Configuration information or scripts to use
|
||||
upon launch. Must be Base64 encoded.</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="availability_zone" style="query"
|
||||
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
|
||||
availability zone in which to launch the
|
||||
server.</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="server" style="plain" required="true"
|
||||
type="csapi:ServerForCreate" path="/csapi:server">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="server">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="server">
|
||||
<para>server.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="imageRef" style="plain" required="true" xmlns:csapi="http://docs.openstack.org/compute/api/v2" xmlns="http://wadl.dev.java.net/2009/02"
|
||||
<param name="imageRef" style="plain" required="true"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="csapi:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="imageRef">
|
||||
<para>The
|
||||
image reference for the desired image for
|
||||
your server instance.</para>
|
||||
<para>Specify as an ID or full URL.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="flavorRef" style="plain" required="true" xmlns:csapi="http://docs.openstack.org/compute/api/v2" xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="csapi:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="flavorRef">
|
||||
<para>The
|
||||
flavor reference for the desired flavor
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="imageRef">
|
||||
<para>The image reference for the desired image
|
||||
for your server instance.</para>
|
||||
<para
|
||||
>Specify as an ID or full URL.</para></wadl:doc>
|
||||
<para>Specify as an ID or full
|
||||
URL.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="name" style="plain" required="true" xmlns:csapi="http://docs.openstack.org/compute/api/v2" xmlns="http://wadl.dev.java.net/2009/02"
|
||||
<param name="flavorRef" style="plain" required="true"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="csapi:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="name">
|
||||
<para>The
|
||||
name for your created server.</para></wadl:doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="flavorRef">
|
||||
<para>The flavor reference for the desired flavor
|
||||
for your server instance.</para>
|
||||
<para>Specify as an ID or full
|
||||
URL.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="metadata" style="plain" required="false" xmlns:csapi="http://docs.openstack.org/compute/api/v2" xmlns="http://wadl.dev.java.net/2009/02"
|
||||
<param name="name" style="plain" required="true"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="csapi:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="metadata">
|
||||
<para
|
||||
>Metadata key and value pairs. The maximum
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="name">
|
||||
<para>The name for your created
|
||||
server.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="metadata" style="plain" required="false"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="csapi:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="metadata">
|
||||
<para>Metadata key and value pairs. The maximum
|
||||
size of the metadata key and value is 255
|
||||
bytes each.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="personality" style="plain" xmlns:csapi="http://docs.openstack.org/compute/api/v2" xmlns="http://wadl.dev.java.net/2009/02"
|
||||
required="false" type="csapi:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="personality">
|
||||
<para>File
|
||||
path and contents (text only) to inject
|
||||
into the server at launch. The maximum
|
||||
size of the file path data is 255 bytes.
|
||||
The maximum limit refers to the number of
|
||||
bytes in the decoded data and not the
|
||||
number of characters in the encoded
|
||||
data.</para></wadl:doc>
|
||||
<param name="personality" style="plain" required="false"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="csapi:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="personality">
|
||||
<para>File path and contents (text only) to inject
|
||||
into the server at launch. The maximum size of
|
||||
the file path data is 255 bytes. The maximum
|
||||
limit refers to the number of bytes in the
|
||||
decoded data and not the number of characters
|
||||
in the encoded data.</para></wadl:doc>
|
||||
</param>
|
||||
'>
|
||||
|
||||
<!-- Server List Parameters -->
|
||||
<!ENTITY serverListParameters
|
||||
'
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="changes-since" style="query" required="false" type="xsd:dateTime"><doc><p xmlns="http://www.w3.org/1999/xhtml">A time/date stamp for when the server last changed status.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="image" style="query" required="false" type="xsd:anyURI"><doc><p xmlns="http://www.w3.org/1999/xhtml">Name of the image in URL format.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="flavor" style="query" required="false" type="xsd:anyURI"><doc><p xmlns="http://www.w3.org/1999/xhtml">Name of the flavor in URL format.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="name" style="query" required="false" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">Name of the server as a string.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="marker" style="query" required="false" type="csapi:UUID"><doc><p xmlns="http://www.w3.org/1999/xhtml">UUID of the server at which you want to set a marker.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="limit" style="query" required="false" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Integer value for the limit of values to return.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="status" style="query" required="false" type="csapi:ServerStatus"><doc><p xmlns="http://www.w3.org/1999/xhtml">Value of the status of the server so that you can filter on "ACTIVE" for example.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="host" style="query" required="false" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">Name of the host as a string.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="changes-since" style="query" required="false"
|
||||
type="xsd:dateTime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>A time/date stamp for when the server
|
||||
last changed status.</para></wadl:doc>
|
||||
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="image" style="query" required="false"
|
||||
type="xsd:anyURI">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Name of the image in URL format.</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="flavor" style="query" required="false" type="xsd:anyURI">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Name of the flavor in URL format.</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="name" style="query" 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>Name of the server as a string.</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="marker" style="query" required="false" type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>UUID of the server at which you want to set a marker.</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="limit" style="query" required="false" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Integer value for the limit of values to return.</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="status" style="query" required="false" type="csapi:ServerStatus">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Value of the status of the server so that you can filter on
|
||||
"ACTIVE" for example.</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="host" style="query" 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>Name of the host as a string.</para></wadl:doc>
|
||||
</param>
|
||||
'>
|
||||
<!-- Flavor List Parameters -->
|
||||
|
||||
<!ENTITY flavorListParameters
|
||||
'
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="changes-since" style="query" required="false" type="xsd:dateTime"><doc><p xmlns="http://www.w3.org/1999/xhtml">A time/date stamp for when the flavor last changed.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="minDisk" style="query" required="false" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Integer value for the minimum disk space in GB so you can filter results.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="minRam" style="query" required="false" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Integer value for the minimum RAM so you can filter results.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="marker" style="query" required="false" type="csapi:UUID"><doc><p xmlns="http://www.w3.org/1999/xhtml">UUID of the flavor at which you want to set a marker.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="limit" style="query" required="false" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Integer value for the limit of values to return.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="changes-since" style="query" required="false" type="xsd:dateTime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>A time/date stamp for when the flavor last changed.</para></wadl:doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="minDisk" style="query" required="false" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Integer value for the minimum disk space in GB so you can filter results.</para></wadl:doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="minRam" style="query" required="false" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Integer value for the minimum RAM so you can filter results.</para></wadl:doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="marker" style="query" required="false" type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>UUID of the flavor at which you want to set a marker.</para></wadl:doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="limit" style="query" required="false" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Integer value for the limit of values to return.</para></wadl:doc></param>
|
||||
'>
|
||||
<!ENTITY flavorReqParameters
|
||||
'
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="disk" style="plain" required="true" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Integer value for the minimum disk space in GB.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="id" style="plain" required="true" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">The flavor ID.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="name" style="plain" required="true" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">The flavor name.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="ram" style="plain" required="true" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Amount of RAM.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="vcpus" style="plain" required="true" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Number of VCPUs.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="disk" style="plain" required="true" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Integer value for the minimum disk space in GB.</para></wadl:doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="id" style="plain" required="true" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The flavor ID.</para></wadl:doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="name" 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 flavor name.</para></wadl:doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="ram" style="plain" required="true" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Amount of RAM.</para></wadl:doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="vcpus" style="plain" required="true" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Number of VCPUs.</para></wadl:doc></param>
|
||||
'>
|
||||
<!ENTITY flavorRespParameters
|
||||
'
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="disk" style="plain" required="true" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Integer value for the minimum disk space in GB.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="id" style="plain" required="true" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">The flavor ID.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="links" style="plain" required="true" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">Flavor links.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="name" style="plain" required="true" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">The flavor name.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="ram" style="plain" required="true" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Amount of RAM.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="vcpus" style="plain" required="true" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Number of VCPUs.</p></doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="disk" style="plain" required="true" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Integer value for the minimum disk space in GB.</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="id" style="plain" required="true" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The flavor ID.</para></wadl:doc></param>
|
||||
<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>Flavor links.</para></wadl:doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="name" 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 flavor name.</para></wadl:doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="ram" style="plain" required="true" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Amount of RAM.</para></wadl:doc></param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="vcpus" style="plain" required="true" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Number of VCPUs.</para></wadl:doc></param>
|
||||
'>
|
||||
<!ENTITY quotaSetsReqParameters
|
||||
' <param name="quota_set" style="plain" required="true"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="xsd:string">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">A
|
||||
quota_set object.</p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>A
|
||||
quota_set object.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="cores" style="plain" required="false"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of instance cores allowed for each
|
||||
tenant.</p></doc>
|
||||
tenant.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="fixed_ips " style="plain" required="false"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of fixed IP addresses allowed for each
|
||||
tenant. Must be equal to or greater than the
|
||||
number of allowed instances.</p></doc>
|
||||
number of allowed instances.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="floating_ips" style="plain" required="false"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of floating IP addresses allowed for
|
||||
each tenant.</p></doc>
|
||||
each tenant.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="id" style="plain" required="false"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
ID for the quota set.</p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
ID for the quota set.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="injected_file_content_bytes" style="plain"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
required="false" type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of bytes of content allowed for each
|
||||
injected file.</p></doc>
|
||||
injected file.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="injected_file_path_bytes " style="plain"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
required="false" type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of bytes allowed for each injected file
|
||||
path.</p></doc>
|
||||
path.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="injected_files" style="plain"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
required="false" type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of injected files allowed for each
|
||||
tenant.</p></doc>
|
||||
tenant.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="instances" style="plain" required="false"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
number of instances allowed for each
|
||||
tenant.</p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of instances allowed for each
|
||||
tenant.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="key_pairs" style="plain" required="false"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of key pairs allowed for each
|
||||
user.</p></doc>
|
||||
user.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="metadata_items" style="plain"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
required="false" type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of metadata items allowed for each
|
||||
instance.</p></doc>
|
||||
instance.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="ram" style="plain" required="false"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
amount of instance RAM in megabytes allowed
|
||||
for each tenant.</p></doc>
|
||||
for each tenant.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="security_group_rules" style="plain"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
required="false" type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of rules allowed for each security
|
||||
group.</p></doc>
|
||||
group.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="security_groups" style="plain"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
required="false" type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of security groups allowed for each
|
||||
tenant.</p></doc>
|
||||
tenant.</para></wadl:doc>
|
||||
</param>
|
||||
'>
|
||||
<!ENTITY quotaSetsRespParameters
|
||||
' <param name="quota_set" style="plain" required="true"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="xsd:string">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">A
|
||||
quota_set object.</p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>A
|
||||
quota_set object.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="cores" style="plain" required="true"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of instance cores allowed for each
|
||||
tenant.</p></doc>
|
||||
tenant.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="fixed_ips " style="plain" required="true"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of fixed IP addresses allowed for each
|
||||
tenant. Must be equal to or greater than the
|
||||
number of allowed instances.</p></doc>
|
||||
number of allowed instances.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="floating_ips" style="plain" required="true"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of floating IP addresses allowed for
|
||||
each tenant.</p></doc>
|
||||
each tenant.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="id" style="plain" required="true"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
ID for the quota set.</p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
ID for the quota set.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="injected_file_content_bytes" style="plain"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
required="true" type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of bytes of content allowed for each
|
||||
injected file.</p></doc>
|
||||
injected file.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="injected_file_path_bytes " style="plain"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
required="true" type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of bytes allowed for each injected file
|
||||
path.</p></doc>
|
||||
path.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="injected_files" style="plain"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
required="true" type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of injected files allowed for each
|
||||
tenant.</p></doc>
|
||||
tenant.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="instances" style="plain" required="true"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of instances allowed for each
|
||||
tenant.</p></doc>
|
||||
tenant.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="key_pairs" style="plain" required="true"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of key pairs allowed for each
|
||||
user.</p></doc>
|
||||
user.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="metadata_items" style="plain"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
required="true" type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of metadata items allowed for each
|
||||
instance.</p></doc>
|
||||
instance.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="ram" style="plain" required="true"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
amount of instance RAM in megabytes allowed
|
||||
for each tenant.</p></doc>
|
||||
for each tenant.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="security_group_rules" style="plain"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
required="false" type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of rules allowed for each security
|
||||
group.</p></doc>
|
||||
group.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="security_groups" style="plain"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
required="true" type="xsd:int">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The
|
||||
number of security groups allowed for each
|
||||
tenant.</p></doc>
|
||||
tenant.</para></wadl:doc>
|
||||
</param>
|
||||
'>
|
||||
<!-- Useful for describing APIs -->
|
||||
|
||||
@ -5,9 +5,10 @@
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-admin-actions-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
@ -27,7 +28,7 @@
|
||||
interest to you.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<resource path="action" id="action">
|
||||
<resource path="action" id="action-admin">
|
||||
<method href="#pause"/>
|
||||
<method href="#unpause"/>
|
||||
<method href="#suspend"/>
|
||||
@ -52,7 +53,7 @@
|
||||
</resources>
|
||||
<method name="POST" id="pause">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Pause Server">
|
||||
title="Pause server">
|
||||
<para role="shortdesc">Pauses a server. Changes its status
|
||||
to PAUSED.</para>
|
||||
</wadl:doc>
|
||||
@ -86,7 +87,7 @@
|
||||
</method>
|
||||
<method name="POST" id="unpause">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Unpause Server">
|
||||
title="Unpause server">
|
||||
<para role="shortdesc">Unpauses a PAUSED server and
|
||||
changes its status to ACTIVE.</para>
|
||||
</wadl:doc>
|
||||
@ -120,7 +121,7 @@
|
||||
</method>
|
||||
<method name="POST" id="suspend">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Suspend Server">
|
||||
title="Suspend server">
|
||||
<para role="shortdesc">Suspends a server and changes its
|
||||
status to SUSPENDED.</para>
|
||||
</wadl:doc>
|
||||
@ -154,7 +155,7 @@
|
||||
</method>
|
||||
<method name="POST" id="resume">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Resume Server">
|
||||
title="Resume server">
|
||||
<para role="shortdesc">Resumes a SUSPENDED server and
|
||||
changes its status to ACTIVE.</para>
|
||||
</wadl:doc>
|
||||
@ -188,7 +189,7 @@
|
||||
</method>
|
||||
<method name="POST" id="migrate">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Migrate Server">
|
||||
title="Migrate server">
|
||||
<para role="shortdesc">Migrates a server to a host. The
|
||||
scheduler chooses the host.</para>
|
||||
</wadl:doc>
|
||||
@ -222,7 +223,7 @@
|
||||
</method>
|
||||
<method name="POST" id="resetNetwork">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Reset Networking on Server">
|
||||
title="Reset networking on server">
|
||||
<para role="shortdesc">Resets networking on a
|
||||
server.</para>
|
||||
</wadl:doc>
|
||||
@ -256,7 +257,7 @@
|
||||
</method>
|
||||
<method name="POST" id="injectNetworkInfo">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Inject Network Information">
|
||||
title="Inject network information">
|
||||
<para role="shortdesc">Injects network information into a
|
||||
server.</para>
|
||||
</wadl:doc>
|
||||
@ -293,7 +294,7 @@
|
||||
</method>
|
||||
<method name="POST" id="lock">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Lock Server">
|
||||
title="Lock server">
|
||||
<para role="shortdesc">Locks a server.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -326,7 +327,7 @@
|
||||
</method>
|
||||
<method name="POST" id="unlock">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Unlock Server">
|
||||
title="Unlock server">
|
||||
<para role="shortdesc">Unlocks a server.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -359,7 +360,7 @@
|
||||
</method>
|
||||
<method name="POST" id="createBackup">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create Server Backup">
|
||||
title="Create server backup">
|
||||
<para role="shortdesc">Backs up a server instance.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -414,7 +415,7 @@
|
||||
</method>
|
||||
<method name="POST" id="os-migrateLive">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Live-migrate Server">
|
||||
title="Live-migrate server">
|
||||
<para role="shortdesc">Live-migrates a server to a new
|
||||
host without rebooting.</para>
|
||||
</wadl:doc>
|
||||
@ -470,7 +471,7 @@
|
||||
</method>
|
||||
<method name="POST" id="os-resetState">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Reset Server State">
|
||||
title="Reset server state">
|
||||
<para role="shortdesc">Resets the state of a server to a
|
||||
specified state.</para>
|
||||
</wadl:doc>
|
||||
@ -512,7 +513,7 @@
|
||||
</method>
|
||||
<method name="POST" id="evacuate">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Evacuate Server">
|
||||
title="Evacuate server">
|
||||
<para role="shortdesc">Evacuates a server from failed
|
||||
host.</para>
|
||||
</wadl:doc>
|
||||
@ -588,7 +589,7 @@
|
||||
</method>
|
||||
<method name="POST" id="addSecurityGroup">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Add Security Group">
|
||||
title="Add security group">
|
||||
<para role="shortdesc">Assigns the specified security
|
||||
group to the server.</para>
|
||||
</wadl:doc>
|
||||
@ -631,7 +632,7 @@
|
||||
</method>
|
||||
<method name="POST" id="removeSecurityGroup">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Remove Security Group">
|
||||
title="Remove security group">
|
||||
<para role="shortdesc">Removes the specified security
|
||||
group from the server.</para>
|
||||
</wadl:doc>
|
||||
@ -674,7 +675,7 @@
|
||||
</method>
|
||||
<method name="POST" id="addFloatingIP">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Add Floating IP Address">
|
||||
title="Add floating IP address">
|
||||
<para role="shortdesc">Adds a floating IP address to an
|
||||
instance.</para><para>You can optionally associate a
|
||||
fixed IP address with the floating IP address.</para>
|
||||
@ -710,7 +711,7 @@
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<!-- <representation mediaType="application/xml">
|
||||
<!-- <representation mediaType="application/xml">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"
|
||||
title="Add floating IP address: XML request">
|
||||
|
||||
@ -5,7 +5,8 @@
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-agents-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
|
||||
@ -2,13 +2,15 @@
|
||||
<!-- (C) 2013 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:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-aggregates-v2">
|
||||
<resource id="version" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="csapi:UUID">
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The ID for the tenant or
|
||||
account in a multi-tenancy
|
||||
@ -41,11 +43,11 @@
|
||||
</resources>
|
||||
<method name="GET" id="list_aggregates">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Aggregates">
|
||||
title="List aggregates">
|
||||
<para role="shortdesc">Lists all aggregates.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/XML">
|
||||
<representation mediaType="application/xml">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
@ -65,7 +67,7 @@
|
||||
</method>
|
||||
<method name="POST" id="create_aggregate">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create Aggregate">
|
||||
title="Create aggregate">
|
||||
<para role="shortdesc">Creates an aggregate.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -121,7 +123,7 @@
|
||||
</method>
|
||||
<method name="GET" id="get_details">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get Aggregate Details">
|
||||
title="Get aggregate details">
|
||||
<para role="shortdesc">Gets details about a specified
|
||||
aggregate.</para>
|
||||
</wadl:doc>
|
||||
@ -151,7 +153,7 @@
|
||||
</method>
|
||||
<method name="PUT" id="update_aggregate">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Update Aggregate">
|
||||
title="Update aggregate">
|
||||
<para role="shortdesc">Updates the name, and optionally
|
||||
the availability zone, for a specified
|
||||
aggregate.</para>
|
||||
@ -207,7 +209,7 @@
|
||||
</method>
|
||||
<method name="DELETE" id="delete_aggregate">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete Aggregate">
|
||||
title="Delete aggregate">
|
||||
<para role="shortdesc">Deletes an aggregate.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -217,7 +219,7 @@
|
||||
</method>
|
||||
<method name="POST" id="set_metadata">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Set Aggregate Metadata">
|
||||
title="Set aggregate metadata">
|
||||
<para role="shortdesc">Sets metadata for an
|
||||
aggregate.</para>
|
||||
</wadl:doc>
|
||||
@ -266,7 +268,7 @@
|
||||
</method>
|
||||
<method name="POST" id="add_host">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Add Host to Aggregate">
|
||||
title="Add host to aggregate">
|
||||
<para role="shortdesc">Adds a host to an aggregate.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -316,7 +318,7 @@
|
||||
</method>
|
||||
<method name="POST" id="remove_host">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Remove Host from Aggregate">
|
||||
title="Remove host from aggregate">
|
||||
<para role="shortdesc">Removes a host from an
|
||||
aggregate.</para>
|
||||
</wadl:doc>
|
||||
|
||||
@ -9,7 +9,8 @@
|
||||
xmlns:common="http://docs.openstack.org/common/api/v1.0"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:atom="http://www.w3.org/2005/Atom">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-attach-interfaces-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
@ -54,10 +55,9 @@
|
||||
</resources>
|
||||
<method name="POST" id="createAttachInterface">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create Interface">
|
||||
<para role="shortdesc">Creates and
|
||||
uses a port interface to attach the port to a server
|
||||
instance.</para>
|
||||
title="Create interface">
|
||||
<para role="shortdesc">Creates and uses a port interface
|
||||
to attach the port to a server instance.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<param name="interfaceAttachment" style="plain"
|
||||
@ -150,7 +150,7 @@
|
||||
</method>
|
||||
<method name="GET" id="listAttachedInterfaces">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Interfaces">
|
||||
title="List interfaces">
|
||||
<para role="shortdesc">Lists port interfaces.</para>
|
||||
</wadl:doc>
|
||||
<response status="202">
|
||||
@ -209,7 +209,7 @@
|
||||
</method>
|
||||
<method name="GET" id="showAttachedInterface">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show Attached Interface">
|
||||
title="Show attached interface information">
|
||||
<para role="shortdesc">Shows information about a specified
|
||||
port interface.</para>
|
||||
</wadl:doc>
|
||||
|
||||
@ -21,7 +21,8 @@
|
||||
<!--*******************************************************-->
|
||||
<!-- All Resources -->
|
||||
<!--*******************************************************-->
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="block_device_mapping_v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
|
||||
@ -5,9 +5,10 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-certificates-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
@ -16,8 +17,8 @@
|
||||
multi-tenancy cloud.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<resource id="Certificates" type="#CertificatesList"
|
||||
path="os-certificates">
|
||||
<resource id="os-certificates"
|
||||
type="#CertificatesList" path="os-certificates">
|
||||
<method href="#createCertificate"/>
|
||||
<method href="#getRootCertificates"/>
|
||||
</resource>
|
||||
@ -26,7 +27,7 @@
|
||||
</resources>
|
||||
<method name="POST" id="createCertificate">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create Root Certificate">
|
||||
title="Create root certificate">
|
||||
<para role="shortdesc">Creates a root certificate.</para>
|
||||
</wadl:doc>
|
||||
<response status="202">
|
||||
@ -50,7 +51,7 @@
|
||||
</method>
|
||||
<method name="GET" id="getRootCertificates">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show Root Certificate Details">
|
||||
title="Show root certificate details">
|
||||
<para role="shortdesc">Shows details for a root
|
||||
certificate owned by a specified tenant ID.</para>
|
||||
</wadl:doc>
|
||||
|
||||
@ -5,9 +5,10 @@
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-cloudpipe-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
@ -15,10 +16,11 @@
|
||||
account in a multi-tenancy
|
||||
cloud.</para></wadl:doc>
|
||||
</param>
|
||||
<resource path="os-cloudpipe">
|
||||
<resource path="os-cloudpipe" id="os-cloudpipe">
|
||||
<method href="#listCloudpipes"/>
|
||||
<method href="#createCloudpipe"/>
|
||||
<resource path="configure-project">
|
||||
<resource path="configure-project"
|
||||
id="configure-project">
|
||||
<method href="#updateCloudpipe"/>
|
||||
</resource>
|
||||
</resource>
|
||||
@ -27,19 +29,21 @@
|
||||
</resources>
|
||||
<method name="GET" id="listCloudpipes">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Cloudpipes">
|
||||
title="List cloudpipes">
|
||||
<para role="shortdesc">Lists cloudpipes.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-cloudpipe/cloud-pipe-get-resp.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-cloudpipe/cloud-pipe-get-resp.xml"
|
||||
/>
|
||||
@ -49,7 +53,7 @@
|
||||
</method>
|
||||
<method name="POST" id="createCloudpipe">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create Cloudpipe">
|
||||
title="Create cloudpipe">
|
||||
<para role="shortdesc">Creates a cloudpipe.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -57,10 +61,10 @@
|
||||
name="project_id" style="query" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Creates the
|
||||
cloudpipe for the specified project ID. If
|
||||
omitted, the project ID defaults to the
|
||||
calling tenant.</para></wadl:doc>
|
||||
xml:lang="EN"><para>Creates the cloudpipe for the
|
||||
specified project ID. If omitted, the project
|
||||
ID defaults to the calling
|
||||
tenant.</para></wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
@ -71,7 +75,8 @@
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-cloudpipe/cloud-pipe-create-req.xml"
|
||||
/>
|
||||
@ -80,14 +85,16 @@
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-cloudpipe/cloud-pipe-create-resp.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-cloudpipe/cloud-pipe-create-resp.xml"
|
||||
/>
|
||||
@ -97,7 +104,7 @@
|
||||
</method>
|
||||
<method name="POST" id="updateCloudpipe">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Update Cloudpipe">
|
||||
title="Update cloudpipe">
|
||||
<para role="shortdesc">Updates the virtual private network
|
||||
(VPN) IP address and port for a specified cloudpipe
|
||||
instance.</para>
|
||||
@ -108,24 +115,26 @@
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The VPN IP
|
||||
address.</para></wadl:doc>
|
||||
address.</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="vpn_port" style="header" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The VPN
|
||||
port.</para></wadl:doc>
|
||||
port.</para></wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-cloudpipe-update/cloud-pipe-update-req.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-cloudpipe-update/cloud-pipe-update-req.xml"
|
||||
/>
|
||||
|
||||
@ -5,9 +5,10 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-console-output-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
@ -26,7 +27,8 @@
|
||||
interest to you.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<resource path="action" id="action">
|
||||
<resource path="action"
|
||||
id="action-os-console-output">
|
||||
<method href="#getConsoleOutput"/>
|
||||
</resource>
|
||||
</resource>
|
||||
@ -36,7 +38,7 @@
|
||||
</resources>
|
||||
<method name="POST" id="getConsoleOutput">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get Console Output for an Instance">
|
||||
title="Get console output for an instance">
|
||||
<para role="shortdesc">Gets console output for a server
|
||||
instance.</para>
|
||||
</wadl:doc>
|
||||
|
||||
@ -5,9 +5,10 @@
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-consoles-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
@ -25,7 +26,8 @@
|
||||
><para>The UUID for the server of
|
||||
interest to you.</para></wadl:doc>
|
||||
</param>
|
||||
<resource path="action" id="action">
|
||||
<resource path="action"
|
||||
id="action-os-consoles">
|
||||
<method href="#getConsole"/>
|
||||
</resource>
|
||||
</resource>
|
||||
@ -35,8 +37,9 @@
|
||||
</resources>
|
||||
<method name="POST" id="getConsole">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get Console">
|
||||
<para role="shortdesc">Gets a console.</para>
|
||||
title="Get console">
|
||||
<para role="shortdesc">Gets a console for a server
|
||||
instance.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<param name="getConsole" style="plain" type="xsd:string"
|
||||
|
||||
@ -5,11 +5,12 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-coverage-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="csapi:uuid">
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The ID for the tenant or
|
||||
account in a multi-tenancy
|
||||
@ -28,8 +29,8 @@
|
||||
</resources>
|
||||
<method name="POST" id="getReport">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get Report">
|
||||
<para>Generates a coverage report.</para>
|
||||
title="Get coverage report">
|
||||
<para role="shortdesc">Generates a coverage report.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<param name="file" style="plain" type="csapi:string"
|
||||
@ -102,8 +103,9 @@
|
||||
</method>
|
||||
<method name="POST" id="startReport">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Start Report">
|
||||
<para>Starts Nova coverage reporting.</para>
|
||||
title="Start coverage report">
|
||||
<para role="shortdesc">Starts Nova coverage
|
||||
reporting.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<param name="start" style="plain" type="csapi:string"
|
||||
@ -135,7 +137,7 @@
|
||||
</method>
|
||||
<method name="POST" id="startCombinedReport">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Start Combined Report">
|
||||
title="Start combined coverage report">
|
||||
<para role="shortdesc">Starts coverage reporting for all
|
||||
services.</para>
|
||||
<para>All reports are combined into a single
|
||||
@ -181,7 +183,7 @@
|
||||
</method>
|
||||
<method name="POST" id="stopReport">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Stop Report">
|
||||
title="Stop coverage report">
|
||||
<para role="shortdesc">Stops coverage reporting.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -195,7 +197,7 @@
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Stop report: JSON request">
|
||||
xml:lang="EN">
|
||||
<xsdxt:code language="json"
|
||||
href="../api_samples/os-coverage/coverage-stop-post-req.json"
|
||||
/>
|
||||
@ -203,7 +205,7 @@
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Stop report: XML request">
|
||||
xml:lang="EN">
|
||||
<xsdxt:code language="xml"
|
||||
href="../api_samples/os-coverage/coverage-stop-post-req.xml"
|
||||
/>
|
||||
|
||||
@ -7,16 +7,16 @@
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="config-drive-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The ID for the tenant or account in a
|
||||
multi-tenancy cloud.</para>
|
||||
</wadl:doc>
|
||||
xml:lang="EN"><para>The ID for the tenant or
|
||||
account in a multi-tenancy
|
||||
cloud.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="Servers" path="servers">
|
||||
<method href="#createServer"/>
|
||||
@ -25,15 +25,13 @@
|
||||
type="csapi:uuid">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The UUID for the server of
|
||||
interest to you.</para>
|
||||
</wadl:doc>
|
||||
xml:lang="EN">The UUID for the server
|
||||
of interest to you.</wadl:doc>
|
||||
</param>
|
||||
<method href="#getServer"/>
|
||||
</resource>
|
||||
<resource id="ServersDetail" path="detail">
|
||||
<method href="#getServersDetailed"/>
|
||||
<resource id="ServersDetail" path="detail">
|
||||
<method href="#getServersDetailed"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
@ -41,9 +39,9 @@
|
||||
</resources>
|
||||
<method name="POST" id="createServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create Server with Config Drive">
|
||||
title="Create server with configuration drive">
|
||||
<para role="shortdesc">Creates a server with the
|
||||
config_drive extended attribute.</para>
|
||||
configuration drive extended attribute.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
&serverCreateParameters;
|
||||
@ -92,9 +90,9 @@
|
||||
</method>
|
||||
<method name="GET" id="getServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get Server Information with Config Drive">
|
||||
title="Get server information with configuration drive">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
server including the config_drive extended
|
||||
server including the configuration drive extended
|
||||
attribute.</para>
|
||||
</wadl:doc>
|
||||
<response status="202"> &serverCreateParameters; <param
|
||||
@ -125,9 +123,10 @@
|
||||
</method>
|
||||
<method name="GET" id="getServersDetailed">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get Server Details with Config Drive">
|
||||
title="Get server details with configuration drive">
|
||||
<para role="shortdesc">Lists details for all servers
|
||||
including the config_drive extended attribute.</para>
|
||||
including the configuration drive extended
|
||||
attribute.</para>
|
||||
</wadl:doc>
|
||||
<response status="202"> &serverCreateParameters; <param
|
||||
name="config_drive" style="plain" type="csapi:UUID"
|
||||
|
||||
@ -5,28 +5,29 @@
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-deferred-delete-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Tenant ID"><para>The ID
|
||||
for the tenant or account in a
|
||||
multi-tenancy cloud. </para></wadl:doc>
|
||||
multi-tenancy cloud.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="Servers" path="servers">
|
||||
<resource path="{server_id}">
|
||||
<resource path="{server_id}" id="server_id">
|
||||
<param name="server_id" style="template"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Server UUID">
|
||||
<para> The UUID for the server of
|
||||
interest to you. </para>
|
||||
interest to you.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<resource path="action">
|
||||
<resource path="action" id="action">
|
||||
<method href="#forceDelete"/>
|
||||
<method href="#restore"/>
|
||||
</resource>
|
||||
@ -37,7 +38,7 @@
|
||||
</resources>
|
||||
<method name="POST" id="forceDelete">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Force Delete Server">
|
||||
title="Force delete server">
|
||||
<para role="shortdesc">Force-deletes a server.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -72,7 +73,7 @@
|
||||
</method>
|
||||
<method name="POST" id="restore">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Restore Server">
|
||||
title="Restore server">
|
||||
<para role="shortdesc">Restores a deleted server.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
|
||||
@ -5,11 +5,12 @@
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-diagnostics-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="csapi:UUID">
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The ID for the tenant or
|
||||
account in a multi-tenancy
|
||||
@ -35,7 +36,7 @@
|
||||
</resources>
|
||||
<method name="GET" id="getDiagnostics">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get Server Diagnostics">
|
||||
title="Get server diagnostics">
|
||||
<para role="shortdesc">Gets basic usage data for a
|
||||
specified server.</para>
|
||||
</wadl:doc>
|
||||
|
||||
@ -7,9 +7,10 @@
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="disk-config">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
@ -20,7 +21,7 @@
|
||||
</param>
|
||||
<resource id="Servers" path="servers">
|
||||
<method href="#createServer"/>
|
||||
<resource path="{server_id}">
|
||||
<resource path="{server_id}" id="server_id">
|
||||
<param name="server_id" style="template"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc
|
||||
@ -40,12 +41,12 @@
|
||||
</param>
|
||||
<method href="#getServer"/>
|
||||
<method href="#updateServer"/>
|
||||
<resource path="action">
|
||||
<resource path="action" id="action">
|
||||
<method href="#resize"/>
|
||||
<method href="#rebuild"/>
|
||||
</resource>
|
||||
</resource>
|
||||
<resource path="detail">
|
||||
<resource path="detail" id="detail">
|
||||
<method href="#getServersDetailed"/>
|
||||
</resource>
|
||||
</resource>
|
||||
@ -61,12 +62,10 @@
|
||||
</param>
|
||||
<method href="#getImage"/>
|
||||
</resource>
|
||||
|
||||
<resource path="detail">
|
||||
<resource path="detail" id="image_detail">
|
||||
<method href="#getImagesDetailed"/>
|
||||
</resource>
|
||||
</resource>
|
||||
|
||||
</resource>
|
||||
</resource>
|
||||
</resources>
|
||||
@ -234,6 +233,13 @@
|
||||
server.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<param name="OS-DCF:diskConfig" style="plain"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Valid value is AUTO or
|
||||
MANUAL.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
@ -258,6 +264,13 @@
|
||||
<para role="shortdesc">Lists servers.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<param name="OS-DCF:diskConfig" style="plain"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Valid value is AUTO or
|
||||
MANUAL.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
@ -283,6 +296,13 @@
|
||||
image.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<param name="OS-DCF:diskConfig" style="plain"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Valid value is AUTO or
|
||||
MANUAL.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
@ -307,6 +327,13 @@
|
||||
<para role="shortdesc">Lists images.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<param name="OS-DCF:diskConfig" style="plain"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Valid value is AUTO or
|
||||
MANUAL.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
|
||||
@ -3,11 +3,12 @@
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-ext-az-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
@ -16,30 +17,30 @@
|
||||
</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="Servers" path="servers">
|
||||
<resource path="{server_id}">
|
||||
<resource path="{server_id}" id="server_id">
|
||||
<param name="server_id" style="template"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The UUID for the
|
||||
server of interest to you.</para>
|
||||
xml:lang="EN">
|
||||
<para>The UUID for the server of
|
||||
interest to you.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#showServer"/>
|
||||
</resource>
|
||||
<resource path="detail">
|
||||
<resource path="detail" id="detail">
|
||||
<method href="#detailServers"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resources>
|
||||
|
||||
<method name="GET" id="showServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get server availability zone"><para
|
||||
role="shortdesc">Gets the availability zone for the
|
||||
specified instance. </para>
|
||||
title="Show server">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
server, including its availability zone.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -60,12 +61,11 @@
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
|
||||
<method name="GET" id="detailServers">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List details for all servers"><para
|
||||
role="shortdesc">Lists details for all servers.
|
||||
Includes their current availability zone. </para>
|
||||
title="List details for servers">
|
||||
<para role="shortdesc">Lists details for servers,
|
||||
including their current availability zone.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
|
||||
@ -1,17 +1,14 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
|
||||
<!-- (C) 2013 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:db="http://docbook.org/ns/docbook"
|
||||
xmlns:common="http://docs.openstack.org/common/api/v1.0"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<resources base="https://glance.example.com/">
|
||||
<resources base="https://glance.example.com/"
|
||||
xml:id="os-ext-img-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
@ -20,15 +17,15 @@
|
||||
multi-tenancy cloud.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
|
||||
<resource id="Images" type="#ImageList" path="images">
|
||||
<method href="#createImage"/>
|
||||
<resource path="detail" type="#DetailImageList"/>
|
||||
<resource path="{image_id}">
|
||||
<resource path="detail" id="detail"
|
||||
type="#DetailImageList"/>
|
||||
<resource path="{image_id}" id="image_id">
|
||||
<param name="image_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc
|
||||
xmlns="http://www.w3.org/1999/xhtml"
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Image ID">
|
||||
<para>Image ID stored through the
|
||||
image API. Typically a UUID.</para>
|
||||
@ -37,6 +34,7 @@
|
||||
<method href="#getImage"/>
|
||||
</resource>
|
||||
</resource>
|
||||
|
||||
</resource>
|
||||
</resource>
|
||||
</resources>
|
||||
@ -44,9 +42,17 @@
|
||||
<!-- Resource Types -->
|
||||
<!--*******************************************************-->
|
||||
<resource_type id="ImageList">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Image list">
|
||||
<para>List of images.</para>
|
||||
</wadl:doc>
|
||||
<method href="#listImage"/>
|
||||
</resource_type>
|
||||
<resource_type id="DetailImageList">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Image list with details">
|
||||
<para>List of images with details.</para>
|
||||
</wadl:doc>
|
||||
<method href="#listDetailImage"/>
|
||||
</resource_type>
|
||||
<!-- Method definitions -->
|
||||
@ -79,7 +85,7 @@
|
||||
</method>
|
||||
<method name="GET" id="listDetailImage">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List images (detailed)">
|
||||
title="List details for images">
|
||||
<para role="shortdesc">Lists details for available images.
|
||||
Includes the image size.</para>
|
||||
</wadl:doc>
|
||||
|
||||
@ -3,32 +3,32 @@
|
||||
<!-- (C) 2013 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/compute/api/v2">
|
||||
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-ext-ips-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
xml:lang="EN" title="Tenant ID">
|
||||
<para>The unique identifier of the tenant or
|
||||
account.</para>
|
||||
</wadl:doc>
|
||||
account.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="Servers" path="servers">
|
||||
<resource path="{server_id}">
|
||||
<resource path="{server_id}" id="server_id">
|
||||
<param name="server_id" style="template"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The UUID for the
|
||||
server of interest to
|
||||
you.</para></wadl:doc>
|
||||
xml:lang="EN" title="Server ID">
|
||||
<para>The UUID for the server of
|
||||
interest to you.</para></wadl:doc>
|
||||
</param>
|
||||
<resource path="action">
|
||||
<resource path="action" id="action">
|
||||
<method href="#serverIPDetails"/>
|
||||
</resource>
|
||||
</resource>
|
||||
@ -44,8 +44,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show IP type">
|
||||
<para role="shortdesc">Shows the type of IP assigned to a
|
||||
specified server. The type is either fixed or
|
||||
floating.</para>
|
||||
specified server, either fixed or floating.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -69,10 +68,9 @@
|
||||
|
||||
<method name="GET" id="serversIPList">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List IP types">
|
||||
<para role="shortdesc">Lists all servers and shows their
|
||||
IPs by type. The type is either fixed or
|
||||
floating.</para>
|
||||
title="List servers with IP type">
|
||||
<para role="shortdesc">Lists all servers showing their IPs
|
||||
by type, either fixed or floating.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
|
||||
@ -5,11 +5,22 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-extended-server-attributes-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="Servers" path="servers">
|
||||
<method href="#extended_server_attributes_detail"/>
|
||||
<resource path="{server_id}">
|
||||
<resource path="{server_id}" id="server_id">
|
||||
<param name="server_id" style="template"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"
|
||||
title="Extended attributes for server show">
|
||||
<para role="shortdesc">The UUID for the
|
||||
server of interest to you.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#extended_server_attributes_show"/>
|
||||
<resource>
|
||||
<param name="server_id" style="template"
|
||||
|
||||
@ -5,24 +5,26 @@
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-extended-status-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
ID for the tenant or account in a
|
||||
multi-tenancy cloud.</p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The ID for the tenant or
|
||||
account in a multi-tenancy
|
||||
cloud.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="Servers" path="servers">
|
||||
<resource path="{server_id}">
|
||||
<resource path="{server_id}" id="server_id">
|
||||
<param name="server_id" style="template"
|
||||
type="csapi:UUID">
|
||||
<doc><p
|
||||
xmlns="http://www.w3.org/1999/xhtml"
|
||||
>The UUID for the server of
|
||||
interest to you.</p>
|
||||
</doc>
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The UUID for the
|
||||
server of interest to
|
||||
you.</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#os-extended-status-show"/>
|
||||
</resource>
|
||||
@ -35,7 +37,7 @@
|
||||
</resources>
|
||||
<method name="GET" id="os-extended-status-show">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show Extended Status for Server">
|
||||
title="Show server extended status">
|
||||
<para role="shortdesc">Shows the extended status
|
||||
attributes in the response for a specified
|
||||
server.</para>
|
||||
@ -45,25 +47,27 @@
|
||||
<response status="200">
|
||||
<representation mediaType="application/json"
|
||||
element="csapi:meta">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/OS-EXT-STS/server-get-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml"
|
||||
element="csapi:meta">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/OS-EXT-STS/server-get-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="os-extended-status-detail">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Extended Status for Servers">
|
||||
title="List extended status for servers">
|
||||
<para role="shortdesc">Lists the extended status
|
||||
attributes in the detailed response for all servers. </para>
|
||||
<para>The extended status attributes are vm_state,
|
||||
@ -72,19 +76,21 @@
|
||||
<response status="200">
|
||||
<representation mediaType="application/json"
|
||||
element="csapi:meta">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/OS-EXT-STS/servers-detail-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml"
|
||||
element="csapi:meta">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/OS-EXT-STS/servers-detail-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
|
||||
@ -6,27 +6,28 @@
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-fixed-ips-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
ID for the tenant or account in a
|
||||
multi-tenancy cloud. </p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The ID for the tenant or
|
||||
account in a multi-tenancy
|
||||
cloud.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="os-fixed-ips" path="os-fixed-ips">
|
||||
<resource path="{fixed_ip}">
|
||||
<resource path="{fixed_ip}" id="fixed_ip">
|
||||
<param name="fixed_ip" style="template"
|
||||
type="xsd:string" required="true">
|
||||
<doc><p
|
||||
xmlns="http://www.w3.org/1999/xhtml"
|
||||
> The fixed IP of interest to you.
|
||||
</p></doc>
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The fixed IP of
|
||||
interest to you.</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#showIP"/>
|
||||
<resource path="action">
|
||||
<resource path="action" id="action">
|
||||
<method href="#reserveIP"/>
|
||||
</resource>
|
||||
</resource>
|
||||
@ -35,30 +36,33 @@
|
||||
</resource>
|
||||
</resources>
|
||||
<method name="GET" id="showIP">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para role="shortdesc">Gets data about a specified fixed
|
||||
IP address.</para>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show fixed IP information">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
fixed IP address.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-fixed-ips/fixedips-get-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-fixed-ips/fixedips-get-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="POST" id="reserveIP">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Reserve or Release a Fixed IP">
|
||||
title="Reserve or release a fixed IP">
|
||||
<para role="shortdesc">Reserves or releases a fixed
|
||||
IP.</para>
|
||||
<para>To reserve a fixed IP address, specify
|
||||
@ -68,18 +72,20 @@
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-fixed-ips/fixedip-post-req.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-fixed-ips/fixedip-post-req.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="202"/>
|
||||
|
||||
@ -8,11 +8,12 @@
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-flavor-access-v2">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
title="Flavor access" xml:lang="EN"/>
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
@ -48,7 +49,7 @@
|
||||
</resources>
|
||||
<method name="GET" id="detailAccess">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Flavors with Access Type">
|
||||
title="List flavors with access type">
|
||||
<para role="shortdesc">Lists flavors and includes the
|
||||
access type, which is public or private.</para>
|
||||
</wadl:doc>
|
||||
@ -79,7 +80,7 @@
|
||||
</method>
|
||||
<method name="POST" id="createAccess">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create Private Flavor">
|
||||
title="Create private flavor">
|
||||
<para role="shortdesc">Creates a private flavor.</para>
|
||||
</wadl:doc>
|
||||
<request> &flavorReqParameters; <param
|
||||
@ -134,7 +135,7 @@
|
||||
</method>
|
||||
<method name="GET" id="showAccess">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show Flavor Access Type">
|
||||
title="Show flavor access type">
|
||||
<para role="shortdesc">Gets the flavor access type, which
|
||||
is public or private.</para>
|
||||
</wadl:doc>
|
||||
@ -165,7 +166,7 @@
|
||||
</method>
|
||||
<method name="GET" id="listAccess">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Tenants with Access to Private Flavor">
|
||||
title="List tenants with access to private flavor">
|
||||
<para role="shortdesc">Lists tenants with access to the
|
||||
specified private flavor.</para>
|
||||
</wadl:doc>
|
||||
@ -202,7 +203,7 @@
|
||||
</method>
|
||||
<method name="POST" id="addTenantAccess">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Add Access to Private Flavor">
|
||||
title="Add access to private flavor">
|
||||
<para role="shortdesc">Gives a specified tenant access to
|
||||
the specified private flavor.</para>
|
||||
</wadl:doc>
|
||||
@ -270,7 +271,7 @@
|
||||
</method>
|
||||
<method name="DELETE" id="removeTenantAccess">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete Access from Private Flavor">
|
||||
title="Delete access from private flavor">
|
||||
<para role="shortdesc">Revokes access from the specified
|
||||
tenant for the specified private flavor.</para>
|
||||
</wadl:doc>
|
||||
|
||||
@ -6,16 +6,16 @@
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-flavor-extra-specs-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para> The ID for the tenant or
|
||||
account in a multi-tenancy cloud.
|
||||
</para></wadl:doc>
|
||||
xml:lang="EN"><para>The ID for the tenant or
|
||||
account in a multi-tenancy
|
||||
cloud.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="flavors" path="flavors">
|
||||
<resource path="{flavor_id}" id="flavor_id">
|
||||
@ -46,7 +46,7 @@
|
||||
|
||||
<method name="GET" id="listExtra-specs">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Flavor Extra Specs">
|
||||
title="List flavor extra specs">
|
||||
<para role="shortdesc">Lists the extra-specs or keys for
|
||||
the specified flavor.</para>
|
||||
</wadl:doc>
|
||||
@ -72,7 +72,7 @@
|
||||
|
||||
<method name="POST" id="createExtra-specs">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create Flavor Extra Specs">
|
||||
title="Create flavor extra specs">
|
||||
<para role="shortdesc">Creates extra-specs or keys for the
|
||||
specified flavor.</para>
|
||||
</wadl:doc>
|
||||
@ -116,7 +116,7 @@
|
||||
|
||||
<method name="PUT" id="updateDetailExtra-specs">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Update Flavor Extra Specs">
|
||||
title="Update flavor extra specs">
|
||||
<para role="shortdesc">Updates the value of the specified
|
||||
extra-spec or key.</para>
|
||||
</wadl:doc>
|
||||
@ -160,7 +160,7 @@
|
||||
|
||||
<method name="GET" id="detailExtra-spec">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get Flavor Extra Spec Details">
|
||||
title="Get flavor extra spec details">
|
||||
<para role="shortdesc">Gets the value of the specified
|
||||
key.</para>
|
||||
</wadl:doc>
|
||||
@ -186,7 +186,7 @@
|
||||
|
||||
<method name="DELETE" id="deleteDetailExtra-spec">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete Flavor Extra Specs">
|
||||
title="Delete flavor extra specs">
|
||||
<para role="shortdesc">Deletes a specified extra-spec by
|
||||
key.</para>
|
||||
</wadl:doc>
|
||||
|
||||
@ -8,11 +8,12 @@
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-flavor-rxtx-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="csapi:UUID">
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The ID for the tenant or account in a
|
||||
@ -72,7 +73,7 @@
|
||||
the rxtx_base property for the
|
||||
network.</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#createFlavor-rxtx"/>
|
||||
<method href="#createFlavor"/>
|
||||
<resource path="{flavor_id}" id="flavor_id">
|
||||
<param name="flavor_id" style="template">
|
||||
<wadl:doc
|
||||
@ -80,18 +81,18 @@
|
||||
xml:lang="EN">
|
||||
<para>The flavor ID.</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#getFlavor-rxtx"/>
|
||||
<method href="#getFlavor"/>
|
||||
</resource>
|
||||
<resource path="detail" id="detail">
|
||||
<method href="#getFlavorDetails-rxtx"/>
|
||||
<method href="#getFlavorDetails"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resources>
|
||||
<method name="POST" id="createFlavor-rxtx">
|
||||
<method name="POST" id="createFlavor">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create Flavor with rxtx_factor">
|
||||
title="Create flavor with rxtx_factor">
|
||||
<para role="shortdesc">Creates a flavor. Includes the
|
||||
rxtx_factor extended attribute.</para>
|
||||
</wadl:doc>
|
||||
@ -132,9 +133,9 @@
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getFlavor-rxtx">
|
||||
<method name="GET" id="getFlavor">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get Flavor with rxtx_factor">
|
||||
title="Get flavor with rxtx_factor">
|
||||
<para role="shortdesc">Gets details for a specified
|
||||
flavor. Includes the rxtx_factor extended
|
||||
attribute.</para>
|
||||
@ -160,9 +161,9 @@
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getFlavorDetails-rxtx">
|
||||
<method name="GET" id="getFlavorDetails">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get Flavor Details with rxtx_factor">
|
||||
title="Get flavor Details with rxtx_factor">
|
||||
<para role="shortdesc">Lists details for available flavors
|
||||
and includes the rxtx_factor extended
|
||||
attribute.</para>
|
||||
|
||||
@ -2,20 +2,22 @@
|
||||
<!-- (C) 2012-2013 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:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-flavorextradata-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="csapi:uuid">
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The ID for the tenant or account in a
|
||||
multi-tenancy cloud.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="Flavors" path="flavors">
|
||||
<method href="#createFlavor-extradata"/>
|
||||
<method href="#createFlavor"/>
|
||||
<resource path="{flavor_id}" id="flavor_id">
|
||||
<param name="flavor_id" style="template">
|
||||
<wadl:doc
|
||||
@ -24,18 +26,18 @@
|
||||
<para>The ID of the flavor of interest
|
||||
to you.</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#getFlavor-extradata"/>
|
||||
<method href="#getFlavor"/>
|
||||
</resource>
|
||||
<resource path="detail" id="detail">
|
||||
<method href="#getFlavorsDetails-extradata"/>
|
||||
<method href="#getFlavorsDetails"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resources>
|
||||
<method name="POST" id="createFlavor-extradata">
|
||||
<method name="POST" id="createFlavor">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create Flavor with Extra Data">
|
||||
title="Create flavor with extra data">
|
||||
<para role="shortdesc">Creates a flavor. Includes the
|
||||
rxtx_factor, OS-FLV-EXT-DATA:ephemeral, and swap
|
||||
extended attributes.</para>
|
||||
@ -128,9 +130,9 @@
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getFlavor-extradata">
|
||||
<method name="GET" id="getFlavor">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get Flavor Extra Data Details">
|
||||
title="Get flavor extra data details">
|
||||
<para role="shortdesc">Gets details for a specified
|
||||
flavor. Includes the rxtx_factor,
|
||||
OS-FLV-EXT-DATA:ephemeral, and swap extended
|
||||
@ -157,9 +159,9 @@
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getFlavorsDetails-extradata">
|
||||
<method name="GET" id="getFlavorsDetails">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Flavors with Extra Data">
|
||||
title="List flavors with extra data">
|
||||
<para role="shortdesc">Lists available flavors. Includes
|
||||
the rxtx_factor, OS-FLV-EXT-DATA:ephemeral, and swap
|
||||
extended attributes.</para>
|
||||
|
||||
@ -10,20 +10,20 @@
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-flavormanage-v2">
|
||||
<resource id="version" path="v2">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The unique ID of the tenant or
|
||||
account.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
|
||||
<resource id="flavors" path="flavors">
|
||||
<method href="#createFlavor"/>
|
||||
|
||||
<resource id="flavor_id" path="{flavor_id}">
|
||||
<param name="flavor_id" style="template">
|
||||
<wadl:doc
|
||||
@ -41,7 +41,7 @@
|
||||
|
||||
<method name="POST" id="createFlavor">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create Flavor">
|
||||
title="Create flavor">
|
||||
<para role="shortdesc">Creates a flavor.</para>
|
||||
</wadl:doc>
|
||||
|
||||
@ -119,7 +119,7 @@
|
||||
|
||||
<method name="DELETE" id="deleteFlavor">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete Flavor">
|
||||
title="Delete flavor">
|
||||
<para role="shortdesc">Deletes a flavor.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
@ -127,7 +127,7 @@
|
||||
|
||||
<method name="GET" id="listFlavors">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Flavors">
|
||||
title="List flavors">
|
||||
<para role="shortdesc">Lists available flavors.</para>
|
||||
</wadl:doc>
|
||||
<response status="200"/>
|
||||
|
||||
@ -5,7 +5,8 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-floating-ip-dns-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
@ -19,7 +20,7 @@
|
||||
<resource id="os-floating-ip-dns"
|
||||
path="os-floating-ip-dns">
|
||||
<method href="#ListDomains"/>
|
||||
<resource path="{domain}">
|
||||
<resource path="{domain}" id="domain">
|
||||
<param name="domain" style="template"
|
||||
required="true" type="xsd:string">
|
||||
<wadl:doc
|
||||
@ -31,7 +32,7 @@
|
||||
<method href="#CreateDomain"/>
|
||||
<method href="#DeleteDomain"/>
|
||||
<resource id="entries" path="entries">
|
||||
<resource path="{name}">
|
||||
<resource path="{name}" id="name">
|
||||
<param name="name" style="template"
|
||||
required="true" type="xsd:string">
|
||||
<wadl:doc
|
||||
@ -44,7 +45,7 @@
|
||||
<method href="#FindUniqueEntry"/>
|
||||
<method href="#DeleteEntry"/>
|
||||
</resource>
|
||||
<resource path="{ip}">
|
||||
<resource path="{ip}" id="ip">
|
||||
<method href="#FindEntriesbyIP"/>
|
||||
</resource>
|
||||
</resource>
|
||||
@ -80,7 +81,7 @@
|
||||
</method>
|
||||
<method name="PUT" id="CreateDomain">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create a Domain">
|
||||
title="Create or update DNS domain">
|
||||
<para role="shortdesc">Creates or updates a DNS
|
||||
domain.</para>
|
||||
</wadl:doc>
|
||||
@ -123,7 +124,7 @@
|
||||
</method>
|
||||
<method name="DELETE" id="DeleteDomain">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete a Domain">
|
||||
title="Delete DNS domain">
|
||||
<para role="shortdesc">Deletes a DNS domain and all
|
||||
associated host entries.</para>
|
||||
</wadl:doc>
|
||||
@ -131,7 +132,7 @@
|
||||
</method>
|
||||
<method name="PUT" id="CreateEntry">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create DNS Entry">
|
||||
title="Create or update DNS entry">
|
||||
<para role="shortdesc">Creates or updates a DNS
|
||||
entry.</para>
|
||||
</wadl:doc>
|
||||
@ -174,7 +175,7 @@
|
||||
</method>
|
||||
<method name="GET" id="FindUniqueEntry">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Find Unique DNS Entry">
|
||||
title="Find unique DNS entry">
|
||||
<para role="shortdesc">Finds a unique DNS entry for a
|
||||
specified domain and name.</para>
|
||||
</wadl:doc>
|
||||
@ -199,7 +200,7 @@
|
||||
</method>
|
||||
<method name="GET" id="FindEntriesbyIP">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Find DNS Entries">
|
||||
title="List DNS entries">
|
||||
<para role="shortdesc">Lists DNS entries for a specified
|
||||
domain and IP.</para>
|
||||
</wadl:doc>
|
||||
@ -224,7 +225,7 @@
|
||||
</method>
|
||||
<method name="DELETE" id="DeleteEntry">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete a DNS entry">
|
||||
title="Delete DNS entry">
|
||||
<para role="shortdesc">Deletes a specified DNS
|
||||
entry.</para>
|
||||
</wadl:doc>
|
||||
|
||||
@ -7,15 +7,17 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
|
||||
<resources base="https://floatingippools.example.com/">
|
||||
<resources base="https://floatingippools.example.com/"
|
||||
xml:id="os-floating-ip-pools-v2">
|
||||
<resource id="version" path="v2">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template" type="csapi:uuid">
|
||||
<doc>
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
unique identifier of the tenant or
|
||||
account.</p>
|
||||
</doc>
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The unique identifier of the tenant or
|
||||
account.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<resource id="floating-ip-pools"
|
||||
path="os-floating-ip-pools">
|
||||
@ -25,23 +27,26 @@
|
||||
</resource>
|
||||
</resources>
|
||||
<method name="GET" id="listFloatingIpPools">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="List Floating IP Pools">
|
||||
<para role="shortdesc">Lists floating IP
|
||||
pools.</para>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List floating IP pools">
|
||||
<para role="shortdesc">Lists floating IP pools.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-floating-ip-pools/floatingippools-list-resp.json"/>
|
||||
</doc>
|
||||
href="../api_samples/os-floating-ip-pools/floatingippools-list-resp.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-floating-ip-pools/floatingippools-list-resp.xml"/>
|
||||
</doc>
|
||||
href="../api_samples/os-floating-ip-pools/floatingippools-list-resp.xml"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
|
||||
@ -64,7 +64,7 @@
|
||||
</method>
|
||||
<method name="GET" id="ListFloatingIPsBulkbyHost">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Floating IPs by host">
|
||||
title="List floating IPs by host">
|
||||
<para role="shortdesc">Lists all floating IPs for a
|
||||
specified host.</para>
|
||||
</wadl:doc>
|
||||
@ -89,7 +89,7 @@
|
||||
</method>
|
||||
<method name="POST" id="CreateFloatingIPsBulk">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create Floating IPs">
|
||||
title="Create floating IPs">
|
||||
<para role="shortdesc">Bulk-creates floating IPs.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
|
||||
@ -1,7 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
|
||||
<!-- (C) 2013 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"
|
||||
@ -37,7 +35,7 @@
|
||||
</resource>
|
||||
</resource>
|
||||
<resource id="Servers" path="servers">
|
||||
<resource path="{server_id}">
|
||||
<resource path="{server_id}" id="server_id">
|
||||
<param name="server_id" style="template"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc
|
||||
@ -46,7 +44,7 @@
|
||||
server of interest to
|
||||
you.</para></wadl:doc>
|
||||
</param>
|
||||
<resource path="action">
|
||||
<resource path="action" id="action">
|
||||
<method href="#AddFloatingIP"/>
|
||||
<method href="#RemoveFloatingIP"/>
|
||||
</resource>
|
||||
@ -178,6 +176,12 @@
|
||||
instance.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<param name="pool" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The pool to which to add the
|
||||
floating IP address.</para></wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
@ -204,6 +208,19 @@
|
||||
instance.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<param name="removeFloatingIp" style="plain"
|
||||
required="true" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Specify the
|
||||
<code>removeFloatingIp</code> action in
|
||||
the request body.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="address" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The floating IP address that
|
||||
you want to remove.</para></wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
|
||||
@ -4,10 +4,11 @@
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-flv-disabled-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
@ -17,27 +18,30 @@
|
||||
</param>
|
||||
<resource id="Flavors" path="flavors">
|
||||
<resource path="{flavor_id}" id="flavor_id">
|
||||
<param name="flavor_id" style="template" type="csapi:uuid" required="true">
|
||||
<param name="flavor_id" style="template"
|
||||
type="csapi:uuid" required="true">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The ID of the flavor of interest
|
||||
to you.</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#getFlavor-flvdisabled"/>
|
||||
<method href="#getFlavor"/>
|
||||
</resource>
|
||||
<resource path="detail" id="detail">
|
||||
<method href="#getFlavorsDetails-flvdisabled"/>
|
||||
<method href="#getFlavorsDetails"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resources>
|
||||
<method name="GET" id="getFlavor-flvdisabled">
|
||||
<method name="GET" id="getFlavor">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get flavor disabled status details">
|
||||
<para role="shortdesc">Gets details for a specified
|
||||
flavor. Includes the <literal>OS-FLV-DISABLED:disabled</literal> attribute.</para>
|
||||
flavor. Includes the
|
||||
<literal>OS-FLV-DISABLED:disabled</literal>
|
||||
attribute.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -60,11 +64,12 @@
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getFlavorsDetails-flvdisabled">
|
||||
<method name="GET" id="getFlavorsDetails">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List flavors with flavor disabled status">
|
||||
<para role="shortdesc">Lists available flavors. Includes
|
||||
the <literal>OS-FLV-DISABLED:disabled</literal> attribute.</para>
|
||||
the <literal>OS-FLV-DISABLED:disabled</literal>
|
||||
attribute.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
|
||||
@ -1,43 +1,44 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
|
||||
<!-- (C) 2012-2013 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:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
|
||||
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-hosts-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="csapi:UUID">
|
||||
<doc>
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">The ID for the tenant or account in a
|
||||
multi-tenancy cloud. </p>
|
||||
</doc>
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Tenant ID">
|
||||
<para>The ID for the tenant or account in a
|
||||
multi-tenancy cloud.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<resource path="os-hosts">
|
||||
<resource path="os-hosts" id="os-hosts">
|
||||
<method href="#listHosts"/>
|
||||
<resource path="{host_name}">
|
||||
<resource path="{host_name}" id="host_name">
|
||||
<param name="host_name" style="template"
|
||||
type="xsd:string">
|
||||
<doc>
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">The name of the host of interest
|
||||
to you. </p>
|
||||
</doc>
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Host name">
|
||||
<para role="shortdesc">The name of the
|
||||
host of interest to you.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#showHost"/>
|
||||
<method href="#updateHost"/>
|
||||
<resource path="startup">
|
||||
<method href="#startup"/>
|
||||
<resource path="startup" id="startup">
|
||||
<method href="#startupHost"/>
|
||||
</resource>
|
||||
<resource path="shutdown">
|
||||
<method href="#shutdown"/>
|
||||
<resource path="shutdown" id="shutdown">
|
||||
<method href="#shutdownHost"/>
|
||||
</resource>
|
||||
<resource path="reboot">
|
||||
<method href="#reboot"/>
|
||||
<resource path="reboot" id="reboot">
|
||||
<method href="#rebootHost"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
@ -45,185 +46,206 @@
|
||||
</resource>
|
||||
</resources>
|
||||
<method name="GET" id="listHosts">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Lists all hosts. </p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List hosts">
|
||||
<para role="shortdesc">Lists hosts.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<param name="service" style="query" required="false"
|
||||
type="xsd:string">
|
||||
<doc>
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">The service name. To filter the returned
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Service name">
|
||||
<para>The service name. To filter the returned
|
||||
list by service name, specify
|
||||
<literal>?service={service}</literal> in
|
||||
the URI.</p>
|
||||
</doc>
|
||||
<code>?service={service}</code> in the
|
||||
URI.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param path="?zone={zone}" name="zone" style="query"
|
||||
required="false" type="xsd:string">
|
||||
<doc>
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">The zone. To filter the returned list by
|
||||
zone, specify <literal>?zone={zone}</literal>
|
||||
in the URI. </p>
|
||||
</doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Zone">
|
||||
<para>The zone. To filter the returned list by
|
||||
zone, specify <code>?zone={zone}</code> in the
|
||||
URI.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="List hosts: JSON response">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hosts/hosts-list-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="List hosts: XML response">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hosts/hosts-list-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="PUT" id="updateHost">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Enables a host or puts it in maintenance mode.
|
||||
</p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Update host">
|
||||
<para role="shortdesc">Enables a host or puts it in
|
||||
maintenance mode. </para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<param name="status" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<doc>
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Valid values are 'enable' or 'disable.'
|
||||
</p>
|
||||
</doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Status">
|
||||
<para>Valid values are enable or disable.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="maintenance_mode" style="plain"
|
||||
required="true" type="xsd:string">
|
||||
<doc>
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Valid values are 'enable' or
|
||||
'disable.'</p>
|
||||
</doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Maintenance mode">
|
||||
<para>Valid values are enable or disable.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Update host: JSON request">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hosts/host-put-maintenance-req.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Update host: XML request">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hosts/host-put-maintenance-req.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Update host: JSON response">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hosts/host-put-maintenance-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Update host: XML response">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hosts/host-put-maintenance-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
|
||||
<method name="GET" id="showHost">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Shows information for a specified host. </p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show host information">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
host.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"
|
||||
title="Show host information: JSON response">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hosts/host-get-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"
|
||||
title="Show host information: XML response">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hosts/host-get-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="startup">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Starts a host. </p>
|
||||
<method name="GET" id="startupHost">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Start host">
|
||||
<para role="shortdesc">Starts a host.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Start host: JSON response">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hosts/host-get-startup.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Start host: XML response">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hosts/host-get-startup.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
|
||||
<method name="GET" id="shutdown">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Shuts down a host. </p>
|
||||
<method name="GET" id="shutdownHost">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Shut down host">
|
||||
<para role="shortdesc">Shuts down a host.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"
|
||||
title="Shut down host: JSON response">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hosts/host-get-shutdown.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Shut down host: XML response">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hosts/host-get-shutdown.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
|
||||
|
||||
|
||||
<method name="GET" id="reboot">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Reboots a host. </p>
|
||||
<method name="GET" id="rebootHost">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Reboot host">
|
||||
<para role="shortdesc">Reboots a host.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Reboot host: JSON response">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hosts/host-get-reboot.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Reboot host: XML response">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hosts/host-get-reboot.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
|
||||
</application>
|
||||
|
||||
@ -5,14 +5,16 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-hypervisors-v2">
|
||||
<resource id="version" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="csapi:uuid">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
ID for the tenant or account in a
|
||||
multi-tenancy cloud.</p></doc>
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The ID for the tenant or account in a
|
||||
multi-tenancy cloud.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="os-hypervisors" path="os-hypervisors">
|
||||
<method href="#listHypervisors"/>
|
||||
@ -22,14 +24,16 @@
|
||||
<resource id="statistics" path="statistics">
|
||||
<method href="#getHypervisorStats"/>
|
||||
</resource>
|
||||
<resource path="{hypervisor_hostname}">
|
||||
<resource path="{hypervisor_hostname}"
|
||||
id="hypervisor_hostname">
|
||||
<param name="hypervisor_hostname"
|
||||
style="template" type="xsd:string">
|
||||
<doc><p
|
||||
xmlns="http://www.w3.org/1999/xhtml"
|
||||
>The name of the host that runs
|
||||
the hypervisor.</p>
|
||||
</doc>
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The name of the
|
||||
host that runs the
|
||||
hypervisor.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getHypervisorUptime"/>
|
||||
<resource id="servers" path="servers">
|
||||
@ -41,7 +45,8 @@
|
||||
</resource>
|
||||
</resources>
|
||||
<method name="GET" id="listHypervisors">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List hypervisors">
|
||||
<para role="shortdesc">Lists hypervisors information for
|
||||
each server obtained through the hypervisor-specific
|
||||
API, such as libvirt or XenAPI.</para>
|
||||
@ -49,33 +54,38 @@
|
||||
<response status="200">
|
||||
<param name="hypervisor_hostname" style="plain"
|
||||
required="true" type="xsd:string">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml"
|
||||
>Hypervisor host name, retrieved from the
|
||||
per-server listing.</p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Hypervisor host name,
|
||||
retrieved from the per-server
|
||||
listing.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="id" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml"
|
||||
>Hypervisor ID.</p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Hypervisor
|
||||
ID.</para></wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-list-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-list-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="showHypervisor">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show hypervisor information">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
hypervisor. Typically configured as an admin-only
|
||||
extension by using <filename>policy.json</filename>
|
||||
@ -83,81 +93,95 @@
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-detail-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-detail-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="listHypervisorInstances">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para role="shortdesc">Lists instances that belong to specific hypervisors.</para>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List instances for hypervisors">
|
||||
<para role="shortdesc">Lists instances that belong to
|
||||
specific hypervisors.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-servers-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-servers-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getHypervisorStats">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para role="shortdesc">Shows hypervisor statistics over all compute nodes.</para>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show statistics for hypervisors">
|
||||
<para role="shortdesc">Shows hypervisor statistics over
|
||||
all compute nodes.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-statistics-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-statistics-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getHypervisorUptime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para role="shortdesc">Shows the uptime for a specified hypervisor.</para>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show hypervisor up time">
|
||||
<para role="shortdesc">Shows the up time for a specified
|
||||
hypervisor.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-uptime-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-uptime-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
|
||||
@ -17,33 +17,41 @@
|
||||
<include href="../xsd/api.xsd"/>
|
||||
<include href="../xsd/api-common.xsd"/>
|
||||
</grammars>
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-instance-actions-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The
|
||||
ID for the tenant or account in a
|
||||
xml:lang="EN">
|
||||
<para>The ID for the tenant or account in a
|
||||
multi-tenancy cloud.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="Servers" path="servers">
|
||||
<resource path="{server_id}">
|
||||
<resource path="{server_id}" id="server_id">
|
||||
<param name="server_id" style="template"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The UUID of the server instance
|
||||
for which you want to list actions.
|
||||
</para></wadl:doc>
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
><para>The UUID of the server
|
||||
instance for which you want to list
|
||||
actions.</para></wadl:doc>
|
||||
</param>
|
||||
<resource path="os-instance-actions">
|
||||
<resource path="os-instance-actions"
|
||||
id="os-instance-actions">
|
||||
<method href="#listActions"/>
|
||||
<resource path="{action_id}">
|
||||
<resource path="{action_id}"
|
||||
id="action_id">
|
||||
<param name="action_id"
|
||||
style="template" type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The UUID of the action for which
|
||||
you want to get details.</para></wadl:doc>
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get Action Details">
|
||||
<para>The UUID of the action for
|
||||
which you want to get details.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getActionDetails"/>
|
||||
</resource>
|
||||
@ -53,28 +61,26 @@
|
||||
</resource>
|
||||
</resource>
|
||||
</resources>
|
||||
|
||||
<method name="GET" id="listActions">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"
|
||||
title="Get Server Actions">
|
||||
<para role="shortdesc">Lists available actions
|
||||
for a specified server.</para><para>Deployers set permissions for this request in the
|
||||
<filename>policy.json</filename> file. By default, all users
|
||||
can list actions.</para>
|
||||
</wadl:doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List server actions">
|
||||
<para role="shortdesc">Lists available actions for a
|
||||
specified server. Deployers set permissions for this
|
||||
request in the <filename>policy.json</filename> file.
|
||||
By default, all users can list
|
||||
actions.</para></wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-instance-actions/instance-actions-list-resp.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-instance-actions/instance-actions-list-resp.xml"
|
||||
/>
|
||||
@ -83,25 +89,26 @@
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getActionDetails">
|
||||
<wadl:doc xml:lang="EN" title="Get Action Details"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get action details">
|
||||
<para role="shortdesc">Gets details for a specified action
|
||||
for a specified server instance. Deployers set permissions for this request in the
|
||||
<filename>policy.json</filename> file. By default, only administrators can get details for an action.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
for a specified server instance. Deployers set
|
||||
permissions for this request in the
|
||||
<filename>policy.json</filename> file. By default,
|
||||
only administrators can get details for an action.
|
||||
</para></wadl:doc>
|
||||
<response status="200 203">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-instance-actions/instance-action-get-resp.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-instance-actions/instance-action-get-resp.xml"
|
||||
/>
|
||||
@ -110,5 +117,4 @@
|
||||
</response>
|
||||
<!-- Common Faults and GET Faults--> &commonFaults;
|
||||
&getFaults; </method>
|
||||
|
||||
</application>
|
||||
|
||||
@ -9,56 +9,60 @@
|
||||
xmlns:common="http://docs.openstack.org/common/api/v1.0"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:atom="http://www.w3.org/2005/Atom">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-instance-usage-audit-log-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="csapi:uuid">
|
||||
<doc>
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">The ID
|
||||
for the tenant or account in a
|
||||
multi-tenancy cloud.</p>
|
||||
</doc>
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The ID for the tenant or
|
||||
account in a multi-tenancy cloud.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<resource path="os-instance_usage_audit_log">
|
||||
<resource path="os-instance_usage_audit_log"
|
||||
id="os-instance_usage_log">
|
||||
<param name="begin" style="query"
|
||||
type="xsd:datetime">
|
||||
<doc>
|
||||
<p xmlns="http://www.w3.org/1999/xhtml"
|
||||
>The beginning of the audit period for
|
||||
which to get logs. Specify this
|
||||
parameter in the URI in the following
|
||||
format: <code>begin={begin}</code>.
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The beginning of the
|
||||
audit period for which to get logs.
|
||||
Specify this parameter in the URI in
|
||||
the following format:
|
||||
<code>begin={begin}</code>.
|
||||
Defaults to the beginning of the most
|
||||
recently completed audit period prior
|
||||
to the <code>before</code> date. </p>
|
||||
</doc>
|
||||
to the <code>before</code> date.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="end" path="end={end}" style="query"
|
||||
type="xsd:datetime">
|
||||
<doc>
|
||||
<p xmlns="http://www.w3.org/1999/xhtml"
|
||||
>The end of the audit period for which
|
||||
to get logs. Specify this parameter in
|
||||
the URI in the following format:
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The end of the audit
|
||||
period for which to get logs. Specify
|
||||
this parameter in the URI in the
|
||||
following format:
|
||||
<code>end={end}</code>. Defaults to
|
||||
the ending of the most recently
|
||||
completed audit period prior to the
|
||||
<code>before</code> date.</p>
|
||||
</doc>
|
||||
<code>before</code> date.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="before" path="before={before}"
|
||||
style="query" type="xsd:datetime">
|
||||
<doc>
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">By
|
||||
default, the audit period most
|
||||
recently completed before this date
|
||||
and time. Specify this parameter in
|
||||
the URI in the following format:
|
||||
<code>before={before}</code>. Has
|
||||
no effect if both begin and end are
|
||||
specified.</p>
|
||||
</doc>
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>By default, the audit
|
||||
period most recently completed before
|
||||
this date and time. Specify this
|
||||
parameter in the URI in the following
|
||||
format: <code>before={before}</code>.
|
||||
Has no effect if both begin and end
|
||||
are specified.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getInstanceUsageAuditLog"/>
|
||||
</resource>
|
||||
@ -67,28 +71,30 @@
|
||||
</resources>
|
||||
<method name="GET" id="getInstanceUsageAuditLog">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Admin-only Task Log Monitoring">
|
||||
title="Monitor task logs (admin only)">
|
||||
<para role="shortdesc">Enables administrators to view a
|
||||
full log for all instance usage audit tasks on all
|
||||
computes.</para>
|
||||
compute nodes.</para>
|
||||
<para>The instance usage audit runs on each compute host
|
||||
(<systemitem role="service"
|
||||
>nova-compute</systemitem> service).</para>
|
||||
</wadl:doc>
|
||||
<response status="202">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-instance_usage_audit_log/inst-usage-audit-log-show-get-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-instance_usage_audit_log/inst-usage-audit-log-show-get-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
|
||||
@ -6,26 +6,28 @@
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-keypairs-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
ID for the tenant or account in a
|
||||
multi-tenancy cloud.</p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The ID for the tenant or account in a
|
||||
multi-tenancy cloud.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="os-keypairs" path="os-keypairs">
|
||||
<method href="#getKeypair"/>
|
||||
<method href="#createKeypair"/>
|
||||
<resource path="{keypair_name}">
|
||||
<resource path="{keypair_name}" id="keypair_name">
|
||||
<param name="keypair_name" style="template"
|
||||
type="xsd:string">
|
||||
<doc><p
|
||||
xmlns="http://www.w3.org/1999/xhtml"
|
||||
>The name associated with a
|
||||
keypair. </p></doc>
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The name
|
||||
associated with a keypair.
|
||||
</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#deleteKeypair"/>
|
||||
<method href="#showKeypair"/>
|
||||
@ -35,94 +37,111 @@
|
||||
</resource>
|
||||
</resources>
|
||||
<method name="GET" id="getKeypair">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml"> Lists keypairs
|
||||
associated with the account. </p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List keypairs">
|
||||
<para role="shortdesc">Lists keypairs that are associated
|
||||
with the account.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-keypairs/keypairs-get-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-keypairs/keypairs-get-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
|
||||
<method name="GET" id="showKeypair">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Shows a keypair
|
||||
associated with the account. </p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show keypair information">
|
||||
<para role="shortdesc">Shows a keypair associated with the
|
||||
account.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/os-keypairs/keypair-show.json"/>
|
||||
</doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-keypairs/keypair-show.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
|
||||
<method name="DELETE" id="deleteKeypair">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Deletes a
|
||||
keypair.</p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete keypair">
|
||||
<para role="shortdesc">Deletes a keypair.</para>
|
||||
</wadl:doc>
|
||||
<response status="202"/>
|
||||
</method>
|
||||
|
||||
<method name="POST" id="createKeypair">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Generates or
|
||||
imports a keypair. </p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create or import keypair">
|
||||
<para role="shortdesc">Generates or imports a
|
||||
keypair.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<param name="name" style="plain" required="true" type="xsd:string">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The name
|
||||
to associate with the keypair.</p></doc>
|
||||
<param name="name" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The name to associate with the
|
||||
keypair.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="public_key" style="plain" type="xsd:string" required="false">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
public ssh key to import. If not provided, a
|
||||
key is generated. </p></doc>
|
||||
<param name="public_key" style="plain" type="xsd:string"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The public ssh key to import. If not
|
||||
provided, a key is generated.
|
||||
</para></wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-keypairs/keypairs-import-post-req.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-keypairs/keypairs-import-post-req.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-keypairs/keypairs-import-post-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-keypairs/keypairs-import-post-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
|
||||
@ -7,10 +7,10 @@
|
||||
xmlns:csapi="http://docs.openstack.org/api/compute/2.0"
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-migrations-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xml:lang="EN"
|
||||
@ -19,12 +19,13 @@
|
||||
a multi-tenancy cloud.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="os-migrations" path="os-migrations">
|
||||
<param name="host" style="query"
|
||||
required="false" type="xsd:string"
|
||||
path="host={host_name}">
|
||||
<param name="host" style="query" required="false"
|
||||
type="xsd:string" path="host={host_name}">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
><para>Filters the response by host name. Include the host name in the URI as follows:
|
||||
><para>Filters the response by host
|
||||
name. Include the host name in the URI
|
||||
as follows:
|
||||
<code>host={host}</code>.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="status" style="query"
|
||||
@ -32,7 +33,9 @@
|
||||
path="status={status}">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
><para>Filters the response by status. Include the status in the URI as follows:
|
||||
><para>Filters the response by status.
|
||||
Include the status in the URI as
|
||||
follows:
|
||||
<code>status={status}</code>.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="cell_name" style="query"
|
||||
@ -40,8 +43,10 @@
|
||||
path="cell_name={cell_name}">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
><para>Filters the response by cell name. Include the cell name in the URI as follows:
|
||||
<code>cell_name={cell}</code>.</para></wadl:doc>
|
||||
><para>Filters the response by cell
|
||||
name. Include the cell name in the URI
|
||||
as follows:
|
||||
<code>cell_name={cell}</code>.</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#getMigrations"/>
|
||||
</resource>
|
||||
@ -49,7 +54,8 @@
|
||||
</resource>
|
||||
</resources>
|
||||
<method name="GET" id="getMigrations">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get migrations">
|
||||
<para role="shortdesc">Enables an administrative user to
|
||||
fetch in-progress migrations for a region or specified
|
||||
cell in a region.</para>
|
||||
|
||||
@ -7,9 +7,10 @@
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="multiple-create-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
@ -18,16 +19,15 @@
|
||||
cloud.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="Servers" path="servers">
|
||||
<method href="#createServer-multiple"/>
|
||||
|
||||
<resource path="{server_id}">
|
||||
<method href="#createServer"/>
|
||||
<resource path="{server_id}" id="server_id">
|
||||
<param name="server_id" style="template"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The UUID for the
|
||||
server of interest to you.</para>
|
||||
</wadl:doc>
|
||||
server of interest to
|
||||
you.</para></wadl:doc>
|
||||
</param>
|
||||
</resource>
|
||||
</resource>
|
||||
@ -35,43 +35,36 @@
|
||||
</resource>
|
||||
</resources>
|
||||
|
||||
<method name="POST" id="createServer-multiple">
|
||||
<method name="POST" id="createServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create Multiple Servers">
|
||||
title="Create multiple servers">
|
||||
<para role="shortdesc">Creates one or more servers with an
|
||||
optional reservation ID.</para>
|
||||
</wadl:doc>
|
||||
|
||||
<request> &serverCreateParameters; <param
|
||||
name="return_reservation_id" style="query"
|
||||
required="false" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>Set to <code>True</code>to generate a
|
||||
reservation ID for each server. Omit this
|
||||
attribute to create servers without a
|
||||
reservation ID. This extended attribute is
|
||||
xml:lang="EN"><para>Set to <code>True</code>to
|
||||
generate a reservation ID for each server.
|
||||
Omit this attribute to create servers without
|
||||
a reservation ID. This extended attribute is
|
||||
enabled when the service provider enables
|
||||
multiple server launch.</para>
|
||||
</wadl:doc>
|
||||
multiple server launch.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="min_count" style="query" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The minimum number of servers to launch when
|
||||
the service provider enables multiple server
|
||||
launch.</para>
|
||||
</wadl:doc>
|
||||
xml:lang="EN"><para>The minimum number of servers
|
||||
to launch when the service provider enables
|
||||
multiple server launch.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="max_count" style="query" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The maximum number of servers to launch when
|
||||
the service provider enables multiple server
|
||||
launch.</para>
|
||||
</wadl:doc>
|
||||
xml:lang="EN"><para>The maximum number of servers
|
||||
to launch when the service provider enables
|
||||
multiple server launch.</para></wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
|
||||
@ -7,7 +7,8 @@
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:csapi="http://docs.rackspacecloud.com/csapi/v1.0"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-networks-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
@ -20,32 +21,32 @@
|
||||
<method href="#CreateNetwork"/>
|
||||
<resource id="os-networks" path="os-networks">
|
||||
<method href="#ListNetworks"/>
|
||||
<resource path="add">
|
||||
<resource path="add" id="add">
|
||||
<param name="id" style="template"
|
||||
required="true" type="csapi:UUID">
|
||||
required="true" type="csapi:uuid">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The UUID of the network to add
|
||||
to the project. Specify
|
||||
<code>None</code> to choose a
|
||||
random available network.</para>
|
||||
</wadl:doc>
|
||||
random available
|
||||
network.</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#AddNetwork"/>
|
||||
</resource>
|
||||
<resource path="{id}">
|
||||
<resource path="{id}" id="id">
|
||||
<param name="id" style="template"
|
||||
required="true" type="csapi:UUID">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The unique
|
||||
identifier associated with the
|
||||
network.</para></wadl:doc>
|
||||
xml:lang="EN">
|
||||
<para>The unique identifier associated
|
||||
with the network.</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#GetNetwork"/>
|
||||
<method href="#DeleteNetwork"/>
|
||||
<resource path="action">
|
||||
<resource path="action" id="action">
|
||||
<method href="#AssociateHost"/>
|
||||
<method href="#DisassociateHost"/>
|
||||
<method href="#DisassociateNetwork"/>
|
||||
@ -57,65 +58,61 @@
|
||||
</resource>
|
||||
</resources>
|
||||
<method name="GET" id="ListNetworks">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="List Networks">
|
||||
<para role="shortdesc">Lists all networks that are
|
||||
available to the tenant.</para>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List networks">
|
||||
<para role="shortdesc">Lists networks that are available
|
||||
to the tenant.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-networks/networks-list-resp.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-networks/networks-list-resp.xml"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="GetNetwork">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="Get Network Detail">
|
||||
<para role="shortdesc">Gets information about a specified
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show network information">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
network.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-networks/network-show-resp.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-networks/network-show-resp.xml"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="DELETE" id="DeleteNetwork">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="Delete Network">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete network">
|
||||
<para role="shortdesc">Deletes a specified network.</para>
|
||||
</wadl:doc>
|
||||
<response status="202"/>
|
||||
</method>
|
||||
<method name="POST" id="DisassociateNetwork">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="Disassociate Network">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Disassociate network">
|
||||
<para role="shortdesc">Disassociates a specified network
|
||||
from a project so that the network can be
|
||||
reused.</para>
|
||||
@ -141,8 +138,8 @@
|
||||
<response status="202"/>
|
||||
</method>
|
||||
<method name="POST" id="DisassociateProject">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="Disassociate Project">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Disassociate project">
|
||||
<para role="shortdesc">Disassociates the project from a
|
||||
specified network.</para>
|
||||
</wadl:doc>
|
||||
@ -167,8 +164,8 @@
|
||||
<response status="202"/>
|
||||
</method>
|
||||
<method name="POST" id="DisassociateHost">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="Disassociate Host">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Disassociate host">
|
||||
<para role="shortdesc">Disassociates the host from a
|
||||
specified network.</para>
|
||||
</wadl:doc>
|
||||
@ -193,8 +190,8 @@
|
||||
<response status="202"/>
|
||||
</method>
|
||||
<method name="POST" id="AssociateHost">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="Associate Host">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Associate host">
|
||||
<para role="shortdesc">Associates a specified network with
|
||||
a host.</para>
|
||||
</wadl:doc>
|
||||
@ -219,107 +216,124 @@
|
||||
<response status="202"/>
|
||||
</method>
|
||||
<method name="POST" id="AddNetwork">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="Add Network">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Add network">
|
||||
<para role="shortdesc">Adds a specified network to a
|
||||
project.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-networks/network-add-req.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-networks/network-add-req.xml"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="202"/>
|
||||
</method>
|
||||
<method name="POST" id="CreateNetwork">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="Create Network">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create network">
|
||||
<para role="shortdesc">Creates a network.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<param name="network" style="plain" required="true"
|
||||
type="csapi:dict">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>A dictionary representation of
|
||||
a network.</para></wadl:doc>
|
||||
xml:lang="EN" title="Create multiple servers">
|
||||
<para role="shortdesc">A dictionary representation
|
||||
of a network. </para></wadl:doc>
|
||||
</param>
|
||||
<param name="label" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Network
|
||||
xml:lang="EN" title="Create multiple servers">
|
||||
<para role="shortdesc">Network
|
||||
label.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="bridge" style="plain" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>VIFs on this network are
|
||||
connected to this bridge.</para></wadl:doc>
|
||||
xml:lang="EN" title="Create multiple servers">
|
||||
<para role="shortdesc">VIFs on this network are
|
||||
connected to this bridge. </para></wadl:doc>
|
||||
</param>
|
||||
<param name="bridge_interface" style="plain"
|
||||
required="false" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The bridge is connected to
|
||||
this interface.</para></wadl:doc>
|
||||
xml:lang="EN" title="Create multiple servers">
|
||||
<para role="shortdesc">The bridge is connected to
|
||||
this interface. </para></wadl:doc>
|
||||
</param>
|
||||
<param name="cidr" style="plain" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>IPv4 subnet.</para></wadl:doc>
|
||||
xml:lang="EN" title="Create multiple servers">
|
||||
<para role="shortdesc">IPv4
|
||||
subnet.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="multi_host" style="plain" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Multi host.</para></wadl:doc>
|
||||
xml:lang="EN" title="Create multiple servers">
|
||||
<para role="shortdesc">Multi
|
||||
host.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="vlan" style="plain" required="false"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Vlan id.</para></wadl:doc>
|
||||
xml:lang="EN" title="Create multiple servers">
|
||||
<para role="shortdesc">Vlan id. </para></wadl:doc>
|
||||
</param>
|
||||
<param name="cidr_v6" style="plain" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>IPv6 subnet.</para></wadl:doc>
|
||||
xml:lang="EN" title="Create multiple servers">
|
||||
<para role="shortdesc">IPv6
|
||||
subnet.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="dns1" style="plain" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>First DNS.</para></wadl:doc>
|
||||
xml:lang="EN" title="Create multiple servers">
|
||||
<para role="shortdesc">First
|
||||
DNS.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="dns2" style="plain" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Second DNS.</para></wadl:doc>
|
||||
xml:lang="EN" title="Create multiple servers">
|
||||
<para role="shortdesc">Second
|
||||
DNS.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="gateway" style="plain" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>IPv4
|
||||
xml:lang="EN" title="Create multiple servers">
|
||||
<para role="shortdesc">IPv4
|
||||
gateway.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="gateway_v6" style="plain" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>IPv6
|
||||
xml:lang="EN" title="Create multiple servers">
|
||||
<para role="shortdesc">IPv6
|
||||
gateway.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="project_id" style="plain" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Project id.</para></wadl:doc>
|
||||
xml:lang="EN" title="Create multiple servers">
|
||||
<para role="shortdesc">Project
|
||||
id.</para></wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
|
||||
@ -7,7 +7,8 @@
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-quota-sets-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
@ -17,7 +18,7 @@
|
||||
<para>The ID for the tenant or project in a
|
||||
multi-tenancy cloud.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="Quotas" path="os-quota-sets">
|
||||
<resource id="os-quota-sets" path="os-quota-sets">
|
||||
<method href="#showQuota"/>
|
||||
<method href="#updateQuota"/>
|
||||
<resource path="defaults" id="defaults">
|
||||
|
||||
@ -2,16 +2,17 @@
|
||||
<!-- (C) 2013 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:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-rescue-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Tenant ID"><para> The ID
|
||||
xml:lang="EN" title="Tenant ID"><para>The ID
|
||||
for the tenant or account in a
|
||||
multi-tenancy cloud.</para></wadl:doc>
|
||||
</param>
|
||||
@ -94,8 +95,7 @@
|
||||
<method name="POST" id="unrescue">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Unrescue server">
|
||||
<para role="shortdesc">Returns a server to its state
|
||||
before being rescued.</para>
|
||||
<para role="shortdesc">Unrescues a server.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<param name="unrescue" style="plain" type="xsd:string"
|
||||
|
||||
@ -7,63 +7,69 @@
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-scheduler-hints-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
ID for the tenant or account in a
|
||||
multi-tenancy cloud.</p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The ID for the tenant or
|
||||
account in a multi-tenancy
|
||||
cloud.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="Servers" path="servers">
|
||||
<method href="#createServerWithSchedulerHints"/>
|
||||
<method href="#createServer"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resources>
|
||||
<method name="POST" id="createServerWithSchedulerHints">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Creates a server
|
||||
with scheduler hints that are passed directly to the
|
||||
scheduler.</p>
|
||||
<method name="POST" id="createServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create server with scheduler hints"><para
|
||||
role="shortdesc">Creates a server with scheduler hints
|
||||
that are passed directly to the scheduler.</para>
|
||||
</wadl:doc>
|
||||
<request> &serverCreateParameters; <param
|
||||
name="os:scheduler_hints" style="plain"
|
||||
required="true" type="xsd:dict">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml"
|
||||
>Dictionary of data to send to the scheduler.
|
||||
</p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Dictionary of data to send to
|
||||
the scheduler. </para></wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/OS-SCH-HNT/scheduler-hints-post-req.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/OS-SCH-HNT/scheduler-hints-post-req.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200"> &serverListParameters;
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<response status="200"> &serverListParameters; <representation
|
||||
mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/OS-SCH-HNT/scheduler-hints-post-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/OS-SCH-HNT/scheduler-hints-post-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
|
||||
@ -5,7 +5,8 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
|
||||
<resources base="https://servers.api.openstack.com/">
|
||||
<resources base="https://servers.api.openstack.com/"
|
||||
xml:id="os-security-group-default-rules-v2">
|
||||
<resource id="version" path="v2">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
@ -16,7 +17,7 @@
|
||||
account.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<resource id="security_groups_rules"
|
||||
<resource id="os-security-group-rules"
|
||||
path="os-security-group-rules">
|
||||
<method href="#listSecGroupDefaultRules"/>
|
||||
<method href="#createSecGroupRule"/>
|
||||
@ -40,42 +41,48 @@
|
||||
</resources>
|
||||
<method name="GET" id="listSecGroupDefaultRules">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Default Security Group Rules">
|
||||
title="List default security group rules">
|
||||
<para role="shortdesc">Lists default security group
|
||||
rules.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<param name="from_port" style="plain" type="xsd:int" required="true">
|
||||
<param name="from_port" style="plain" type="xsd:int"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="From port">
|
||||
<para>Port at start of range.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="id" style="plain" type="csapi:UUID" required="true">
|
||||
<param name="id" style="plain" type="csapi:UUID"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Security group ID">
|
||||
<para>Security group ID.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="ip_protocol" style="plain" type="xsd:string" required="true">
|
||||
<param name="ip_protocol" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="IP protocol">
|
||||
<para>The IP protocol: ICMP, TCP, or UDP.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="ip_range" style="plain" type="xsd:string" required="true">
|
||||
<param name="ip_range" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="IP range">
|
||||
<para>An IP range object.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="cidr" style="plain" type="xsd:string" required="true">
|
||||
<param name="cidr" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="CIDR">
|
||||
<para>The CIDR for address range.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="to_port" style="plain" type="xsd:int" required="true">
|
||||
<param name="to_port" style="plain" type="xsd:int"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="To port">
|
||||
<para>Port at end of range.</para>
|
||||
@ -103,42 +110,48 @@
|
||||
</method>
|
||||
<method name="GET" id="showSecGroupDefaultRule">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show Default Security Group Rule Information">
|
||||
title="Show default security group rule information">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
security group rule.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<param name="from_port" style="plain" type="xsd:int" required="true">
|
||||
<param name="from_port" style="plain" type="xsd:int"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="From port">
|
||||
<para>Port at start of range.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="id" style="plain" type="csapi:UUID" required="true">
|
||||
<param name="id" style="plain" type="csapi:UUID"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Security group ID">
|
||||
<para>Security group ID.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="ip_protocol" style="plain" type="xsd:string" required="true">
|
||||
<param name="ip_protocol" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="IP protocol">
|
||||
<para>The IP protocol: ICMP, TCP, or UDP.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="ip_range" style="plain" type="xsd:string" required="true">
|
||||
<param name="ip_range" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="IP range">
|
||||
<para>An IP range object.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="cidr" style="plain" type="xsd:string" required="true">
|
||||
<param name="cidr" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="CIDR">
|
||||
<para>The CIDR for address range.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="to_port" style="plain" type="xsd:int" required="true">
|
||||
<param name="to_port" style="plain" type="xsd:int"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="To port">
|
||||
<para>Port at end of range.</para>
|
||||
@ -166,7 +179,7 @@
|
||||
</method>
|
||||
<method name="POST" id="createSecGroupRule">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create Default Security Group Rule">
|
||||
title="Create default security group rule">
|
||||
<para role="shortdesc">Creates a default security group
|
||||
rule.</para>
|
||||
</wadl:doc>
|
||||
@ -226,37 +239,43 @@
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<param name="from_port" style="plain" type="xsd:int" required="true">
|
||||
<param name="from_port" style="plain" type="xsd:int"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="From port">
|
||||
<para>Port at start of range.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="id" style="plain" type="csapi:UUID" required="true">
|
||||
<param name="id" style="plain" type="csapi:UUID"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Security group ID">
|
||||
<para>Security group ID.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="ip_protocol" style="plain" type="xsd:string" required="true">
|
||||
<param name="ip_protocol" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="IP protocol">
|
||||
<para>The IP protocol: ICMP, TCP, or UDP.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="ip_range" style="plain" type="xsd:string" required="true">
|
||||
<param name="ip_range" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="IP range">
|
||||
<para>An IP range object.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="cidr" style="plain" type="xsd:string" required="true">
|
||||
<param name="cidr" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="CIDR">
|
||||
<para>The CIDR for address range.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="to_port" style="plain" type="xsd:int" required="true">
|
||||
<param name="to_port" style="plain" type="xsd:int"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="To port">
|
||||
<para>Port at end of range.</para>
|
||||
|
||||
@ -5,7 +5,8 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
|
||||
<resources base="https://servers.api.openstack.com/">
|
||||
<resources base="https://servers.api.openstack.com/"
|
||||
xml:id="os-security-groups-v2">
|
||||
<resource id="version" path="v2">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
@ -16,7 +17,7 @@
|
||||
account.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<resource id="security_groups"
|
||||
<resource id="os-security_groups"
|
||||
path="os-security-groups">
|
||||
<method href="#listSecGroups"/>
|
||||
<resource id="Servers" path="servers">
|
||||
@ -38,7 +39,7 @@
|
||||
</resource>
|
||||
</resource>
|
||||
<method href="#createSecGroup"/>
|
||||
<resource id="get_security_group"
|
||||
<resource id="security_group_id"
|
||||
path="{security_group_id}">
|
||||
<param name="security_group_id"
|
||||
style="template" type="csapi:uuid">
|
||||
@ -58,7 +59,7 @@
|
||||
</resources>
|
||||
<method name="GET" id="listSecGroups">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Security Groups">
|
||||
title="List security groups">
|
||||
<para role="shortdesc">Lists security groups.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -125,7 +126,7 @@
|
||||
</method>
|
||||
<method name="GET" id="listSecGroupsByServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Security Groups by Server">
|
||||
title="List security groups by server">
|
||||
<para role="shortdesc">Lists security groups for a
|
||||
specified server.</para>
|
||||
</wadl:doc>
|
||||
@ -193,7 +194,7 @@
|
||||
</method>
|
||||
<method name="GET" id="showSecGroup">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show Security Group">
|
||||
title="Show security group information">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
security group.</para>
|
||||
</wadl:doc>
|
||||
@ -262,7 +263,7 @@
|
||||
</method>
|
||||
<method name="POST" id="createSecGroup">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create Security Group">
|
||||
title="Create security group">
|
||||
<para role="shortdesc">Creates a security group.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -371,7 +372,7 @@
|
||||
</method>
|
||||
<method name="DELETE" id="deleteSecGroup">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete Security Group">
|
||||
title="Delete security group">
|
||||
<para role="shortdesc">Deletes a specified security
|
||||
group.</para>
|
||||
</wadl:doc>
|
||||
|
||||
@ -7,141 +7,148 @@
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="OS-EXT-IPS-MAC-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<doc>
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">The ID
|
||||
for the tenant or account in a
|
||||
multi-tenancy cloud.</p>
|
||||
</doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The ID for the tenant or
|
||||
account in a multi-tenancy
|
||||
cloud.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="Servers" path="servers">
|
||||
<method href="#createServer-OS-EXT-IPS-MAC"/>
|
||||
<resource path="{server_id}">
|
||||
<method href="#createServer"/>
|
||||
<resource path="{server_id}" id="server_id">
|
||||
<param name="server_id" style="template"
|
||||
type="csapi:UUID">
|
||||
<doc>
|
||||
<p
|
||||
xmlns="http://www.w3.org/1999/xhtml"
|
||||
>The UUID for the server of
|
||||
interest to you.</p>
|
||||
</doc>
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The UUID for the
|
||||
server of interest to
|
||||
you.</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#getServer-OS-EXT-IPS-MAC"/>
|
||||
<method href="#getServer"/>
|
||||
</resource>
|
||||
<resource id="ServersDetail" path="detail">
|
||||
<method
|
||||
href="#getServersDetailed-OS-EXT-IPS-MAC"
|
||||
/>
|
||||
<resource id="detail" path="detail">
|
||||
<method href="#getServersDetailed"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resources>
|
||||
<method name="POST" id="createServer-OS-EXT-IPS-MAC">
|
||||
<method name="POST" id="createServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create Server">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Creates a server
|
||||
with the OS-EXT-IPS-MAC:mac_addr extended
|
||||
attribute.</p>
|
||||
title="Create server with OS-EXT-IPS-MAC:mac_addr
|
||||
extended attribute">
|
||||
<para role="shortdesc">Creates a server with the
|
||||
OS-EXT-IPS-MAC:mac_addr extended attribute.</para>
|
||||
</wadl:doc>
|
||||
<request> &serverCreateParameters; <param
|
||||
name="OS-EXT-IPS-MAC:mac_addr" style="plain"
|
||||
type="xsd:string" required="false">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml"
|
||||
>Associated MAC address.</p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Associated MAC
|
||||
address.</para></wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/OS-EXT-IPS-MAC/server-post-req.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/OS-EXT-IPS-MAC/server-post-req.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="202"> &serverListParameters;
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<response status="202"> &serverListParameters; <representation
|
||||
mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/OS-EXT-IPS-MAC/server-post-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/OS-EXT-IPS-MAC/server-post-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getServer-OS-EXT-IPS-MAC">
|
||||
<method name="GET" id="getServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show Server Information">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Shows information
|
||||
for a specified server. Includes the
|
||||
OS-EXT-IPS-MAC:mac_addr extended attribute.</p>
|
||||
title="Show server information">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
server. Includes the OS-EXT-IPS-MAC:mac_addr extended
|
||||
attribute.</para>
|
||||
</wadl:doc>
|
||||
<response status="202"> &serverListParameters; <param
|
||||
name="OS-EXT-IPS-MAC:mac_addr" style="plain"
|
||||
type="xsd:string" required="false">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml"
|
||||
>Associated MAC address.</p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Associated MAC
|
||||
address.</para></wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/OS-EXT-IPS-MAC/server-get-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/OS-EXT-IPS-MAC/server-get-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getServersDetailed-OS-EXT-IPS-MAC">
|
||||
<method name="GET" id="getServersDetailed">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get Server Details">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Lists details for
|
||||
all servers. Includes the OS-EXT-IPS-MAC:mac_addr
|
||||
extended attribute.</p>
|
||||
title="Get server details">
|
||||
<para role="shortdesc">Lists details for all servers.
|
||||
Includes the OS-EXT-IPS-MAC:mac_addr extended
|
||||
attribute.</para>
|
||||
</wadl:doc>
|
||||
<response status="202"> &serverListParameters; <param
|
||||
name="OS-EXT-IPS-MAC:mac_addr" style="plain"
|
||||
type="xsd:string" required="false">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml"
|
||||
>Associated MAC address.</p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Associated MAC
|
||||
address.</para></wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/OS-EXT-IPS-MAC/servers-detail-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/OS-EXT-IPS-MAC/servers-detail-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
|
||||
@ -5,16 +5,18 @@
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-server-password-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="Servers" path="servers">
|
||||
<resource path="{server_id}">
|
||||
<resource path="{server_id}" id="server_id">
|
||||
<param name="server_id" style="template"
|
||||
type="csapi:UUID">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">
|
||||
The UUID for the server of interest to
|
||||
you. </p>
|
||||
</doc>
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para> The UUID for the
|
||||
server of interest to you.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<resource id="os-server-password"
|
||||
path="os-server-password">
|
||||
@ -28,30 +30,32 @@
|
||||
|
||||
<method name="GET" id="getPassword">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get Server Password">
|
||||
title="Get server password">
|
||||
<para role="shortdesc">Gets the administrative password
|
||||
for a specified server.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-server-password/get-password-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-server-password/get-password-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="DELETE" id="resetPassword">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Clear Server Password">
|
||||
title="Clear server password">
|
||||
<para role="shortdesc">Clears the encrypted copy of the
|
||||
password in the metadata server. This is done after
|
||||
the client has retrieved the password and knows it
|
||||
@ -60,34 +64,38 @@
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-server-password/server-post-req.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-server-password/server-post-req.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-server-password/server-post-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-server-password/server-post-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
|
||||
@ -2,19 +2,19 @@
|
||||
<!-- (C) 2012-2013 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:xsd="http://docs.rackspacecloud.com/xsd/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/compute/api/v1.1">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-server-start-stop-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Tenant ID"><para>The ID
|
||||
for the tenant or account in a
|
||||
multi-tenancy cloud.</para></wadl:doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Tenant ID"><para>The ID for the
|
||||
tenant or account in a multi-tenancy
|
||||
cloud.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="Servers" path="servers">
|
||||
<resource path="{server_id}" id="server_id">
|
||||
@ -22,73 +22,35 @@
|
||||
type="csapi:UUID">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Server UUID"
|
||||
><para>The UUID for the server of
|
||||
interest to you.</para>
|
||||
</wadl:doc>
|
||||
xml:lang="EN" title="Server UUID"><para>The
|
||||
UUID for the server of interest to
|
||||
you.</para></wadl:doc>
|
||||
</param>
|
||||
<resource path="action" id="action">
|
||||
<method href="#stop"/>
|
||||
<method href="#start"/>
|
||||
<method href="#stop"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resources>
|
||||
<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. Changes
|
||||
status to STOPPED.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<param name="os-stop" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Stop action"><para>Specify
|
||||
the <code>os-stop</code> action in the request
|
||||
body.</para></wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Stop server: JSON request">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-server-start-stop/server-stop-req.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Stop server: XML request">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-server-start-stop/server-stop-req.xml"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="202"/>
|
||||
</method>
|
||||
<method name="POST" id="start">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Start Server"><para role="shortdesc">Returns a
|
||||
STOPPED server to ACTIVE status.</para>
|
||||
title="Start server">
|
||||
<para role="shortdesc">Starts a stopped server and changes
|
||||
its status to ACTIVE.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<param name="os-start" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
required="true" id="os-start">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/wadl:docbook"
|
||||
xml:lang="EN" title="Start action"><para>Specify
|
||||
the <code>os-start</code> action in the
|
||||
request body.</para></wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
<wadl:doc xmlns="http://docbook.org/ns/wadl:docbook"
|
||||
xml:lang="EN" title="Start server: JSON request">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-server-start-stop/server-start-req.json"
|
||||
@ -96,8 +58,7 @@
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
<wadl:doc xmlns="http://docbook.org/ns/wadl:docbook"
|
||||
xml:lang="EN" title="Start server: XML request">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-server-start-stop/server-stop-req.xml"
|
||||
@ -107,4 +68,37 @@
|
||||
</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 STOPPED.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<param name="os-stop" style="plain" type="xsd:string"
|
||||
required="true" id="os-stop">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/wadl:docbook"
|
||||
xml:lang="EN" title="Stop action"><para>Specify
|
||||
the <code>os-stop</code> action in the request
|
||||
body.</para></wadl:doc>
|
||||
</param>
|
||||
<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/os-server-start-stop/server-stop-req.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/wadl:docbook"
|
||||
xml:lang="EN" title="Stop server: XML request">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-server-start-stop/server-stop-req.xml"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="202"/>
|
||||
</method>
|
||||
</application>
|
||||
|
||||
@ -7,27 +7,30 @@
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-services-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
ID for the tenant or account in a
|
||||
multi-tenancy cloud.</p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The ID for the tenant or
|
||||
account in a multi-tenancy
|
||||
cloud.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="os-services" path="os-services">
|
||||
<method href="#listServices"/>
|
||||
<resource path="enable">
|
||||
<resource path="enable" id="enable">
|
||||
<method href="#enableScheduling"/>
|
||||
</resource>
|
||||
<resource path="disable">
|
||||
<resource path="disable" id="disable">
|
||||
<method href="#disableScheduling"/>
|
||||
</resource>
|
||||
<resource path="disable-log-reason">
|
||||
</resource>
|
||||
<resource path="disable-log-reason"
|
||||
id="disable-log-reason">
|
||||
<method href="#disableLogReason"/>
|
||||
</resource>
|
||||
<resource path="detail">
|
||||
<resource path="detail" id="detail">
|
||||
<method href="#getDisableReasonDetail"/>
|
||||
</resource>
|
||||
</resource>
|
||||
@ -35,139 +38,158 @@
|
||||
</resource>
|
||||
</resources>
|
||||
<method name="GET" id="listServices">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">>Lists all running services.</para>
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List services">
|
||||
<para role="shortdesc">Lists running services.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-services/services-list-get-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="PUT" id="enableScheduling">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Enable scheduling for a service">
|
||||
<para role="shortdesc">Enables scheduling for a
|
||||
service.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-services/service-enable-put-req.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-services/service-enable-put-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="PUT" id="disableScheduling">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Disable scheduling for a service">
|
||||
<para role="shortdesc">Disables scheduling for a
|
||||
service.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-services/service-disable-put-req.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-services/service-disable-put-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="PUT" id="disableLogReason">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Log disabled service information">
|
||||
<para role="shortdesc">Logs information to the service
|
||||
table about why a service was disabled.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<param name="host" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The host
|
||||
name.</p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The host
|
||||
name.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="binary" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
service name.</p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The service
|
||||
name.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="disabled_reason" style="plain"
|
||||
type="xsd:string" required="true">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
reason the service was disabled.</p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The reason the service was
|
||||
disabled.</para></wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-services/service-disable-log-put-req.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-services/service-disable-log-put-req.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-services/service-disable-log-put-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-services/service-disable-log-put-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getDisableReasonDetail">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List disabled services">
|
||||
<para role="shortdesc">Lists disabled services. If
|
||||
information exists, includes reasons why services were
|
||||
disabled.</para></wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-services/services-get-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-services/services-get-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
|
||||
@ -4,7 +4,8 @@
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-simple-tenant-usage-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
@ -18,7 +19,7 @@
|
||||
<resource id="os-simple-tenant-usage"
|
||||
path="os-simple-tenant-usage">
|
||||
<method href="#ListUsage"/>
|
||||
<resource path="{tenant_id}">
|
||||
<resource path="{tenant_id}" id="tenant_id">
|
||||
<param name="tenant_id" style="template"
|
||||
required="true">
|
||||
<wadl:doc
|
||||
|
||||
@ -1,31 +1,33 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
|
||||
<!-- (C) 2012-2013 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:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-used-limits-for-admins-v2">
|
||||
<resource id="version" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="csapi:uuid">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
ID for the tenant or account in a
|
||||
multi-tenancy cloud.</p></doc>
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Tenant ID"><para>The ID
|
||||
for the tenant or account in a
|
||||
multi-tenancy cloud.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="Limits" path="limits">
|
||||
<resource id="customer_tenantId"
|
||||
path="tenant_id={customer_tenant_id}">
|
||||
<param name="customer_tenant_id"
|
||||
style="template" type="csapi:uuid">
|
||||
<doc><p
|
||||
xmlns="http://www.w3.org/1999/xhtml"
|
||||
>The ID for the tenant for which
|
||||
an administrator wants to get quota
|
||||
information.</p></doc>
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="csapi:uuid">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Tenant ID"
|
||||
><para>The ID for the tenant for
|
||||
which an administrator wants to get
|
||||
quota information. Specify the
|
||||
customer tenant ID in the URI as
|
||||
<code>tenant_id={tenant_id}</code>.</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#getCustomerLimits"/>
|
||||
</resource>
|
||||
@ -33,32 +35,33 @@
|
||||
</resource>
|
||||
</resource>
|
||||
</resources>
|
||||
|
||||
<method name="GET" id="getCustomerLimits">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Enables administrators to get absolute
|
||||
and rate limit information, including information on
|
||||
currently used absolute limits, for the specified customer tenant ID.</p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get customer limits" xml:lang="EN">
|
||||
<para role="shortdesc">Enables administrators to get
|
||||
absolute and rate limit information, including
|
||||
information about currently used absolute limits, for
|
||||
a specified customer tenant ID.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN"
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"
|
||||
title="Used limits for admins: JSON response">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-used-limits-for-admin/usedlimitsforadmin-get-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN"
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"
|
||||
title="Used limits for admins: XML response">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-used-limits-for-admin/usedlimitsforadmin-get-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
|
||||
</application>
|
||||
|
||||
|
||||
@ -4,17 +4,19 @@
|
||||
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-used-limits-v2">
|
||||
<resource id="version" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="csapi:uuid">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
ID for the tenant or account in a
|
||||
multi-tenancy cloud.</p></doc>
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Tenant ID">
|
||||
<para>The ID for the tenant or account in a
|
||||
multi-tenancy cloud.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="Limits" path="limits">
|
||||
<method href="#getLimits"/>
|
||||
@ -22,45 +24,30 @@
|
||||
</resource>
|
||||
</resource>
|
||||
</resources>
|
||||
|
||||
<method name="GET" id="getLimits">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Returns absolute
|
||||
and rate limit information, including information on
|
||||
currently used absolute limits.</p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get limits">
|
||||
<para role="shortdesc">Gets absolute and rate limit
|
||||
information, including information on currently used
|
||||
absolute limits.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN" title="Used limits: JSON response">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-used-limits/usedlimits-get-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN" title="Used limits: XML response">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-used-limits/usedlimits-get-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</representation>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN"
|
||||
title="Used limits for admins: JSON response">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-used-limits-for-admin/usedlimitsforadmin-get-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN"
|
||||
title="Used limits for admins: XML response">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-used-limits-for-admin/usedlimitsforadmin-get-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
|
||||
</application>
|
||||
|
||||
@ -9,26 +9,31 @@
|
||||
xmlns:common="http://docs.openstack.org/common/api/v1.0"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:atom="http://www.w3.org/2005/Atom">
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-virtual-interfaces-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string" required="true">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The ID for the tenant or account in a
|
||||
multi-tenancy cloud. </para>
|
||||
multi-tenancy cloud.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<resource id="Servers" path="servers">
|
||||
<resource path="{server_id}">
|
||||
<resource path="{server_id}" id="server_id">
|
||||
<param name="server_id" style="template"
|
||||
type="csapi:UUID" required="true">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
|
||||
type="csapi:UUID">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The UUID for the server of
|
||||
interest to you. </para>
|
||||
interest to you.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<resource path="os-virtual-interfaces">
|
||||
<resource path="os-virtual-interfaces"
|
||||
id="os-virtual-interfaces">
|
||||
<method href="#getVirtualInterfaces"/>
|
||||
<method href="#getVirtualInterfacesShowWhichNetwork"/>
|
||||
</resource>
|
||||
@ -38,24 +43,27 @@
|
||||
</resource>
|
||||
</resources>
|
||||
<method name="GET" id="getVirtualInterfaces">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" title="Show virtual interface">
|
||||
<para role="shortdesc" >Lists the virtual
|
||||
interface for a specified instance.</para>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List virtual interfaces">
|
||||
<para role="shortdesc">Lists the virtual interfaces for a
|
||||
specified instance.</para>
|
||||
</wadl:doc>
|
||||
<response status="202">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-virtual-interfaces/vifs-list-resp.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-virtual-interfaces/vifs-list-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
|
||||
@ -1,38 +1,40 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:db="http://docbook.org/ns/docbook"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:common="http://docs.openstack.org/common/api/v1.0"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:atom="http://www.w3.org/2005/Atom">
|
||||
<resources base="https://volume.example.com/">
|
||||
<resources base="https://volume.example.com/"
|
||||
xml:id="os-volume-v2">
|
||||
<resource id="version" path="v1.1">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template" type="xsd:string">
|
||||
<doc>
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">The
|
||||
unique identifier of the tenant or
|
||||
account.</p>
|
||||
</doc>
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The unique identifier of the tenant or
|
||||
account.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<resource id="os-volumes" path="os-volumes">
|
||||
<method href="#getVolumesSimple"/>
|
||||
<resource path="detail">
|
||||
<resource path="detail" id="detail">
|
||||
<method href="#getVolumesDetail"/>
|
||||
</resource>
|
||||
<resource path="{volume_id}">
|
||||
<resource path="{volume_id}" id="volume_id">
|
||||
<param name="volume_id" style="template"
|
||||
required="true" type="xsd:string">
|
||||
<doc>
|
||||
<p
|
||||
xmlns="http://www.w3.org/1999/xhtml"
|
||||
>The unique identifier for a
|
||||
volume.</p>
|
||||
</doc>
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The unique identifier for a
|
||||
volume.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#createVolume"/>
|
||||
<method href="#getVolume"/>
|
||||
@ -41,15 +43,16 @@
|
||||
</resource>
|
||||
<resource id="os-volume-types" path="os-volume-types">
|
||||
<method href="#getVolumeTypes"/>
|
||||
<resource path="{volume_type_id}">
|
||||
<resource path="{volume_type_id}"
|
||||
id="volume_type_id">
|
||||
<param name="volume_type_id" style="template"
|
||||
required="true" type="xsd:string">
|
||||
<doc>
|
||||
<p
|
||||
xmlns="http://www.w3.org/1999/xhtml"
|
||||
>The unique identifier for a volume
|
||||
type.</p>
|
||||
</doc>
|
||||
required="true" type="xsd:string">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The unique identifier for a
|
||||
volume type.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getVolumeType"/>
|
||||
</resource>
|
||||
@ -57,18 +60,18 @@
|
||||
<resource id="os-snapshots" path="os-snapshots">
|
||||
<method href="#createSnapshot"/>
|
||||
<method href="#getSnapshotsSimple"/>
|
||||
<resource path="detail">
|
||||
<resource path="detail" id="detail-snapshot">
|
||||
<method href="#getSnapshotsDetail"/>
|
||||
</resource>
|
||||
<resource path="{snapshot_id}">
|
||||
<resource path="{snapshot_id}" id="snapshot_id">
|
||||
<param name="snapshot_id" style="template"
|
||||
required="true" type="xsd:string">
|
||||
<doc>
|
||||
<p
|
||||
xmlns="http://www.w3.org/1999/xhtml"
|
||||
>The unique identifier for a
|
||||
snapshot.</p>
|
||||
</doc>
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The unique identifier for a
|
||||
snapshot.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getSnapshot"/>
|
||||
<method href="#deleteSnapshot"/>
|
||||
@ -78,278 +81,336 @@
|
||||
</resource>
|
||||
</resources>
|
||||
<method name="POST" id="createVolume">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="Create Volume">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Creates a volume.
|
||||
The operation requires a request body.</p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create volume">
|
||||
<para role="shortdesc">Creates a volume.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<param name="volume" style="plain" required="true" type="xsd:string">
|
||||
<doc>
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">A partial
|
||||
representation of a volume that is used to
|
||||
create a volume.</p>
|
||||
</doc>
|
||||
</param>
|
||||
<param name="volume" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>A partial representation of a volume that is
|
||||
used to create a volume.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/os-volume/volume_create.json"/>
|
||||
</doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/volume_create.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/os-volume/volume_create.xml"/>
|
||||
</doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/volume_create.xml"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="201">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/os-volume/volume_show.json"/>
|
||||
</doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/volume_show.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/os-volume/volume_show.xml"/>
|
||||
</doc>
|
||||
</representation>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/volume_show.xml"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getVolumesSimple">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="List Volumes">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Lists the volumes
|
||||
associated with the account. The operation does not
|
||||
require a request body.</p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List volumes">
|
||||
<para role="shortdesc">Lists the volumes associated with
|
||||
the account.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/volume_list_simple.json"/>
|
||||
</doc>
|
||||
href="../api_samples/os-volume/volume_list_simple.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/volume_list_simple.xml"/>
|
||||
</doc>
|
||||
href="../api_samples/os-volume/volume_list_simple.xml"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getVolumesDetail">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="List Volumes (Detailed)">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Lists details for
|
||||
a specified volume. The operation does not require a
|
||||
request body.</p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List details for volumes">
|
||||
<para role="shortdesc">Lists details for a specified
|
||||
volume.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/volume_list_simple.json"/>
|
||||
</doc>
|
||||
href="../api_samples/os-volume/volume_list_simple.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/volume_list_simple.xml"/>
|
||||
</doc>
|
||||
href="../api_samples/os-volume/volume_list_simple.xml"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getVolume">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="Show Volume">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Shows information
|
||||
for a specified volume.</p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show volume information">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
volume.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/os-volume/volume_show.json"/>
|
||||
</doc>
|
||||
</representation><representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/os-volume/volume_show.xml"/>
|
||||
</doc>
|
||||
</representation>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/volume_show.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/volume_show.xml"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="DELETE" id="deleteVolume">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="Delete Volume">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Deletes a
|
||||
specified volume.</p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete volume">
|
||||
<para role="shortdesc">Deletes a specified volume.</para>
|
||||
</wadl:doc>
|
||||
<response status="202">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/os-volume/volume_delete.json"/>
|
||||
</doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/volume_delete.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getVolumeTypes">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="List Volume Types">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Lists volume
|
||||
types.</p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List volume types">
|
||||
<para role="shortdesc">Lists volume types.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/volume_type_list.json"/>
|
||||
</doc>
|
||||
href="../api_samples/os-volume/volume_type_list.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/os-volume/volume_type_list.xml"
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/volume_type_list.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getVolumeType">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="Show Volume Type">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Shows information
|
||||
for a specified volume type.</p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show volume type">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
volume type.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/volume_type_show.json"/>
|
||||
</doc>
|
||||
href="../api_samples/os-volume/volume_type_show.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/os-volume/volume_type_show.xml"
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/volume_type_show.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="POST" id="createSnapshot">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="Create Snapshot">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Creates a
|
||||
snapshot.</p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create snapshot">
|
||||
<para role="shortdesc">Creates a snapshot.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<param name="snapshot" style="plain" required="true" type="xsd:string">
|
||||
<doc>
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">A partial
|
||||
representation of a snapshot that is used to
|
||||
create a snapshot.</p>
|
||||
</doc>
|
||||
</param>
|
||||
<param name="snapshot" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>A partial representation of a snapshot that
|
||||
is used to create a snapshot.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/os-volume/snapshot_create.json"
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/snapshot_create.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/os-volume/snapshot_create.xml"
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/snapshot_create.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="201">
|
||||
<response status="201">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/os-volume/snapshot_show.json"/>
|
||||
</doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/snapshot_show.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/os-volume/snapshot_show.xml"/>
|
||||
</doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/snapshot_show.xml"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getSnapshotsSimple">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="List Snapshots">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Lists snapshots.
|
||||
</p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List snapshots">
|
||||
<para role="shortdesc">Lists snapshots.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/snapshot_list_simple.json"/>
|
||||
</doc>
|
||||
</representation><representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
href="../api_samples/os-volume/snapshot_list_simple.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/snapshot_list_simple.xml"/>
|
||||
</doc>
|
||||
</representation>
|
||||
href="../api_samples/os-volume/snapshot_list_simple.xml"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getSnapshotsDetail">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="List Snapshots (Detailed)">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Lists details for
|
||||
a specified snapshot. The operation does not require a
|
||||
request body.</p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List details for snapshots">
|
||||
<para role="shortdesc">Lists details for a specified
|
||||
snapshot.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/snapshot_list_simple.json"/>
|
||||
</doc>
|
||||
</representation><representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
href="../api_samples/os-volume/snapshot_list_simple.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/snapshot_list_simple.xml"/>
|
||||
</doc>
|
||||
</representation>
|
||||
href="../api_samples/os-volume/snapshot_list_simple.xml"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getSnapshot">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="Show Snapshot">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Shows information
|
||||
for a specified snapshot.</p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show snapshot">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
snapshot.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/os-volume/snapshot_show.json"/>
|
||||
</doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/snapshot_show.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/os-volume/snapshot_show.xml"/>
|
||||
</doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/snapshot_show.xml"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="DELETE" id="deleteSnapshot">
|
||||
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
|
||||
title="Delete Snapshot">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Deletes a
|
||||
specified snapshot from the account. The operation
|
||||
does not require a request body and does not return a
|
||||
response body.</p>
|
||||
<p>This operation is asynchronous. You must list snapshots
|
||||
repeatedly to determine whether the snapshot was
|
||||
deleted.</p>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete snapshot">
|
||||
<para role="shortdesc">Deletes a specified snapshot from
|
||||
the account.</para>
|
||||
<para>This operation is asynchronous. You must list
|
||||
snapshots repeatedly to determine whether the snapshot
|
||||
was deleted.</para>
|
||||
</wadl:doc>
|
||||
<response status="202">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/os-volume/snapshot_delete.json"
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volume/snapshot_delete.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
|
||||
@ -12,55 +12,48 @@
|
||||
%common;
|
||||
]>
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:csapi="http://docs.openstack.org/api/compute/2.0"
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:html="http://www.w3.org/1999/xhtml"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"
|
||||
xsi:schemaLocation="http://docs.openstack.org/compute/api/v1.1
|
||||
../xsd/api.xsd
|
||||
http://docs.openstack.org/common/api/v1.0
|
||||
../xsd/api-common.xsd
|
||||
">
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<grammars>
|
||||
<include href="../xsd/api.xsd"/>
|
||||
<include href="../xsd/api-common.xsd"/>
|
||||
</grammars>
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-volume-attachments-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<doc>
|
||||
<p xmlns="http://www.w3.org/1999/xhtml"> The
|
||||
ID for the tenant or account in a
|
||||
multi-tenancy cloud. </p>
|
||||
</doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The ID for the tenant or account in a
|
||||
multi-tenancy cloud.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<resource id="Servers" path="servers">
|
||||
<resource path="{server_id}">
|
||||
<resource path="{server_id}" id="server_id">
|
||||
<param name="server_id" style="template"
|
||||
type="csapi:UUID">
|
||||
<doc>
|
||||
<p
|
||||
xmlns="http://www.w3.org/1999/xhtml"
|
||||
> The UUID for the server of
|
||||
interest to you. </p>
|
||||
</doc>
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The UUID for the server of
|
||||
interest to you.</para></wadl:doc>
|
||||
</param>
|
||||
<resource path="os-volume_attachments"
|
||||
type="#Volumes">
|
||||
type="#Volumes" id="os-volume-attachments">
|
||||
<resource path="{attachment_id}"
|
||||
type="#VolumeAttachmentList">
|
||||
type="#VolumeAttachmentList"
|
||||
id="attachment_id">
|
||||
<param name="attachment_id"
|
||||
style="template" type="xsd:string">
|
||||
<doc xml:lang="EN"
|
||||
title="attachment_id">
|
||||
<p
|
||||
xmlns="http://www.w3.org/1999/xhtml"
|
||||
> Volume attachment ID. </p>
|
||||
</doc>
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>Volume attachment
|
||||
ID.</para></wadl:doc>
|
||||
</param>
|
||||
</resource>
|
||||
</resource>
|
||||
@ -73,18 +66,18 @@
|
||||
<!-- Resource Types -->
|
||||
<!--*******************************************************-->
|
||||
<resource_type id="Volumes">
|
||||
<doc xml:lang="EN" title="Volumes">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml"> A list of volume
|
||||
attachments associated with a server. </p>
|
||||
</doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Volume attachment list">
|
||||
<para>A list of volume attachments associated with a
|
||||
server.</para></wadl:doc>
|
||||
<method href="#attachVolume"/>
|
||||
<method href="#listVolumeAttachments"/>
|
||||
</resource_type>
|
||||
<resource_type id="VolumeAttachmentList">
|
||||
<doc xml:lang="EN" title="Volume Attachment List">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml"> A list of volume
|
||||
attachments associated with a server. </p>
|
||||
</doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Volume attachment list">
|
||||
<para>A list of volume attachments associated with a
|
||||
server.</para></wadl:doc>
|
||||
<method href="#getVolumeAttachmentDetails"/>
|
||||
<method href="#deleteVolumeAttachment"/>
|
||||
</resource_type>
|
||||
@ -94,66 +87,75 @@
|
||||
<!--****************************************************** -->
|
||||
<!-- Volume Actions -->
|
||||
<method name="POST" id="attachVolume">
|
||||
<doc xml:lang="EN" title="Attach Volume to Server">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml"> Attaches a volume
|
||||
to the specified server. </p>
|
||||
</doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Attach volume">
|
||||
<para role="shortdesc">Attaches a volume to the specified
|
||||
server.</para></wadl:doc>
|
||||
<request>
|
||||
<param name="volumeId" style="template" type="xsd:string">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml"> ID of
|
||||
the volume to attach. </p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>ID of the volume to attach.
|
||||
</para></wadl:doc>
|
||||
</param>
|
||||
<param name="device" style="template" type="xsd:string">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml"> Name of
|
||||
the device such as, /dev/vdb. Use "auto" for
|
||||
auto-assign (if supported). </p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>Name of the device such as, /dev/vdb. Use
|
||||
"auto" for auto-assign (if
|
||||
supported).</para></wadl:doc>
|
||||
</param>
|
||||
<param name="volumeAttachment" style="template"
|
||||
type="xsd:string">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml"> A
|
||||
dictionary representation of a volume
|
||||
attachment. </p></doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>A dictionary representation of a volume
|
||||
attachment.</para></wadl:doc>
|
||||
</param>
|
||||
<representation mediaType="application/xml"
|
||||
element="csapi:attachvolume">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volumes/attach-volume-to-server-req.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volumes/attach-volume-to-server-req.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="202">
|
||||
<representation mediaType="application/xml"
|
||||
element="csapi:attachvolume">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volumes/attach-volume-to-server-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volumes/attach-volume-to-server-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
<!-- Common, GET, postput, inProgress Faults--> &commonFaults;
|
||||
&getFaults; &postPutFaults; &inProgressFault; </method>
|
||||
<method name="GET" id="listVolumeAttachments">
|
||||
<doc xml:lang="EN" title="List Volume Attachments">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Lists the volume
|
||||
attachments for the specified server. </p>
|
||||
</doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List volume attachments">
|
||||
<para role="shortdesc">Lists the volume attachments for a
|
||||
specified server.</para></wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml"
|
||||
element="csapi:attachvolume"/>
|
||||
@ -162,26 +164,30 @@
|
||||
</request>
|
||||
<response status="202">
|
||||
<representation mediaType="application/xml"
|
||||
element="csapi:attachvolume"><doc xml:lang="EN">
|
||||
element="csapi:attachvolume">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volumes/list-volume-attachments-resp.xml"
|
||||
/>
|
||||
</doc></representation>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volumes/list-volume-attachments-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
<!-- Common, GET, postput, inProgress Faults--> &commonFaults;
|
||||
&getFaults; &postPutFaults; &inProgressFault; </method>
|
||||
<method name="GET" id="getVolumeAttachmentDetails">
|
||||
<doc xml:lang="EN" title="Get Volume Attachment Details">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml">Lists volume
|
||||
details for the specified volume attachment ID. </p>
|
||||
</doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show volume attachment details">
|
||||
<para role="shortdesc">Shows details for the specified
|
||||
volume attachment.</para></wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml"
|
||||
element="csapi:attachvolume"/>
|
||||
@ -190,27 +196,30 @@
|
||||
</request>
|
||||
<response status="202">
|
||||
<representation mediaType="application/xml"
|
||||
element="csapi:attachvolume"> <doc xml:lang="EN">
|
||||
element="csapi:attachvolume">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volumes/volume-attachment-detail-resp.xml"
|
||||
/>
|
||||
</doc></representation>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-volumes/volume-attachment-detail-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
<!-- Common, GET, postput, inProgress Faults--> &commonFaults;
|
||||
&getFaults; &postPutFaults; &inProgressFault; </method>
|
||||
<method name="DELETE" id="deleteVolumeAttachment">
|
||||
<doc xml:lang="EN" title="Delete Volume Attachment">
|
||||
<p xmlns="http://www.w3.org/1999/xhtml"> Deletes the
|
||||
specified volume attachment from the specified server.
|
||||
</p>
|
||||
</doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete volume attachment">
|
||||
<para role="shortdesc">Deletes the specified volume
|
||||
attachment from a specified server. </para></wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml"
|
||||
element="csapi:attachvolume"/>
|
||||
|
||||
@ -23,9 +23,10 @@
|
||||
<!--*******************************************************-->
|
||||
<!-- All Resources -->
|
||||
<!--*******************************************************-->
|
||||
<resources base="https://servers.api.openstack.com">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-compute-v2">
|
||||
<resource id="version" type="#VersionDetails" path="v2/">
|
||||
<resource id="tenantID" path="{tenant_id}">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
@ -96,7 +97,7 @@
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"
|
||||
title="Metadata Item Key">
|
||||
title="Metadata item key">
|
||||
<para>A string. Maximum length is
|
||||
255 characters.</para>
|
||||
</wadl:doc>
|
||||
@ -151,7 +152,7 @@
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"
|
||||
title="Metadata Item Key">
|
||||
title="Metadata item key">
|
||||
<para>A string. Maximum length is
|
||||
255 characters.</para>
|
||||
</wadl:doc>
|
||||
@ -188,25 +189,29 @@
|
||||
<!--*******************************************************-->
|
||||
|
||||
<resource_type id="VersionDetails">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Version details">
|
||||
<para>Details for a version.</para>
|
||||
</wadl:doc>
|
||||
<method href="#versionDetails"/>
|
||||
</resource_type>
|
||||
<resource_type id="ExtensionList">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Detail Image List">
|
||||
title="Detail image list">
|
||||
<para>A list of supported extensions.</para>
|
||||
</wadl:doc>
|
||||
<method href="#listExtensions"/>
|
||||
</resource_type>
|
||||
<resource_type id="DetailServerList">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Detail Image List">
|
||||
title="Detail server list">
|
||||
<para>A detailed server list.</para>
|
||||
</wadl:doc>
|
||||
<method href="#listDetailServers"/>
|
||||
</resource_type>
|
||||
<resource_type id="ServerList">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Server List">
|
||||
title="Server list">
|
||||
<para>A list of servers. Each server contains IDs, names,
|
||||
and links. Other attributes are omitted.</para>
|
||||
</wadl:doc>
|
||||
@ -221,7 +226,7 @@
|
||||
</resource_type>
|
||||
<resource_type id="NetworkAddressList">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Network Address List">
|
||||
title="Network address list">
|
||||
<para>A list of addresses associated with a
|
||||
network.</para>
|
||||
</wadl:doc>
|
||||
@ -229,29 +234,29 @@
|
||||
</resource_type>
|
||||
<resource_type id="DetailImageList">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Detail Image List">
|
||||
title="Detail image list">
|
||||
<para>A detailed image list.</para>
|
||||
</wadl:doc>
|
||||
<method href="#listDetailImages"/>
|
||||
</resource_type>
|
||||
<resource_type id="ImageList">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Image List">
|
||||
title="Image list">
|
||||
<para>A list of images. Each image contains IDs, names,
|
||||
and links -- other attributes are omitted.</para>
|
||||
and links. Other attributes are omitted.</para>
|
||||
</wadl:doc>
|
||||
<method href="#listImages"/>
|
||||
</resource_type>
|
||||
<resource_type id="DetailFlavorList">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Detail Flavor List">
|
||||
title="Detail flavor list">
|
||||
<para>A detailed flavor list.</para>
|
||||
</wadl:doc>
|
||||
<method href="#listDetailFlavors"/>
|
||||
</resource_type>
|
||||
<resource_type id="FlavorList">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Flavor List">
|
||||
title="Flavor list">
|
||||
<para>A list of flavors. Each flavor contains IDs, names,
|
||||
and links -- other attributes are omitted.</para>
|
||||
</wadl:doc>
|
||||
@ -268,7 +273,7 @@
|
||||
</resource_type>
|
||||
<resource_type id="MetadataList">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Metadata List">
|
||||
title="Metadata list">
|
||||
<para>A list of metadata.</para>
|
||||
</wadl:doc>
|
||||
<method href="#listMetadata"/>
|
||||
@ -281,7 +286,7 @@
|
||||
<!-- Version -->
|
||||
<method name="GET" id="versionDetails">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Version Details">
|
||||
title="Get version details">
|
||||
<para role="shortdesc">Gets details about this specific
|
||||
version of the API.</para>
|
||||
</wadl:doc>
|
||||
@ -314,7 +319,7 @@
|
||||
<!-- Limits -->
|
||||
<method name="GET" id="listLimits">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Limits">
|
||||
title="List limits">
|
||||
<para role="shortdesc">Lists the current limits for the
|
||||
account.</para>
|
||||
</wadl:doc>
|
||||
@ -339,7 +344,7 @@
|
||||
<!-- Extensions -->
|
||||
<method name="GET" id="listExtensions">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Extensions">
|
||||
title="List extensions">
|
||||
<para role="shortdesc">Lists available extensions.</para>
|
||||
</wadl:doc>
|
||||
<response status="200 203">
|
||||
@ -377,8 +382,8 @@
|
||||
</response>
|
||||
<!-- Common Faults --> &commonFaults; </method>
|
||||
<method name="GET" id="getExtension">
|
||||
<wadl:doc xml:lang="EN" title="Get Extension"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get extension">
|
||||
<para role="shortdesc">Gets details about the specified
|
||||
extension.</para><para>Extensions introduce features
|
||||
and vendor-specific functionality to the API without
|
||||
@ -403,7 +408,7 @@
|
||||
<!-- Servers -->
|
||||
<method name="POST" id="createServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create Server">
|
||||
title="Create server">
|
||||
<para role="shortdesc">Creates a server.</para>
|
||||
</wadl:doc>
|
||||
<request> &serverCreateParameters; <representation
|
||||
@ -450,7 +455,7 @@
|
||||
&commonFaults; &getFaults; &postPutFaults; &buildFaults; </method>
|
||||
<method name="GET" id="listServers">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Servers">
|
||||
title="List servers">
|
||||
<para role="shortdesc">Lists IDs, names, and links for all
|
||||
servers.</para>
|
||||
</wadl:doc>
|
||||
@ -497,7 +502,7 @@
|
||||
<!-- Common Faults --> &commonFaults; </method>
|
||||
<method name="GET" id="listDetailServers">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Detail Servers">
|
||||
title="List details for servers">
|
||||
<para role="shortdesc">Lists details for all
|
||||
servers.</para>
|
||||
</wadl:doc>
|
||||
@ -546,7 +551,7 @@
|
||||
<!-- Common Faults --> &commonFaults; </method>
|
||||
<method name="GET" id="getServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get Server Details">
|
||||
title="Get server details">
|
||||
<para role="shortdesc">Gets details for a specified
|
||||
server.</para>
|
||||
</wadl:doc>
|
||||
@ -570,7 +575,7 @@
|
||||
<!-- Common and GET Faults--> &commonFaults; &getFaults; </method>
|
||||
<method name="PUT" id="updateServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Update Server">
|
||||
title="Update server">
|
||||
<para role="shortdesc">Updates the editable attributes of
|
||||
the specified server.</para>
|
||||
</wadl:doc>
|
||||
@ -675,7 +680,7 @@
|
||||
&commonFaults; &getFaults; &postPutFaults; &inProgressFault; </method>
|
||||
<method name="DELETE" id="deleteServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete Server">
|
||||
title="Delete server">
|
||||
<para role="shortdesc">Deletes a specified server.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
@ -685,7 +690,7 @@
|
||||
<!-- Server Actions -->
|
||||
<method name="POST" id="changePassword">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Change Password">
|
||||
title="Change password">
|
||||
<para role="shortdesc">Changes the password for a server.
|
||||
Specify the <code>changePassword</code> action in the
|
||||
request body.</para>
|
||||
@ -714,7 +719,7 @@
|
||||
&getFaults; &postPutFaults; &inProgressFault; </method>
|
||||
<method name="POST" id="rebootServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Reboot Server">
|
||||
title="Reboot server">
|
||||
<para role="shortdesc">Reboots the specified server.
|
||||
Specify the <code>reboot</code> action in the request
|
||||
body.</para>
|
||||
@ -743,7 +748,7 @@
|
||||
&getFaults; &postPutFaults; &rebootFaults; &inProgressFault; </method>
|
||||
<method name="POST" id="rebuildServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Rebuild Server">
|
||||
title="Rebuild server">
|
||||
<para role="shortdesc">Rebuilds the specified server.
|
||||
Specify the <code>rebuild</code> action in the request
|
||||
body.</para>
|
||||
@ -798,7 +803,7 @@
|
||||
&inProgressFault; </method>
|
||||
<method name="POST" id="resizeServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Resize Server">
|
||||
title="Resize server">
|
||||
<para role="shortdesc">Resizes the specified server.
|
||||
Specify the <code>resize</code> action in the request
|
||||
body.</para>
|
||||
@ -828,7 +833,7 @@
|
||||
&inProgressFault; </method>
|
||||
<method name="POST" id="confirmServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Confirm Resized Server">
|
||||
title="Confirm resized server">
|
||||
<para role="shortdesc">Confirms a pending resize action.
|
||||
Specify the <code>confirmResize</code> action in the
|
||||
request body.</para>
|
||||
@ -858,7 +863,7 @@
|
||||
&inProgressFault; </method>
|
||||
<method name="POST" id="revertServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Revert Resized Server">
|
||||
title="Revert resized server">
|
||||
<para role="shortdesc">Cancels and reverts a pending
|
||||
resize action. Specify the <code>revertResize</code>
|
||||
action in the request body.</para>
|
||||
@ -888,7 +893,7 @@
|
||||
&inProgressFault; </method>
|
||||
<method name="POST" id="createImage">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create Image">
|
||||
title="Create image">
|
||||
<para role="shortdesc">Creates a new image. Specify the
|
||||
<code>createImage</code> action in the request
|
||||
body.</para>
|
||||
@ -951,7 +956,7 @@
|
||||
<!-- IPs -->
|
||||
<method name="GET" id="getServerAddresses">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List Addresses">
|
||||
title="List addresses">
|
||||
<para role="shortdesc">Lists networks and addresses for a
|
||||
specified tenant and server.</para>
|
||||
<para>Specify the tenant ID and server ID in the URI.
|
||||
@ -976,7 +981,7 @@
|
||||
&getFaults; &inProgressFault; </method>
|
||||
<method name="GET" id="getNetworkAddresses">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List Addresses by Network">
|
||||
title="List addresses by network">
|
||||
<para role="shortdesc">Lists addresses for a specified
|
||||
tenant, server, and network.</para>
|
||||
<para>Specify the tenant ID, server ID, and network label
|
||||
@ -1002,7 +1007,7 @@
|
||||
<!-- Flavors -->
|
||||
<method name="GET" id="listFlavors">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Flavors">
|
||||
title="List flavors">
|
||||
<para role="shortdesc">Lists IDs, names, and links for
|
||||
available flavors.</para>
|
||||
</wadl:doc>
|
||||
@ -1049,7 +1054,7 @@
|
||||
<!-- Common Faults --> &commonFaults; </method>
|
||||
<method name="GET" id="listDetailFlavors">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Detail Flavors">
|
||||
title="List details for flavors">
|
||||
<para role="shortdesc">Lists all details for available
|
||||
flavors.</para>
|
||||
</wadl:doc>
|
||||
@ -1090,7 +1095,7 @@
|
||||
|
||||
<method name="GET" id="getFlavor">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get Flavor Details">
|
||||
title="Get flavor details">
|
||||
<para role="shortdesc">Gets details for a specified
|
||||
flavor.</para>
|
||||
</wadl:doc>
|
||||
@ -1114,8 +1119,8 @@
|
||||
<!-- Common and GET Faults--> &commonFaults; &getFaults; </method>
|
||||
<!-- Images -->
|
||||
<method name="GET" id="listDetailImages">
|
||||
<wadl:doc xml:lang="EN" title="List Images Details"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List images details">
|
||||
<para role="shortdesc">Lists all details for available
|
||||
images.</para>
|
||||
</wadl:doc>
|
||||
@ -1158,7 +1163,7 @@
|
||||
<!-- Common Faults --> &commonFaults; </method>
|
||||
<method name="GET" id="listImages">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Images">
|
||||
title="List images">
|
||||
<para role="shortdesc">Lists IDs, names, and links for
|
||||
available images.</para>
|
||||
</wadl:doc>
|
||||
@ -1207,7 +1212,7 @@
|
||||
<!-- Common Faults --> &commonFaults; </method>
|
||||
<method name="GET" id="getImage">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get Image Details">
|
||||
title="Get image details">
|
||||
<para role="shortdesc">Gets details for a specified
|
||||
image.</para>
|
||||
</wadl:doc>
|
||||
@ -1231,7 +1236,7 @@
|
||||
<!-- Common and GET Faults--> &commonFaults; &getFaults; </method>
|
||||
<method name="DELETE" id="deleteImage">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete Image">
|
||||
title="Delete image">
|
||||
<para role="shortdesc">Deletes a specified image.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
@ -1239,7 +1244,7 @@
|
||||
<!-- Metadata -->
|
||||
<method name="GET" id="listMetadata">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List Metadata">
|
||||
title="List metadata">
|
||||
<para role="shortdesc">Lists metadata for the specified
|
||||
resource.</para>
|
||||
</wadl:doc>
|
||||
@ -1279,8 +1284,8 @@
|
||||
<!-- Common Faults and GET Faults--> &commonFaults;
|
||||
&getFaults; </method>
|
||||
<method name="POST" id="updateMetadata">
|
||||
<wadl:doc xml:lang="EN" title="Update Metadata Items"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Update metadata items">
|
||||
<para role="shortdesc">Updates metadata items by key for
|
||||
the specified resource.</para>
|
||||
<para>Replaces items that match the specified keys and
|
||||
@ -1345,8 +1350,8 @@
|
||||
<!-- Common, GET, POST/PUT, inProgress Faults-->
|
||||
&commonFaults; &getFaults; &postPutFaults; &inProgressFault; </method>
|
||||
<method name="PUT" id="setMetadata">
|
||||
<wadl:doc xml:lang="EN" title="Create or Replace Metadata"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create or replace metadata">
|
||||
<para role="shortdesc">Sets metadata for the specified
|
||||
resource.</para>
|
||||
<para>Replaces items that match the specified keys and
|
||||
@ -1410,8 +1415,8 @@
|
||||
<!-- Common, GET, POST/PUT, inProgress Faults-->
|
||||
&commonFaults; &getFaults; &postPutFaults; &inProgressFault; </method>
|
||||
<method name="GET" id="getMetadataItem">
|
||||
<wadl:doc xml:lang="EN" title="Get Metadata Item"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get metadata item">
|
||||
<para role="shortdesc">Gets a metadata item by key for the
|
||||
specified resource.</para>
|
||||
</wadl:doc>
|
||||
@ -1437,8 +1442,8 @@
|
||||
<!-- Common Faults and GET Faults--> &commonFaults;
|
||||
&getFaults; </method>
|
||||
<method name="PUT" id="setMetadataItem">
|
||||
<wadl:doc xml:lang="EN" title="Create or Update Metadata Item"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create or update metadata item">
|
||||
<para role="shortdesc">Sets a metadata item by key for the
|
||||
specified resource.</para>
|
||||
<para>An overLimit (<errorcode>413</errorcode>) fault
|
||||
@ -1487,7 +1492,7 @@
|
||||
&commonFaults; &getFaults; &postPutFaults; &inProgressFault; </method>
|
||||
<method name="DELETE" id="deleteMetadataItem">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete Metadata Item">
|
||||
title="Delete metadata item">
|
||||
<para role="shortdesc">Deletes a metadata item by key for
|
||||
the specified resource.</para>
|
||||
</wadl:doc>
|
||||
|
||||
@ -30,7 +30,7 @@
|
||||
<!--*******************************************************-->
|
||||
|
||||
<!-- We should use SSL in production -->
|
||||
<resources base="http://localhost:35357">
|
||||
<resources base="http://localhost:35357" xml:id="HP-IDM-admin-v2.0">
|
||||
<resource id="version" path="v2.0">
|
||||
<resource id="tokens" path="tokens">
|
||||
<resource id="tokenById" path="{tokenId}">
|
||||
|
||||
@ -15,17 +15,13 @@
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:identity="http://docs.openstack.org/identity/api/v2.0"
|
||||
xmlns:HP-IDM="http://docs.openstack.org/identity/api/ext/HP-IDM/v1.0"
|
||||
xmlns:capi="http://docs.openstack.org/common/api/v1.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:csapi="http://docs.openstack.org/identity/api/v2.0"
|
||||
>
|
||||
|
||||
>
|
||||
<grammars>
|
||||
<!--<include href="../xsd/api.xsd"/>-->
|
||||
|
||||
<include href="../xsd/api-common.xsd"/>
|
||||
<include href="../xsd/OS-KSADM.xsd"/>
|
||||
</grammars>
|
||||
<!--*******************************************************-->
|
||||
@ -33,18 +29,18 @@
|
||||
<!--*******************************************************-->
|
||||
|
||||
<!-- We should use SSL in production -->
|
||||
<resources base="http://localhost:35357">
|
||||
<resource id="version" path="v2.0">
|
||||
<resources base="http://localhost:35357" xml:id="OS-KSADM-admin-v2.0">
|
||||
<resource id="version-v2.0" path="v2.0">
|
||||
<param name="X-Auth-Token" style="header"
|
||||
type="xsd:string" required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>A valid authentication token
|
||||
for an administrative user.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="users" path="users">
|
||||
<resource id="users-v2.0" path="users">
|
||||
<method href="#listUsers"/>
|
||||
<method href="#addUser"/>
|
||||
<resource id="userById" path="{userId}">
|
||||
<resource id="userById-v2.0" path="{userId}">
|
||||
<param name="userId" style="template"
|
||||
required="true" type="xsd:string">
|
||||
<wadl:doc
|
||||
@ -55,7 +51,7 @@
|
||||
</param>
|
||||
<method href="#updateUser"/>
|
||||
<method href="#deleteUser"/>
|
||||
<resource id="userRoles" path="roles">
|
||||
<resource id="userRoles-v2.0" path="roles">
|
||||
<param name="serviceId" style="query"
|
||||
required="false" type="xsd:string">
|
||||
<wadl:doc
|
||||
@ -79,9 +75,9 @@
|
||||
size.</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#listUserRoles"/>
|
||||
<resource id="user-roles-OS-KSADM"
|
||||
<resource id="user-roles-OS-KSADM-v2.0"
|
||||
path="OS-KSADM">
|
||||
<resource id="userRoleById"
|
||||
<resource id="userRoleById-v2.0"
|
||||
path="{roleId}">
|
||||
<param name="roleId" style="template"
|
||||
type="xsd:int">
|
||||
@ -96,15 +92,15 @@
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
<resource id="user-OS-KSADM" path="OS-KSADM">
|
||||
<resource id="enabled" path="enabled">
|
||||
<resource id="user-OS-KSADM-v2.0" path="OS-KSADM">
|
||||
<resource id="enabled-v2.0" path="enabled">
|
||||
<method href="#setUserEnabled"/>
|
||||
</resource>
|
||||
<resource id="userCredentials"
|
||||
<resource id="userCredentials-v2.0"
|
||||
path="credentials">
|
||||
<method href="#addUserCredential"/>
|
||||
<method href="#listCredentials"/>
|
||||
<resource id="userCredentialsByType"
|
||||
<method href="#addUserCredential-KSADM"/>
|
||||
<method href="#listCredentials-KSADM"/>
|
||||
<resource id="credential-type-v2.0"
|
||||
path="{credential-type}">
|
||||
<param name="credentialType"
|
||||
style="template"
|
||||
@ -123,9 +119,9 @@
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
<resource id="tenants" path="tenants">
|
||||
<resource id="tenants-v2.0" path="tenants">
|
||||
<method href="#addTenant"/>
|
||||
<resource id="tenantById" path="{tenantId}">
|
||||
<resource id="tenantById-v2.0" path="{tenantId}">
|
||||
<param name="tenantId" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc
|
||||
@ -135,7 +131,7 @@
|
||||
</param>
|
||||
<method href="#updateTenant"/>
|
||||
<method href="#deleteTenant"/>
|
||||
<resource id="usersForTenant" path="users">
|
||||
<resource id="usersForTenant-v2.0" path="users">
|
||||
<param name="marker" style="query"
|
||||
required="false" type="xsd:string">
|
||||
<wadl:doc
|
||||
@ -152,7 +148,7 @@
|
||||
</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#listUsersForTenant"/>
|
||||
<resource id="userForTenant" path="{userId}">
|
||||
<resource id="userForTenant-v2.0" path="{userId}">
|
||||
<param name="userId" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc
|
||||
@ -160,13 +156,13 @@
|
||||
xml:lang="EN"><para>The user
|
||||
ID.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="userRolesForTenant"
|
||||
<resource id="userRolesForTenant-v2.0"
|
||||
path="roles">
|
||||
<resource
|
||||
id="tenant-user-role-OS-KSADM"
|
||||
id="tenant-user-role-OS-KSADM-v2.0"
|
||||
path="OS-KSADM">
|
||||
<resource
|
||||
id="userSpecificRoleForTenant"
|
||||
id="userSpecificRoleForTenant-v2.0"
|
||||
path="{roleId}">
|
||||
<param name="roleId"
|
||||
style="template" type="xsd:string">
|
||||
@ -187,8 +183,8 @@
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
<resource id="role-service-OS-KSADM" path="OS-KSADM">
|
||||
<resource id="roles" path="roles">
|
||||
<resource id="role-service-OS-KSADM-v2.0" path="OS-KSADM">
|
||||
<resource id="roles-v2.0" path="roles">
|
||||
<param name="name" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc
|
||||
@ -197,7 +193,7 @@
|
||||
name.</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#getRoleByName"/>
|
||||
<resource id="roles_list">
|
||||
<resource id="roles_list-v2.0">
|
||||
<param name="serviceId" style="plain"
|
||||
required="false" type="xsd:string">
|
||||
<wadl:doc
|
||||
@ -208,7 +204,7 @@
|
||||
<method href="#listRoles"/>
|
||||
</resource>
|
||||
<method href="#addRole"/>
|
||||
<resource id="roleId" path="{roleId}">
|
||||
<resource id="roleId-v2.0" path="{roleId}">
|
||||
<param name="roleId" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc
|
||||
@ -220,7 +216,7 @@
|
||||
<method href="#deleteRole"/>
|
||||
</resource>
|
||||
</resource>
|
||||
<resource id="services" path="services">
|
||||
<resource id="services-v2.0" path="services">
|
||||
<param name="marker" style="query"
|
||||
required="false" type="xsd:string">
|
||||
<wadl:doc
|
||||
@ -239,7 +235,7 @@
|
||||
<method href="#listServices"/>
|
||||
<method href="#addService"/>
|
||||
|
||||
<resource id="serviceName">
|
||||
<resource id="serviceName-v2.0">
|
||||
<param name="name" style="query"
|
||||
type="xsd:string" required="true">
|
||||
<wadl:doc
|
||||
@ -250,7 +246,7 @@
|
||||
|
||||
<method href="#getServiceByName"/>
|
||||
</resource>
|
||||
<resource id="serviceId" path="{serviceId}">
|
||||
<resource id="serviceId-v2.0" path="{serviceId}">
|
||||
<param name="serviceId" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc
|
||||
@ -608,7 +604,7 @@
|
||||
</wadl:doc>
|
||||
<response status="204"/> &commonFaults; &getFaults; </method>
|
||||
<!-- User Credentials -->
|
||||
<method name="POST" id="addUserCredential">
|
||||
<method name="POST" id="addUserCredential-KSADM">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Add User Credentials">
|
||||
<para role="shortdesc">Adds a credential to a user.</para>
|
||||
@ -651,7 +647,7 @@
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response> &commonFaults; &postPutFaults; &getFaults; </method>
|
||||
<method name="GET" id="listCredentials">
|
||||
<method name="GET" id="listCredentials-KSADM">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List Credentials">
|
||||
<para role="shortdesc">Lists credentials.</para>
|
||||
|
||||
@ -14,17 +14,12 @@
|
||||
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:identity="http://docs.openstack.org/identity/api/v2.0"
|
||||
xmlns:OS-KSCATALOG="http://docs.openstack.org/identity/api/ext/OS-KSCATALOG/v1.0"
|
||||
xmlns:HP-IDM="http://docs.openstack.org/identity/api/ext/HP-IDM/v1.0"
|
||||
xmlns:capi="http://docs.openstack.org/common/api/v1.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xsi:schemaLocation="http://docs.openstack.org/identity/api/v2.0 ../xsd/api.xsd
|
||||
http://docs.openstack.org/common/api/v1.0 ../xsd/api-common.xsd
|
||||
http://wadl.dev.java.net/2009/02 http://www.w3.org/Submission/wadl/wadl.xsd
|
||||
http://docs.openstack.org/identity/api/ext/OS-KSCATALOG/v1.0 ../xsd/OS-KSCATALOG.xsd
|
||||
">
|
||||
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<grammars>
|
||||
<include href="../xsd/api.xsd"/>
|
||||
<include href="../xsd/api-common.xsd"/>
|
||||
@ -35,7 +30,7 @@
|
||||
<!--*******************************************************-->
|
||||
|
||||
<!-- We should use SSL in production -->
|
||||
<resources base="http://localhost:35357">
|
||||
<resources base="http://localhost:35357" xml:id="OS-KSCATALOG-admin-v2.0">
|
||||
<resource id="version" path="v2.0">
|
||||
|
||||
<resource id="tenants" path="tenants">
|
||||
@ -84,7 +79,7 @@
|
||||
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc">Lists endpoint templates.</p>
|
||||
</doc>
|
||||
<response status="200 203">
|
||||
<representation mediaType="application/xml" element="OS-KSCATALOG:endpointTemplates">
|
||||
<representation mediaType="application/xml" element="endpointTemplates">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplates.xml"/>
|
||||
</doc>
|
||||
@ -104,7 +99,7 @@
|
||||
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc">Gets endpoint templates.</p>
|
||||
</doc>
|
||||
<response status="200 203">
|
||||
<representation mediaType="application/xml" element="OS-KSCATALOG:endpointTemplate">
|
||||
<representation mediaType="application/xml" element="endpointTemplate">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplate.xml"/>
|
||||
</doc>
|
||||
@ -124,7 +119,7 @@
|
||||
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc">Adds endpoint template.</p>
|
||||
</doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml" element="OS-KSCATALOG:endpointTemplate">
|
||||
<representation mediaType="application/xml" element="endpointTemplate">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplate.xml"/>
|
||||
</doc>
|
||||
@ -136,7 +131,7 @@
|
||||
</representation>
|
||||
</request>
|
||||
<response status="201">
|
||||
<representation mediaType="application/xml" element="OS-KSCATALOG:endpointTemplate">
|
||||
<representation mediaType="application/xml" element="endpointTemplate">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplate.xml"/>
|
||||
</doc>
|
||||
@ -159,7 +154,7 @@
|
||||
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc">Updates endpoint template.</p>
|
||||
</doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml" element="OS-KSCATALOG:endpointTemplate">
|
||||
<representation mediaType="application/xml" element="endpointTemplate">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplate.xml"/>
|
||||
</doc>
|
||||
@ -171,7 +166,7 @@
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/xml" element="OS-KSCATALOG:endpointTemplate">
|
||||
<representation mediaType="application/xml" element="endpointTemplate">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplate.xml"/>
|
||||
</doc>
|
||||
@ -201,12 +196,12 @@
|
||||
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc">Adds endpoint to a tenant.</p>
|
||||
</doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml" element="OS-KSCATALOG:endpointTemplate">
|
||||
<representation mediaType="application/xml" element="endpointTemplate">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplateWithOnlyId.xml"/>
|
||||
</doc>
|
||||
<param name="endpoint" style="plain" path="/"
|
||||
type="OS-KSCATALOG:EndpointTemplateWithOnlyId"/>
|
||||
type="EndpointTemplateWithOnlyId"/>
|
||||
</representation>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
|
||||
@ -14,18 +14,12 @@
|
||||
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:identity="http://docs.openstack.org/identity/api/v2.0"
|
||||
xmlns:OS-KSEC2="http://docs.openstack.org/identity/api/ext/OS-KSEC2/v1.0"
|
||||
xmlns:HP-IDM="http://docs.openstack.org/identity/api/ext/HP-IDM/v1.0"
|
||||
xmlns:capi="http://docs.openstack.org/common/api/v1.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xsi:schemaLocation="http://docs.openstack.org/identity/api/v2.0 ../xsd/api.xsd
|
||||
http://docs.openstack.org/common/api/v1.0 ../xsd/api-common.xsd
|
||||
http://wadl.dev.java.net/2009/02 http://www.w3.org/Submission/wadl/wadl.xsd
|
||||
http://docs.openstack.org/identity/api/ext/OS-KSEC2/v1.0 ../xsd/OS-KSEC2-credentials.xsd
|
||||
">
|
||||
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<grammars>
|
||||
<include href="../xsd/api.xsd"/>
|
||||
<include href="../xsd/api-common.xsd"/>
|
||||
@ -37,7 +31,7 @@
|
||||
<!--*******************************************************-->
|
||||
|
||||
<!-- We should use SSL in production -->
|
||||
<resources base="http://localhost:35357">
|
||||
<resources base="http://localhost:35357" xml:id="OS-KSEC2-admin-v2.0">
|
||||
<resource id="version" path="v2.0">
|
||||
<param name="X-Auth-Token" style="header"
|
||||
type="xsd:string" required="true">
|
||||
@ -107,7 +101,7 @@
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml"
|
||||
element="OS-KSEC2:ec2Credentials">
|
||||
element="ec2Credentials">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
@ -126,7 +120,7 @@
|
||||
</request>
|
||||
<response status="201">
|
||||
<representation mediaType="application/xml"
|
||||
element="OS-KSEC2:ec2Credentials">
|
||||
element="ec2Credentials">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
@ -200,7 +194,7 @@
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml"
|
||||
element="OS-KSEC2:ec2Credentials">
|
||||
element="ec2Credentials">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
@ -219,7 +213,7 @@
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/xml"
|
||||
element="OS-KSEC2:ec2Credentials">
|
||||
element="ec2Credentials">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
@ -252,7 +246,7 @@
|
||||
</wadl:doc>
|
||||
<response status="200 203">
|
||||
<representation mediaType="application/xml"
|
||||
element="OS-KSEC2:ec2Credentials">
|
||||
element="ec2Credentials">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
|
||||
@ -14,18 +14,12 @@
|
||||
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:identity="http://docs.openstack.org/identity/api/v2.0"
|
||||
xmlns:OS-KSS3="http://docs.openstack.org/identity/api/ext/OS-KSS3/v1.0"
|
||||
xmlns:HP-IDM="http://docs.openstack.org/identity/api/ext/HP-IDM/v1.0"
|
||||
xmlns:capi="http://docs.openstack.org/common/api/v1.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xsi:schemaLocation="http://docs.openstack.org/identity/api/v2.0 ../xsd/api.xsd
|
||||
http://docs.openstack.org/common/api/v1.0 ../xsd/api-common.xsd
|
||||
http://wadl.dev.java.net/2009/02 http://www.w3.org/Submission/wadl/wadl.xsd
|
||||
http://docs.openstack.org/identity/api/ext/OS-KSS3/v1.0 ../xsd/OS-KSS3-credentials.xsd
|
||||
">
|
||||
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<grammars>
|
||||
<include href="../xsd/api.xsd"/>
|
||||
<include href="../xsd/api-common.xsd"/>
|
||||
@ -36,7 +30,7 @@
|
||||
<!--*******************************************************-->
|
||||
|
||||
<!-- We should use SSL in production -->
|
||||
<resources base="http://localhost:35357">
|
||||
<resources base="http://localhost:35357" xml:id="OS-KSS3-admin-v2.0">
|
||||
<resource id="version" path="v2.0">
|
||||
<param name="X-Auth-Token" style="header"
|
||||
type="xsd:string" required="true">
|
||||
@ -73,7 +67,7 @@
|
||||
<method href="#listCredentials"/>
|
||||
<method href="#addUserCredential"/>
|
||||
<resource id="userCredentialsByType"
|
||||
path="OS-KSS3:s3Credentials">
|
||||
path="s3credentials">
|
||||
<method href="#getUserCredential"/>
|
||||
<method href="#updateUserCredential"/>
|
||||
<method href="#deleteUserCredential"/>
|
||||
@ -104,7 +98,7 @@
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml"
|
||||
element="OS-KSS3:s3credentials">
|
||||
element="s3credentials">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
@ -121,7 +115,7 @@
|
||||
</request>
|
||||
<response status="201">
|
||||
<representation mediaType="application/xml"
|
||||
element="OS-KSS3:s3credentials">
|
||||
element="s3credentials">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
@ -197,7 +191,7 @@
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml"
|
||||
element="OS-KSS3:s3credentials">
|
||||
element="s3credentials">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
@ -214,7 +208,7 @@
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/xml"
|
||||
element="OS-KSS3:s3credentials">
|
||||
element="s3credentials">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
@ -247,7 +241,7 @@
|
||||
</wadl:doc>
|
||||
<response status="200 203">
|
||||
<representation mediaType="application/xml"
|
||||
element="OS-KSS3:s3credentials">
|
||||
element="s3credentials">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user