openstack-attic/database-api
Code Issues Proposed changes
Files
61cb84ce9137bde6e85e5437a884bd0ff7556d1f
database-api/apidocs/target/docbkx/cdb-devguide.xml
Nikhil Manchanda e434448adb Gerrit Review for Database Developer Guide 
The Database Developer Guide PDF is located in the repo at:
apidocs/target/docbkx/webhelp/cdb-devguide-reviewer/cdb-devguide-reviewer.pdf

Updated api-doc with Security Groups related API information.

Added Security Groups and Security Group Rules as entities and related API calls to the Reddwarf API Docs.

Change-Id: I4d559b25413a6138cd7d2fb94c028f8cafde100c
2013-05-02 13:24:14 -05:00

7312 lines
341 KiB
XML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<?rax-warinfo cdb-v1.0-cdb-devguide-reviewer?><book xmlns="http://docbook.org/ns/docbook" xmlns:html="http://www.w3.org/1999/xhtml"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:m="http://www.w3.org/1998/Math/MathML"
xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="cdb-devguide"
version="5.0"
xml:base="file:/Users/mike.asthalter/Documents/DBaaS-os-temp/temp-openstack-cdb/apidocs/src/resources/cdb-devguide.xml">
<?rax title.font.size="35px" subtitle.font.size="20px"?>
<title>OpenStack Cloud Databases Developer Guide</title>
<titleabbrev>OpenStack Cloud Databases Developer
Guide</titleabbrev>
<info>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>OpenStack LLC</orgname>
</affiliation>
</author>
<copyright>
<year>2010</year>
<year>2011</year>
<year>2012</year>
<year>2013</year>
<holder>OpenStack LLC</holder>
</copyright>
<releaseinfo>API v1.0</releaseinfo>
<productname>OpenStack Cloud Databases</productname>
<pubdate>2013-05-02</pubdate>
<legalnotice role="apache2">
<annotation>
<remark>Copyright details are filled in by the template.</remark>
</annotation>
</legalnotice>
<abstract>
<para>This document is intended for software developers
interested in developing applications using the
OpenStack Cloud Databases Application Programming
Interface (<abbrev>API</abbrev>). </para>
</abstract>
<revhistory>
<revision>
<date>2013-05-02</date>
<revdescription>
<itemizedlist spacing="compact">
<listitem>
<para>This document is for the initial
OpenStack review.</para>
</listitem>
</itemizedlist>
</revdescription>
</revision>
</revhistory>
<cover>
<para>this is a placeholder for the front cover</para>
</cover>
<cover>
<para>this is a placeholder for the back cover</para>
</cover>
<raxm:metadata xmlns:raxm="http://docs.rackspace.com/api/metadata">
<raxm:displayname>API Developer Guide</raxm:displayname>
<raxm:product version="v1.0">cdb</raxm:product>
<raxm:priority>20</raxm:priority>
</raxm:metadata>
</info>
<chapter xml:id="overview">
<title>Overview</title>
<para>OpenStack Cloud Databases is an OpenStack-based MySQL
relational database service that allows customers to
easily provision database instances of varying virtual
resource sizes without the need to maintain and/or update
MySQL. Interactions with Cloud Databases occur
programmatically via the Cloud Databases API as described
in this developer guide.</para>
<note>
<para>OpenStack recommends that Cloud Databases users back
up their data using <emphasis role="bold">mysqldump</emphasis> until backups are supported
in Cloud Databases.</para>
</note>
<para>The following figure shows an
overview of Cloud Databases Infrastructure: <informalfigure>
<mediaobject>
<imageobject>
<imagedata contentwidth="6in" fileref="figures/1/images/Cloud_DB_Infographic-1.png"/>
</imageobject>
</mediaobject>
</informalfigure>
</para>
<remark security="reviewer">Reviewer: need to edit graphic
above so it says "The Cloud" rather than "The Rackspace
Cloud".</remark>
<?hard-pagebreak?>
<section xml:id="Intended_Audience-d1e122">
<title>Intended Audience</title>
<para> This Guide is intended to assist software
developers who want to develop applications using the
Cloud Databases API. It assumes the reader has a
general understanding of databases and is familiar
with: </para>
<itemizedlist spacing="compact">
<listitem>
<para>ReSTful web services</para>
</listitem>
<listitem>
<para>HTTP/1.1 conventions</para>
</listitem>
<listitem>
<para>JSON and/or XML data serialization
formats</para>
</listitem>
</itemizedlist>
</section>
<?hard-pagebreak?>
<section xml:id="Document_Change_History-d1e166">
<title>Document Change History</title>
<para>This version of the Developer Guide replaces and
obsoletes all previous versions. The most recent
changes are described in the table below:</para>
<informaltable xmlns:xs="http://www.w3.org/2001/XMLSchema" rules="all">
<col width="20%"/>
<col width="80%"/>
<thead>
<tr>
<td align="center">Revision Date</td>
<td align="center">Summary of Changes</td>
</tr>
</thead>
<tbody>
<tr>
<td valign="top">
<para>May 2, 2013</para>
</td>
<td>
<itemizedlist spacing="compact">
<listitem>
<para>This document is for the initial
OpenStack review.</para>
</listitem>
</itemizedlist>
</td>
</tr>
</tbody>
</informaltable>
</section>
<section xml:id="Additional_Resources-d1e532">
<title>Additional Resources</title>
<para>You can download the most current versions of this
and other API-related documents from <link xlink:href="http://docs.openstack.org/">http://docs.openstack.org/</link>. </para>
<para>We welcome feedback, comments, and bug reports at
<link xlink:href="https://bugs.launchpad.net/reddwarf">https://bugs.launchpad.net/reddwarf</link>. </para>
<para>This API uses standard HTTP 1.1 response codes as
documented at: <link xlink:href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html</link>. </para>
</section>
<?hard-pagebreak?>
</chapter>
<chapter xml:id="Concepts-d1e563">
<title>Concepts</title>
<?dbhtml stop-chunking?>
<para> To use the Cloud Databases API effectively, you should
understand several key concepts: </para>
<section xml:id="DatabaseInstance-d1e588">
<title>Database Instance</title>
<para>A database instance is an isolated MySQL instance in
a single tenant environment on a shared physical host
machine.</para>
</section>
<section xml:id="Database">
<title>Database</title>
<para>A MySQL database within a database instance.</para>
</section>
<section xml:id="Flavor">
<title>Flavor</title>
<para>A flavor is an available hardware configuration for
a database instance. Each flavor has a unique
combination of memory capacity and priority for CPU
time.</para>
</section>
<section xml:id="Volume">
<title>Volume</title>
<para>A volume is user-specified storage that contains the
MySQL data directory. Volumes are automatically
provisioned on shared Internet Small Computer System
Interface (iSCSI) storage area networks (SAN) that
provide for increased performance, scalability,
availability and manageability. Applications with high
I/O demands are performance optimized and data is
protected through both local and network RAID-10.
Additionally, network RAID provides synchronous
replication of volumes with automatic failover and
load balancing across available storage
clusters.</para>
</section>
</chapter>
<chapter xml:id="General_API_Information-d1e633">
<title>General API Information</title>
<para> The Cloud Databases API is implemented using a ReSTful
web service interface. Like other cloud products, the
Database Service shares a common token-based
authentication system that allows seamless access between
products and services. </para>
<note>
<para> All requests to authenticate against and operate the service are performed using
SSL over HTTP (HTTPS) on TCP port 443. </para>
</note>
<section xml:id="Authentication-d1e647">
<title>Authentication</title>
<para> Each HTTP request against the Cloud Database
service requires the inclusion of specific
authentication credentials. A single deployment may
support multiple authentication schemes (OAuth, Basic
Auth, Token). The authentication scheme used is
determined by the provider of the Cloud Database
service. Please contact your provider to determine the
best way to authenticate against this API.</para>
<note>
<para>Some authentication schemes may require that the
API operate using SSL over HTTP (HTTPS).</para>
</note>
</section>
<section xml:id="DB_service_versions">
<title>Cloud Databases Service Versions</title>
<para> The Cloud Databases version defines the contract
and build information for the API. </para>
<section xml:id="Contract_Version-d1e825">
<title>Contract Version</title>
<para> The contract version denotes the data model and
behavior that the API supports. The requested
contract version is included in all request URLs.
Different contract versions of the API may be
available at any given time and are not guaranteed
to be compatible with one another.
</para>
<example>
<title>Example Request URL (contract version
in <emphasis role="strong">bold</emphasis>)</title>
<programlisting>https://openstack.example.com/<emphasis role="strong">v1.0</emphasis>/1234</programlisting>
</example>
<note>
<para>This document pertains to contract
version 1.0.</para>
</note>
</section>
<section xml:id="API_Version_Headers-d1e855">
<title>API Version</title>
<para>The API List Versions call is available to show
the current API version as well as information
about all versions of the API. Refer to <xref linkend="API_Versions"/> for details.</para>
</section>
</section>
<?hard-pagebreak?>
<section xml:id="datetimeformat">
<title>Date/Time Format</title>
<para> The Database Service uses an ISO-8601 compliant
date format for the display and consumption of
date/time values. </para>
<para>The system timezone is in UTC. MySQL converts TIMESTAMP values from
the current time zone to UTC for storage, and back
from UTC to the current time zone for retrieval.
This does not occur for other types, such as DATETIME.
</para>
<example>
<title>DB Service Date/Time Format</title>
<programlisting>yyyy-MM-dd'T'HH:mm:ss.SSSZ</programlisting>
<para>See the table below for a description of the date/time format codes.</para>
<para>May 19th, 2011 at 8:07:08 AM, GMT-5 would have the following
format:</para>
<programlisting>2011-05-19T08:07:08-05:00</programlisting>
</example>
<table rules="all">
<caption>Explanation of Date/Time Format Codes</caption>
<thead>
<tr>
<td>Code</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td>yyyy</td>
<td>Four digit year</td>
</tr>
<tr>
<td>MM</td>
<td>Two digit month</td>
</tr>
<tr>
<td>dd</td>
<td>Two digit day of month</td>
</tr>
<tr>
<td>T</td>
<td>Separator for date/time</td>
</tr>
<tr>
<td>HH</td>
<td>Two digit hour of day (00-23)</td>
</tr>
<tr>
<td>mm</td>
<td>Two digit minutes of hour</td>
</tr>
<tr>
<td>ss</td>
<td>Two digit seconds of the minute</td>
</tr>
<tr>
<td>SSS</td>
<td>Three digit milliseconds of the second</td>
</tr>
<tr>
<td>Z</td>
<td>RFC-822 timezone</td>
</tr>
</tbody>
</table>
</section>
<section xml:id="pagination">
<title>Pagination</title>
<para>To reduce load on the service, list operations
return a maximum of 20 items at a time. This is
referred to as <emphasis>pagination</emphasis>. Cloud
Databases has separate paging limits for instances,
databases, and users, which are currently all set to
20. If a request supplies no limit or one that exceeds
the configured default limit, the default is used
instead.</para>
<para> Pagination provides the ability to limit the size
of the returned data as well as retrieve a specified
subset of a large data set. Pagination has two key
concepts: limit and marker. <emphasis>Limit</emphasis>
is the restriction on the maximum number of items for
that type that can be returned.
<emphasis>Marker</emphasis> is the ID of the last
item in the previous list returned. The ID is the UUID
in the case of instances, and the name in the case of
databases and users. For example, a query could
request the next 10 instances after the instance
"1234" as follows:
<code>?limit=10&amp;marker=1234</code>. Items are
displayed sorted by ID. </para>
<para>Pagination applies only to the calls listed in the
following table: </para>
<informaltable rules="all">
<thead>
<tr align="center">
<td colspan="1">Verb</td>
<td colspan="2">URI</td>
<td colspan="3">Description</td>
</tr>
</thead>
<tbody>
<tr>
<td colspan="1">
<command>GET</command>
</td>
<td colspan="2">/instances/</td>
<td colspan="3">Lists the status and
information for all database
instances.</td>
</tr>
<tr>
<td colspan="1">
<command>GET</command>
</td>
<td colspan="2">
/instances/{instanceId}/databases </td>
<td colspan="3">Lists databases for the
specified instance.</td>
</tr>
<tr>
<td colspan="1">
<command>GET</command>
</td>
<td colspan="2"> /instances/{instanceId}/users </td>
<td colspan="3">Lists the users in the
specified database instance.</td>
</tr>
</tbody>
</informaltable>
<para>If the content returned by a call is paginated, the
response includes a structured link much like an
instance item's links, with the basic structure
<code>{"href": "&lt;url&gt;", "rel": "next"}</code>.
Any response that is truncated by pagination will have
a <emphasis>next</emphasis> link, which points to the
next item in the collection. If there are no more
items, no <emphasis>next</emphasis> link is
returned.</para>
<para>See the examples of paged List Instances calls that
follow.</para>
<remark security="reviewer">Reviewer: Need new examples that show OpenStack
host.</remark>
<example>
<title>List Instances Paged Request: XML</title>
<?dbfo keep-together="always"?>
<programlisting language="xml">
GET /v1.0/1234/instances?limit=2 HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
<example>
<title>List Instances Paged Request: JSON</title>
<?dbfo keep-together="always"?>
<programlisting language="json">
GET /v1.0/1234/instances?limit=2 HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
<para>Notice that the paged request examples above set the
limit to 2 (<code>?limit=2</code>), so the responses
that follow each show 2 instances and return a
<emphasis>marker</emphasis> set to the UUID of the
last item in the returned list
(<code>?marker=4137d6a4-03b7-4b66-b0ef-8c7c35c470d3</code>).
Also a link is provided to retrieve the next 2 results
(<code>limit=2</code>) in the link element
identified by the attribute <code>rel="next"</code>
(XML) or <code>"rel":"next"</code> (JSON):</para>
<example>
<title>List Instances Paged Response: XML</title>
<?dbfo keep-together="always"?>
<programlisting language="xml">
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 1538
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
&lt;instances xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;instance id="098653ba-218b-47ce-936a-e0b749101f81" name="xml_rack_instance" status="ACTIVE"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81" rel="self"/&gt;
&lt;link href="https://openstack.example.com/instances/098653ba-218b-47ce-936a-e0b749101f81" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;volume size="2"/&gt;
&lt;flavor id="1"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/flavors/1" rel="self"/&gt;
&lt;link href="https://openstack.example.com/flavors/1" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
&lt;/instance&gt;
&lt;instance id="44b277eb-39be-4921-be31-3d61b43651d7" name="json_rack_instance" status="ACTIVE"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7" rel="self"/&gt;
&lt;link href="https://openstack.example.com/instances/44b277eb-39be-4921-be31-3d61b43651d7" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;volume size="2"/&gt;
&lt;flavor id="1"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/flavors/1" rel="self"/&gt;
&lt;link href="https://openstack.example.com/flavors/1" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
&lt;/instance&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/instances?marker=44b277eb-39be-4921-be31-3d61b43651d7&amp;amp;limit=2" rel="next"/&gt;
&lt;/links&gt;
&lt;/instances&gt;
</programlisting>
</example>
<example>
<title>List Instances Paged Response: JSON</title>
<?dbfo keep-together="always"?>
<programlisting language="json">
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1172
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
{
"instances": [
{
"flavor": {
"id": "1",
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/flavors/1",
"rel": "self"
},
{
"href": "https://openstack.example.com/flavors/1",
"rel": "bookmark"
}
]
},
"id": "098653ba-218b-47ce-936a-e0b749101f81",
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81",
"rel": "self"
},
{
"href": "https://openstack.example.com/instances/098653ba-218b-47ce-936a-e0b749101f81",
"rel": "bookmark"
}
],
"name": "xml_rack_instance",
"status": "ACTIVE",
"volume": {
"size": 2
}
},
{
"flavor": {
"id": "1",
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/flavors/1",
"rel": "self"
},
{
"href": "https://openstack.example.com/flavors/1",
"rel": "bookmark"
}
]
},
"id": "44b277eb-39be-4921-be31-3d61b43651d7",
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7",
"rel": "self"
},
{
"href": "https://openstack.example.com/instances/44b277eb-39be-4921-be31-3d61b43651d7",
"rel": "bookmark"
}
],
"name": "json_rack_instance",
"status": "ACTIVE",
"volume": {
"size": 2
}
}
],
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/instances?marker=44b277eb-39be-4921-be31-3d61b43651d7&amp;limit=2",
"rel": "next"
}
]
}
</programlisting>
</example>
</section>
<section xml:id="DB_faults">
<title>Faults</title>
<para> When an error occurs, the Database Service returns
a fault object containing an HTTP error response code
that denotes the type of error. In the body of the
response, the system will return additional
information about the fault. </para>
<para>The following table lists possible fault types with their associated error codes
and descriptions.</para>
<informaltable rules="all">
<thead>
<tr align="center">
<td colspan="2">Fault Type</td>
<td colspan="1">Associated Error Code</td>
<td colspan="3">Description</td>
</tr>
</thead>
<tbody>
<tr>
<td colspan="2">
<code>badRequest</code>
</td>
<td colspan="1">400</td>
<td colspan="3">There was one or more errors in the user request.</td>
</tr>
<tr>
<td colspan="2">
<code>unauthorized</code>
</td>
<td colspan="1">401</td>
<td colspan="3">The supplied token is not authorized to access the resources, either it's expired or invalid.</td>
</tr>
<tr>
<td colspan="2">
<code>forbidden</code>
</td>
<td colspan="1">403</td>
<td colspan="3">Access to the requested
resource was denied.</td>
</tr>
<tr>
<td colspan="2">
<code>itemNotFound</code>
</td>
<td colspan="1">404</td>
<td colspan="3">The back-end services did not
find anything matching the
Request-URI.</td>
</tr>
<tr>
<td colspan="2">
<code>badMethod</code>
</td>
<td colspan="1">405</td>
<td colspan="3">The request method is not allowed for this resource.</td>
</tr>
<tr>
<td colspan="2">
<code>overLimit</code>
</td>
<td colspan="1">413</td>
<td colspan="3">Either the number of entities in the request is larger than
allowed limits, or the user has exceeded allowable request rate limits.
See the <code>details</code> element for more specifics. Contact support
if you think you need higher request rate limits.</td>
</tr>
<tr>
<td colspan="2">
<code>badMediaType</code>
</td>
<td colspan="1">415</td>
<td colspan="3">The requested content type is not supported by this service.</td>
</tr>
<tr>
<td colspan="2">
<code>unprocessableEntity</code>
</td>
<td colspan="1">422</td>
<td colspan="3">The requested resource could
not be processed on at the moment.</td>
</tr>
<tr>
<td colspan="2">
<code>instanceFault</code>
</td>
<td colspan="1">500</td>
<td colspan="3">This is a generic server error and the message contains the reason for the error. This error could wrap several error messages and is a catch all.</td>
</tr>
<tr>
<td colspan="2">
<code>notImplemented</code>
</td>
<td colspan="1">501</td>
<td colspan="3">The requested method or resource is not implemented.</td>
</tr>
<tr>
<td colspan="2">
<code>serviceUnavailable</code>
</td>
<td colspan="1">503</td>
<td colspan="3">The Database Service is not
available.</td>
</tr>
</tbody>
</informaltable>
<para>The following two <code>instanceFault</code>
examples show errors when the server has erred or
cannot perform the requested operation:</para>
<example>
<title>Example instanceFault Response: XML</title>
<?dbfo keep-together="always"?>
<programlisting language="xml">
HTTP/1.1 500 Internal Server Error
Content-Type: application/xml
Content-Length: 121
Date: Mon, 28 Nov 2011 18:19:37 GMT
&lt;instanceFault code="500" xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;message&gt;
The server has either erred or is incapable of performing the requested operation.
&lt;/message&gt;
&lt;/instanceFault&gt;
</programlisting>
</example>
<example>
<title>Example Fault Response: JSON</title>
<?dbfo keep-together="always"?>
<programlisting language="json">
HTTP/1.1 500 Internal Server Error
Content-Length: 120
Content-Type: application/json; charset=UTF-8
Date: Tue, 29 Nov 2011 00:33:48 GMT
{
"instanceFault": {
"code": 500,
"message": "The server has either erred or is incapable of performing the requested operation."
}
}
</programlisting>
</example>
<para> The error code (<code>code</code>) is returned in the body of the response for
convenience. The <code>message</code> element returns a human-readable message that
is appropriate for display to the end user. The <code>details</code> element is
optional and may contain information that is useful for tracking down an error, such
as a stack trace. The <code>details</code> element may or may not be appropriate for
display to an end user, depending on the role and experience of the end user.</para>
<para>The fault's root element (for example,
<code>instanceFault</code>) may change depending
on the type of error. </para>
<para><?rax-fo keep-with-next?>The following two <code>badRequest</code> examples
show errors when the volume size is invalid:</para>
<example>
<title>Example badRequest Fault on Volume Size Errors:
XML</title>
<?dbfo keep-together="always"?>
<programlisting language="xml">
HTTP/1.1 400 None
Content-Type: application/xml
Content-Length: 121
Date: Mon, 28 Nov 2011 18:19:37 GMT
&lt;badRequest code="400" xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;message&gt;
Volume 'size' needs to be a positive integer value, -1.0 cannot be accepted.
&lt;/message&gt;
&lt;/badRequest&gt;
</programlisting>
</example>
<example>
<title>Example badRequest Fault on Volume Size Errors:
JSON</title>
<?dbfo keep-together="always"?>
<programlisting language="json">
HTTP/1.1 400 None
Content-Length: 120
Content-Type: application/json; charset=UTF-8
Date: Tue, 29 Nov 2011 00:33:48 GMT
{
"badRequest": {
"code": 400,
"message": "Volume 'size' needs to be a positive integer value, -1.0 cannot be accepted."
}
}
</programlisting>
</example>
<para> The next two examples show
<code>itemNotFound</code> errors:</para>
<example>
<title>Example itemNotFound Fault: XML</title>
<?dbfo keep-together="always"?>
<programlisting language="xml">
HTTP/1.1 404 Not Found
Content-Length: 147
Content-Type: application/xml; charset=UTF-8
Date: Mon, 28 Nov 2011 19:50:15 GMT
&lt;itemNotFound code="404" xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;message&gt;
The resource could not be found.
&lt;/message&gt;
&lt;/itemNotFound&gt;
</programlisting>
</example>
<example>
<title>Example itemNotFound Fault: JSON</title>
<?dbfo keep-together="always"?>
<programlisting language="json">
HTTP/1.1 404 Not Found
Content-Length: 78
Content-Type: application/json; charset=UTF-8
Date: Tue, 29 Nov 2011 00:35:24 GMT
{
"itemNotFound": {
"code": 404,
"message": "The resource could not be found."
}
}
</programlisting>
</example>
<section xml:id="synchro_vs_async_faults">
<title>Synchronous Versus Asynchronous
Faults<?sbr?></title>
<para>
<emphasis>Synchronous</emphasis> faults occur at
request time. When a synchronous fault occurs, the
fault contains an HTTP error response code, a
human readable message, and optional details about
the error. The following Database API calls are
synchronous and may produce synchronous faults:<itemizedlist spacing="compact">
<listitem>
<para>List Users</para>
</listitem>
<listitem>
<para>List Instances</para>
</listitem>
<listitem>
<para>List Instance Details by ID</para>
</listitem>
<listitem>
<para>List Databases</para>
</listitem>
<listitem>
<para>Enable Root User</para>
</listitem>
<listitem>
<para>List Root-Enabled Status</para>
</listitem>
<listitem>
<para>List Flavors</para>
</listitem>
<listitem>
<para>List Versions</para>
</listitem>
<listitem>
<para>List Version Details</para>
</listitem>
</itemizedlist>
</para>
<para>
<emphasis>Asynchronous</emphasis> faults occur
in the background while an instance, database, or
user is being built or an instance is executing an
action. When an asynchronous fault occurs, the
system places the instance, database, or user in
an ERROR state and embeds the fault in the
offending instance, database, or user. When an
asynchronous fault occurs, the fault contains an
HTTP error response code, a human readable
message, and optional details about the error. The
following Database API calls are asynchronous and
may produce asynchronous faults:<itemizedlist spacing="compact">
<listitem>
<para>Create Instance</para>
</listitem>
<listitem>
<para>Delete Instance</para>
</listitem>
<listitem>
<para>Create Database</para>
</listitem>
<listitem>
<para>Delete Database</para>
</listitem>
<listitem>
<para>Create User</para>
</listitem>
<listitem>
<para>Delete User</para>
</listitem>
<listitem>
<para>Resize Volume</para>
</listitem>
<listitem>
<para>Resize Instance</para>
</listitem>
<listitem>
<para>Restart Instance</para>
</listitem>
</itemizedlist>
<note>
<para>Note that an asynchronous operation, if
it fails, may not give the user an error,
and the operation can error out without a
failure notification.</para>
</note>
</para>
</section>
</section>
<section xml:id="database_instance_status">
<title>Database Instance Status</title>
<para><?rax-fo keep-with-next?>When making an API call to create, list, or delete
database instance(s), the following database instance
status values are possible:</para>
<itemizedlist spacing="compact">
<listitem>
<para>BUILD – The database instance is being provisioned.</para>
</listitem>
<listitem>
<para>REBOOT – The database instance is
rebooting.</para>
</listitem>
<listitem>
<para>ACTIVE – The database instance is
online and available to take requests.</para>
</listitem>
<listitem>
<para>BLOCKED – The database instance is
unresponsive at the moment.</para>
</listitem>
<listitem>
<para>RESIZE – The database instance is being
resized at the moment.</para>
</listitem>
<listitem>
<para>SHUTDOWN – The database instance is
terminating services. Also, SHUTDOWN is
returned if for any reason the MySQL instance
is shut down but not the actual server. </para>
<para>
<note>
<para>If MySQL has crashed (causing the
SHUTDOWN status), please call support
for assistance.</para>
</note>
</para>
</listitem>
<listitem>
<para>ERROR – The last operation for the
database instance failed due to an
error.</para>
</listitem>
</itemizedlist>
</section>
</chapter>
<chapter xml:id="API_Operations-d1e2264" role="api-reference">
<title>API Operations</title>
<note>
<para>Do not use trailing slashes (/) at the end of calls
to API operations, since this may cause the call to
fail. For example, do not use <command>GET</command> /instances/detail/
(with the trailing slash at the end). Rather, use
<command>GET</command> /instances/detail instead.</para>
</note>
<?hard-pagebreak?><informaltable xmlns:xs="http://www.w3.org/2001/XMLSchema" rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="3" align="center">API Versions</th>
</tr>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/</code>
</td>
<td>
Lists information about all versions of the API.
</td>
</tr>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/{version}</code>
</td>
<td>
Returns detailed information about the specified version of the API.
</td>
</tr>
<tr>
<th colspan="3" align="center">Database Instances</th>
</tr>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances</code>
</td>
<td>Creates a new <glossterm 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">database instance</glossterm>.</td>
</tr>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances</code>
</td>
<td>Lists the status and information for all database instances.</td>
</tr>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances/{instanceId}</code>
</td>
<td>Lists status and details for a specified database instance.</td>
</tr>
<tr>
<td>
<command>DELETE</command>
</td>
<td>
<code>/instances/{instanceId}</code>
</td>
<td>Deletes the specified database instance.</td>
</tr>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances/{instanceId}/root</code>
</td>
<td>Enables the root user for the specified database instance and returns the root password.</td>
</tr>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances/{instanceId}/root</code>
</td>
<td>Returns true if root user is enabled for the specified database instance or false otherwise.</td>
</tr>
<tr>
<th colspan="3" align="center">Database Instance Actions</th>
</tr>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances/{instanceId}/action</code>
</td>
<td>Restart the database service on the instance.</td>
</tr>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances/{instanceId}/action</code>
</td>
<td>Resize the memory of the instance.</td>
</tr>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances/{instanceId}/action</code>
</td>
<td>Resize the <glossterm 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">volume</glossterm> attached to the Instance.</td>
</tr>
<tr>
<th colspan="3" align="center">Databases</th>
</tr>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances/{instanceId}/databases</code>
</td>
<td>Creates a new <glossterm 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">database</glossterm> within the specified instance.</td>
</tr>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances/{instanceId}/databases</code>
</td>
<td>Lists databases for the specified instance.</td>
</tr>
<tr>
<td>
<command>DELETE</command>
</td>
<td>
<code>/instances/{instanceId}/databases/{databaseName}</code>
</td>
<td>Deletes the specified database.</td>
</tr>
<tr>
<th colspan="3" align="center">Users</th>
</tr>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances/{instanceId}/users</code>
</td>
<td>Creates a user for the specified database instance.</td>
</tr>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances/{instanceId}/users</code>
</td>
<td>Lists the users in the specified database instance.</td>
</tr>
<tr>
<td>
<command>PUT</command>
</td>
<td>
<code>/instances/{instanceId}/users</code>
</td>
<td>Changes the MySQL password of one or more users.</td>
</tr>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances/{instanceId}/users/{name}</code>
</td>
<td>Lists the specified user's name and a list of databases that the user can access.</td>
</tr>
<tr>
<td>
<command>DELETE</command>
</td>
<td>
<code>/instances/{instanceId}/users/{name}</code>
</td>
<td>Deletes the user identified by {name} for the specified database instance.</td>
</tr>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances/{instanceId}/users/{name}/databases</code>
</td>
<td>Shows a list of all databases a user has access to.</td>
</tr>
<tr>
<td>
<command>PUT</command>
</td>
<td>
<code>/instances/{instanceId}/users/{name}/databases</code>
</td>
<td>Grant access for the specified user to one or more databases for the specified instance.</td>
</tr>
<tr>
<td>
<command>DELETE</command>
</td>
<td>
<code>/instances/{instanceId}/users/{name}/databases/{databaseName}</code>
</td>
<td>Remove access to the specified database for the specified user.</td>
</tr>
<tr>
<th colspan="3" align="center">Flavors</th>
</tr>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/flavors</code>
</td>
<td>Lists information for all available <glossterm 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
baseform="flavor">flavors</glossterm>.</td>
</tr>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/flavors/{flavorId}</code>
</td>
<td>Lists all flavor information about the specified flavor ID.</td>
</tr>
</tbody>
</informaltable>
<section xml:id="API_Versions">
<title>API Versions</title>
<para>This section describes the versions that are
supported for the Cloud Databases API.</para>
<informaltable xmlns:xs="http://www.w3.org/2001/XMLSchema" rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/</code>
</td>
<td>
Lists information about all versions of the API.
</td>
</tr>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/{version}</code>
</td>
<td>
Returns detailed information about the specified version of the API.
</td>
</tr>
</tbody>
</informaltable>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema" xml:id="GET_getVersions__">
<title>List Versions</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/</code>
</td>
<td>
Lists information about all versions of the API.
</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>200</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation lists information about all versions of the API.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the List Versions requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Versions Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">GET / HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Versions Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">GET / HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
<para>This operation does not require a request body.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the List Versions responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Versions Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 261
Date: Wed, 25 Jan 2012 21:53:04 GMT
&lt;versions xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;version id="v1.0" status="CURRENT" updated="2012-01-01T00:00:00Z"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/" rel="self"/&gt;
&lt;/links&gt;
&lt;/version&gt;
&lt;/versions&gt;</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Versions Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 153
Date: Wed, 25 Jan 2012 21:53:04 GMT
{
"versions": [
{
"id": "v1.0",
"links": [
{
"href": "https://openstack.example.com/v1.0/",
"rel": "self"
}
],
"status": "CURRENT",
"updated": "2012-01-01T00:00:00Z"
}
]
}
</programlisting>
</example>
</section>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="GET_getVersionInfo__version__">
<title>List Version Details</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/{version}</code>
</td>
<td>
Returns detailed information about the specified version of the API.
</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>202</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation returns detailed information about the specified version of the API.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the List Version Details requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Version Details Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">GET /v1.0/ HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Version Details Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">GET /v1.0/ HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
<para>This operation does not require a request body.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the List Version Details responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Version Details Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 218
Date: Wed, 25 Jan 2012 21:53:04 GMT
&lt;version id="v1.0" status="CURRENT" updated="2012-01-01T00:00:00Z" xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/" rel="self"/&gt;
&lt;/links&gt;
&lt;/version&gt;
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Version Details Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 150
Date: Wed, 25 Jan 2012 21:53:04 GMT
{
"version": {
"id": "v1.0",
"links": [
{
"href": "https://openstack.example.com/v1.0/",
"rel": "self"
}
],
"status": "CURRENT",
"updated": "2012-01-01T00:00:00Z"
}
}
</programlisting>
</example>
</section>
</section>
<section xml:id="Database_Instances">
<title>Database Instances</title>
<para>This section describes the operations that are supported for database instances.</para>
<informaltable xmlns:xs="http://www.w3.org/2001/XMLSchema" rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances</code>
</td>
<td>Creates a new <glossterm 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">database instance</glossterm>.</td>
</tr>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances</code>
</td>
<td>Lists the status and information for all database instances.</td>
</tr>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances/{instanceId}</code>
</td>
<td>Lists status and details for a specified database instance.</td>
</tr>
<tr>
<td>
<command>DELETE</command>
</td>
<td>
<code>/instances/{instanceId}</code>
</td>
<td>Deletes the specified database instance.</td>
</tr>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances/{instanceId}/root</code>
</td>
<td>Enables the root user for the specified database instance and returns the root password.</td>
</tr>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances/{instanceId}/root</code>
</td>
<td>Returns true if root user is enabled for the specified database instance or false otherwise.</td>
</tr>
</tbody>
</informaltable>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="POST_createInstance__version___accountId__instances_">
<title>Create Database Instance</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances</code>
</td>
<td>Creates a new <glossterm 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">database instance</glossterm>.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>200</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation asynchronously provisions a new database instance. This call requires the user to specify a <glossterm>flavor</glossterm> and a <glossterm>volume</glossterm> size. The service then provisions the instance with the requested flavor and sets up a volume of the specified size, which is the storage for the database instance.</para>
<note 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">
<title>Notes</title>
<itemizedlist>
<listitem>
<para>You can create only one database instance per <command>POST</command> request.</para>
</listitem>
<listitem>
<para>You can create a database instance with one or more databases, and users associated to those databases.</para>
</listitem>
<listitem>
<para>The default binding for the MySQL instance is port 3306.</para>
</listitem>
</itemizedlist>
</note>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following table lists the required and optional attributes for Create Instance:</para>
<table 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
rules="all">
<caption>Required and Optional Attributes for Create Instance</caption>
<thead>
<tr>
<td colspan="1">Applies To </td>
<td colspan="1">Name </td>
<td colspan="3">Description</td>
<td colspan="1">Required</td>
</tr>
</thead>
<tbody>
<tr>
<td colspan="1" rowspan="3">Instance</td>
<td colspan="1">flavorRef</td>
<td colspan="3">
<para>Reference (href) to a flavor as specified in the response from the List Flavors API call.
This is the actual URI as specified by the href field in the link. Refer to the List Flavors response examples that follow for an example of the flavorRef.</para>
<note>
<para>Rather than the flavor URI, you can also pass the flavor id (integer) as the value for flavorRef.</para>
</note>
<para>Refer to <xref linkend="GET_getFlavors__version___accountId__flavors_"/> for details.</para>
</td>
<td colspan="1">Yes</td>
</tr>
<tr>
<td colspan="1">(volume) size</td>
<td colspan="3">Specifies the volume size in gigabytes (GB). The value specified must be between 1 and 50.</td>
<td colspan="1">Yes</td>
</tr>
<tr>
<td colspan="1">name</td>
<td colspan="3">Name of the instance to create. The length of the name is limited to 255 characters and any characters are permitted.</td>
<td colspan="1">No</td>
</tr>
<tr>
<td colspan="1" rowspan="3">Database</td>
<td colspan="1">name</td>
<td colspan="3">Specifies <glossterm>database</glossterm> names for creating databases on instance creation. Refer to <xref linkend="POST_createDatabase__version___accountId__instances__instanceId__databases_"/> for the required xml/json format.</td>
<td colspan="1">No</td>
</tr>
<tr>
<td colspan="1">character_set</td>
<td colspan="3">Set of symbols and encodings. The default character set is <code>utf8</code>.</td>
<td colspan="1">No</td>
</tr>
<tr>
<td colspan="1">collate</td>
<td colspan="3">Set of rules for comparing characters in a character set. The default value for collate is <code>utf8_general_ci</code>.</td>
<td colspan="1">No</td>
</tr>
<tr>
<td colspan="1" rowspan="3">User</td>
<td colspan="1">name</td>
<td colspan="3">Specifies user name for the database on instance creation. Refer to <xref linkend="POST_createUser__version___accountId__instances__instanceId__users_"/> for the required xml/json format.</td>
<td colspan="1">No</td>
</tr>
<tr>
<td colspan="1">password</td>
<td colspan="3">Specifies password for those users on instance creation. Refer to <xref linkend="POST_createUser__version___accountId__instances__instanceId__users_"/> for the required xml/json format.</td>
<td colspan="1">No</td>
</tr>
<tr>
<td colspan="1">(database) name</td>
<td colspan="3">Specifies names of databases that those users can access on instance creation. Refer to <xref linkend="POST_createUser__version___accountId__instances__instanceId__users_"/> for the required xml/json format.</td>
<td colspan="1">No</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">Refer to <xref linkend="database_instance_status"/> for a list of possible database instance statuses that may be returned.</para>
<table rules="all">
<caption>Create Database Instance Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Create Database Instance requests and responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Create Database Instance Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">POST /v1.0/1234/instances HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
&lt;instance xmlns="http://docs.openstack.org/database/api/v1.0" flavorRef="1" name="xml_rack_instance"&gt;
&lt;volume size="2"/&gt;
&lt;users&gt;
&lt;user password="demopassword" name="demouser"&gt;
&lt;databases&gt;
&lt;database name="sampledb"/&gt;
&lt;/databases&gt;
&lt;/user&gt;
&lt;/users&gt;
&lt;databases&gt;
&lt;database collate="utf8_general_ci" name="sampledb" character_set="utf8"/&gt;
&lt;database name="nextround"/&gt;
&lt;/databases&gt;
&lt;/instance&gt;
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Create Database Instance Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">POST /v1.0/1234/instances HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
{
"instance": {
"databases": [
{
"character_set": "utf8",
"collate": "utf8_general_ci",
"name": "sampledb"
},
{
"name": "nextround"
}
],
"flavorRef": 1,
"name": "json_rack_instance",
"users": [
{
"databases": [
{
"name": "sampledb"
}
],
"name": "demouser",
"password": "demopassword"
}
],
"volume": {
"size": 2
}
}
}
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Create Database Instance Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 724
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
&lt;instance created="2013-03-18 19:09:17.441489" id="098653ba-218b-47ce-936a-e0b749101f81" name="xml_rack_instance" status="BUILD" updated="2013-03-18 19:09:17.441606" xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81" rel="self"/&gt;
&lt;link href="https://openstack.example.com/instances/098653ba-218b-47ce-936a-e0b749101f81" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;volume size="2"/&gt;
&lt;flavor id="1"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/flavors/1" rel="self"/&gt;
&lt;link href="https://openstack.example.com/flavors/1" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
&lt;/instance&gt;
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Create Database Instance Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 591
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
{
"instance": {
"created": "2013-03-18T19:09:17",
"flavor": {
"id": "1",
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/flavors/1",
"rel": "self"
},
{
"href": "https://openstack.example.com/flavors/1",
"rel": "bookmark"
}
]
},
"id": "44b277eb-39be-4921-be31-3d61b43651d7",
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7",
"rel": "self"
},
{
"href": "https://openstack.example.com/instances/44b277eb-39be-4921-be31-3d61b43651d7",
"rel": "bookmark"
}
],
"name": "json_rack_instance",
"status": "BUILD",
"updated": "2013-03-18T19:09:17",
"volume": {
"size": 2
}
}
}
</programlisting>
</example>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">For convenience, notice in the response examples above that resources contain links to themselves. This allows a client to easily obtain
resource URIs rather than to construct them. There are two kinds of link relations
associated with resources. A <code>self</code> link contains a <emphasis>versioned</emphasis> link to the resource. These
links should be used in cases where the link will be followed immediately. A <code>bookmark</code>
link provides a permanent link to a resource that is appropriate for long term storage.</para>
</section>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="GET_getInstance__version___accountId__instances_">
<title>List All Database Instances</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances</code>
</td>
<td>Lists the status and information for all database instances.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>200</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation lists the status and information for all database instances.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">Refer to <xref linkend="database_instance_status"/> for a list of possible database instance statuses that may be returned.</para>
<table rules="all">
<caption>List All Database Instances Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the List All Database Instances Detail requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List All Database Instances Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">GET /v1.0/1234/instances HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List All Database Instances Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">GET /v1.0/1234/instances HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
<para>This operation does not require a request body.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the List All Database Instances responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List All Database Instances Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 1380
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
&lt;instances xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;instance id="098653ba-218b-47ce-936a-e0b749101f81" name="xml_rack_instance" status="ACTIVE"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81" rel="self"/&gt;
&lt;link href="https://openstack.example.com/instances/098653ba-218b-47ce-936a-e0b749101f81" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;volume size="2"/&gt;
&lt;flavor id="1"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/flavors/1" rel="self"/&gt;
&lt;link href="https://openstack.example.com/flavors/1" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
&lt;/instance&gt;
&lt;instance id="44b277eb-39be-4921-be31-3d61b43651d7" name="json_rack_instance" status="ACTIVE"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7" rel="self"/&gt;
&lt;link href="https://openstack.example.com/instances/44b277eb-39be-4921-be31-3d61b43651d7" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;volume size="2"/&gt;
&lt;flavor id="1"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/flavors/1" rel="self"/&gt;
&lt;link href="https://openstack.example.com/flavors/1" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
&lt;/instance&gt;
&lt;/instances&gt;
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List All Database Instances Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1038
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
{
"instances": [
{
"flavor": {
"id": "1",
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/flavors/1",
"rel": "self"
},
{
"href": "https://openstack.example.com/flavors/1",
"rel": "bookmark"
}
]
},
"id": "098653ba-218b-47ce-936a-e0b749101f81",
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81",
"rel": "self"
},
{
"href": "https://openstack.example.com/instances/098653ba-218b-47ce-936a-e0b749101f81",
"rel": "bookmark"
}
],
"name": "xml_rack_instance",
"status": "ACTIVE",
"volume": {
"size": 2
}
},
{
"flavor": {
"id": "1",
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/flavors/1",
"rel": "self"
},
{
"href": "https://openstack.example.com/flavors/1",
"rel": "bookmark"
}
]
},
"id": "44b277eb-39be-4921-be31-3d61b43651d7",
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7",
"rel": "self"
},
{
"href": "https://openstack.example.com/instances/44b277eb-39be-4921-be31-3d61b43651d7",
"rel": "bookmark"
}
],
"name": "json_rack_instance",
"status": "ACTIVE",
"volume": {
"size": 2
}
}
]
}
</programlisting>
</example>
</section>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="GET_getInstanceById__version___accountId__instances__instanceId__">
<title>List Database Instance Status and Details</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances/{instanceId}</code>
</td>
<td>Lists status and details for a specified database instance.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>200</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation lists the status and details of the specified database instance.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation lists the volume size in gigabytes (GB) and the approximate GB used.</para>
<note 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">
<para>After instance creation, the <code>used</code> size of your volume will be
greater than 0. This is expected and due to the automatic creation of
non-empty transaction logs for mysql optimization. The <code>used</code> attribute is <emphasis>not</emphasis> returned
in the response when the status for the instance is BUILD, REBOOT, RESIZE, or ERROR.</para>
</note>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">Refer to <xref linkend="database_instance_status"/> for a list of possible database instance statuses that may be returned.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The list operations return a DNS-resolvable hostname associated with the database instance instead of an IP address. Since the hostname always resolves to the correct IP address of the database instance, this relieves the user from the task of maintaining the mapping. Note that although the IP address may likely change on resizing, migrating, and so forth, the hostname always resolves to the correct database instance.</para>
<table rules="all">
<caption>List Database Instance Status and Details Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">instanceId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The instance ID for the specified database instance.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the List Database Instance Status and Details requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Database Instance Status and Details Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">GET /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81 HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Database Instance Status and Details Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">GET /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81 HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
<para>This operation does not require a request body.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the List Database Instance Status and Details responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Database Instance Status and Details Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 747
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
&lt;instance created="2013-03-18 19:09:17.441489" id="098653ba-218b-47ce-936a-e0b749101f81" name="xml_rack_instance" status="ACTIVE" updated="2013-03-18 19:09:17.513134" xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81" rel="self"/&gt;
&lt;link href="https://openstack.example.com/instances/098653ba-218b-47ce-936a-e0b749101f81" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;volume size="2" used="0.163685983978"/&gt;
&lt;flavor id="1"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/flavors/1" rel="self"/&gt;
&lt;link href="https://openstack.example.com/flavors/1" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
&lt;/instance&gt;
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Database Instance Status and Details Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 621
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
{
"instance": {
"created": "2013-03-18T19:09:17",
"flavor": {
"id": "1",
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/flavors/1",
"rel": "self"
},
{
"href": "https://openstack.example.com/flavors/1",
"rel": "bookmark"
}
]
},
"id": "44b277eb-39be-4921-be31-3d61b43651d7",
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7",
"rel": "self"
},
{
"href": "https://openstack.example.com/instances/44b277eb-39be-4921-be31-3d61b43651d7",
"rel": "bookmark"
}
],
"name": "json_rack_instance",
"status": "ACTIVE",
"updated": "2013-03-18T19:09:17",
"volume": {
"size": 2,
"used": 0.16368598397821188
}
}
}
</programlisting>
</example>
</section>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="DELETE_deleteInstance__version___accountId__instances__instanceId__">
<title>Delete Database Instance</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>DELETE</command>
</td>
<td>
<code>/instances/{instanceId}</code>
</td>
<td>Deletes the specified database instance.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>202</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation deletes the specified database instance, including any associated data.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">Refer to <xref linkend="database_instance_status"/> for a list of possible database instance statuses that may be returned.</para>
<note 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">
<para>This operation is not allowed when the instance status is <code>BUILD</code>.</para>
</note>
<table rules="all">
<caption>Delete Database Instance Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">instanceId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The instance ID for the specified database instance.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Delete Database Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Delete Database Instance Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">DELETE /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81 HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Delete Database Instance Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">DELETE /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7 HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Delete Database Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Delete Database Instance Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: application/xml
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:18 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Delete Database Instance Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:18 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
<para>This operation does not require a request body and does not return a response body.</para>
</section>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="POST_createRoot__version___accountId__instances__instanceId__root_">
<title>Enable Root User</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances/{instanceId}/root</code>
</td>
<td>Enables the root user for the specified database instance and returns the root password.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>200</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation enables login from any host for the root user and provides the user with a generated root password.</para>
<note 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">
<para>Changes you make as a root user may cause detrimental effects to the database instance and unpredictable behavior for API operations.
When you enable the root user, you accept the possibility that we will not be able to support your database instance.
While enabling root does not prevent us from a “best effort” approach to helping you if something goes wrong with your instance,
we cannot ensure that we will be able to assist you if you change core MySQL settings. These changes can be (but are not limited to)
turning off binlogs, removing users that we use to access your instance, and so forth.</para>
</note>
<table rules="all">
<caption>Enable Root User Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">instanceId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The instance ID for the specified database instance.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Enable Root User requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Enable Root User Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">POST /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/root HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Enable Root User Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">POST /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/root HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
<para>This operation does not require a request body.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Enable Root User responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Enable Root User Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 89
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
&lt;user name="root" password="12345" xmlns="http://docs.openstack.org/database/api/v1.0"/&gt;
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Enable Root User Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 47
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
{
"user": {
"name": "root",
"password": "12345"
}
}
</programlisting>
</example>
</section>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="GET_isRootEnabled__version___accountId__instances__instanceId__root_">
<title>List Root-Enabled Status</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances/{instanceId}/root</code>
</td>
<td>Returns true if root user is enabled for the specified database instance or false otherwise.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>200</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation checks an active specified database instance to see if root access is enabled. It returns True if root user is enabled for the specified database instance or False otherwise.</para>
<table rules="all">
<caption>List Root-Enabled Status Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">instanceId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The instance ID for the specified database instance.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Check Root User Access requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Root-Enabled Status Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">GET /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/root HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Root-Enabled Status Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">GET /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/root HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
<para>This operation does not require a request body.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Check Root User Access responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Root-Enabled Status Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 90
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
&lt;rootEnabled xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
True
&lt;/rootEnabled&gt;
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Root-Enabled Status Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 21
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
{
"rootEnabled": true
}
</programlisting>
</example>
</section>
</section>
<section xml:id="Database_Instances_Actions">
<title>Database Instance Actions</title>
<para>This section describes the actions that are supported for database instances.</para>
<informaltable xmlns:xs="http://www.w3.org/2001/XMLSchema" rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances/{instanceId}/action</code>
</td>
<td>Restart the database service on the instance.</td>
</tr>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances/{instanceId}/action</code>
</td>
<td>Resize the memory of the instance.</td>
</tr>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances/{instanceId}/action</code>
</td>
<td>Resize the <glossterm 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">volume</glossterm> attached to the Instance.</td>
</tr>
</tbody>
</informaltable>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="POST_restartInstance__version___accountId__instances__instanceId__action_">
<title>Restart Instance</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances/{instanceId}/action</code>
</td>
<td>Restart the database service on the instance.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>202</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>),
badMediaType (<errorcode>415</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The restart operation will restart only the MySQL Instance. Restarting MySQL will erase any dynamic configuration settings that you have made within MySQL.</para>
<note 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">
<para>The MySQL service will be unavailable until the instance restarts.</para>
</note>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation returns a 202 Accepted response.</para>
<table rules="all">
<caption>Restart Instance Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">instanceId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The instance ID for the specified database instance.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Restart Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Restart Instance Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">POST /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/action HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
&lt;restart xmlns="http://docs.openstack.org/database/api/v1.0"/&gt;
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Restart Instance Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">POST /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/action HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
{
"restart": {}
}
</programlisting>
</example>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Restart Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Restart Instance Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: application/xml
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:18 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Restart Instance Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:18 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</section>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="POST_resizeInstance__version___accountId__instances__instanceId__action_">
<title>Resize the Instance</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances/{instanceId}/action</code>
</td>
<td>Resize the memory of the instance.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>202</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>),
badMediaType (<errorcode>415</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation changes the memory size of the instance, assuming a valid flavorRef is provided. Restarts MySQL in the process.</para>
<table rules="all">
<caption>Resize the Instance Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">instanceId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The instance ID for the specified database instance.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Resize Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Resize the Instance Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">POST /v1.0/1234/instances/5d891bb6-6c61-4b0a-8b85-26f4ee461c9d/action HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 2eeb3252-0164-40f5-8fb7-85df5faa2698
Accept: application/xml
Content-Type: application/xml
&lt;?xml version="1.0" ?&gt;
&lt;resize xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;flavorRef&gt;https://openstack.example.com/v1.0/1234/flavors/2&lt;/flavorRef&gt;
&lt;/resize&gt;
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Resize the Instance Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">POST /v1.0/1234/instances/23a3d4fb-3731-497b-afd4-bf25bde2b5fc/action HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 2eeb3252-0164-40f5-8fb7-85df5faa2698
Accept: application/json
Content-Type: application/json
{
"resize": {
"flavorRef": "https://openstack.example.com/v1.0/1234/flavors/2"
}
}
</programlisting>
</example>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Resize Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Resize the Instance Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: text/plain; charset=UTF-8
Content-Length: 58
Date: Mon, 06 Feb 2012 21:28:11 GMT
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Resize the Instance Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: text/plain; charset=UTF-8
Content-Length: 58
Date: Mon, 06 Feb 2012 21:28:10 GMT
</programlisting>
</example>
</section>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="POST_resizeVolume__version___accountId__instances__instanceId__action_">
<title>Resize the Instance Volume</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances/{instanceId}/action</code>
</td>
<td>Resize the <glossterm 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">volume</glossterm> attached to the Instance.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>202</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>),
badMediaType (<errorcode>415</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation supports resizing the attached volume for an instance. It supports only increasing the volume size and does not support decreasing the size.
The volume size is in gigabytes (GB) and must be an integer.</para>
<note 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">
<para>You cannot increase the volume to a size larger than the API volume size limit specifies.</para>
</note>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation returns a 202 Accepted response.</para>
<table rules="all">
<caption>Resize the Instance Volume Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">instanceId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The instance ID for the specified database instance.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Resize Instance Volume requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Resize the Instance Volume Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">POST /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/action HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
&lt;resize xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;volume size="4"/&gt;
&lt;/resize&gt;
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Resize the Instance Volume Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">POST /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/action HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
{
"resize": {
"volume": {
"size": 4
}
}
}
</programlisting>
</example>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Resize Instance Volume responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Resize the Instance Volume Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: application/xml
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:18 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Resize the Instance Volume Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:18 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</section>
</section>
<section xml:id="databases">
<title>Databases</title>
<para>This section describes the operations that are
supported for databases.</para>
<informaltable xmlns:xs="http://www.w3.org/2001/XMLSchema" rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances/{instanceId}/databases</code>
</td>
<td>Creates a new <glossterm 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">database</glossterm> within the specified instance.</td>
</tr>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances/{instanceId}/databases</code>
</td>
<td>Lists databases for the specified instance.</td>
</tr>
<tr>
<td>
<command>DELETE</command>
</td>
<td>
<code>/instances/{instanceId}/databases/{databaseName}</code>
</td>
<td>Deletes the specified database.</td>
</tr>
</tbody>
</informaltable>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="POST_createDatabase__version___accountId__instances__instanceId__databases_">
<title>Create Database</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances/{instanceId}/databases</code>
</td>
<td>Creates a new <glossterm 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">database</glossterm> within the specified instance.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>202</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation creates a new database within the specified instance.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The <code>name</code> of the database is a required attribute.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following additional attributes can be specified for each database: <code>collate</code> and <code>character_set</code>.</para>
<table 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
rules="all">
<caption>Required and Optional Attributes for Create Database</caption>
<thead>
<tr>
<td colspan="1">Name </td>
<td colspan="3">Description</td>
<td colspan="1">Required</td>
</tr>
</thead>
<tbody>
<tr>
<td colspan="1">name</td>
<td colspan="3">Specifies the database name for creating the database. Refer to the request examples for the required xml/json format.</td>
<td colspan="1">Yes</td>
</tr>
<tr>
<td colspan="1">character_set</td>
<td colspan="3">Set of symbols and encodings. The default character set is <code>utf8</code>.</td>
<td colspan="1">No</td>
</tr>
<tr>
<td colspan="1">collate</td>
<td colspan="3">Set of rules for comparing characters in a character set. The default value for collate is <code>utf8_general_ci</code>.</td>
<td colspan="1">No</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">See the MySQL documentation for information about supported character sets and collations at <link xlink:href="http://dev.mysql.com/doc/refman/5.1/en/charset-mysql.html">http://dev.mysql.com/doc/refman/5.1/en/charset-mysql.html</link>.</para>
<note 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">
<para>The following database names are reserved and cannot be used for creating databases: lost+found, information_schema, and mysql.</para>
</note>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">Refer to the following tables for information about characters that are valid/invalid for creating database names.</para>
<table 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
rules="all"
width="40%">
<caption>Valid Characters That Can Be Used in a Database Name</caption>
<col width="100%"/>
<thead>
<tr>
<td>Character</td>
</tr>
</thead>
<tbody>
<tr>
<td>Letters (upper and lower cases allowed)</td>
</tr>
<tr>
<td>Numbers</td>
</tr>
<tr>
<td>'@', '?', '#', and spaces are allowed, but <emphasis>not</emphasis> at the beginning and end of the database name</td>
</tr>
<tr>
<td>'_' is allowed anywhere in the database name</td>
</tr>
</tbody>
</table>
<table 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
rules="all"
width="40%">
<caption>Characters That <emphasis>Cannot</emphasis> Be Used in a Database Name</caption>
<col width="100%"/>
<thead>
<tr>
<td>Character</td>
</tr>
</thead>
<tbody>
<tr>
<td>Single quotes</td>
</tr>
<tr>
<td>Double quotes</td>
</tr>
<tr>
<td>Back quotes</td>
</tr>
<tr>
<td>Semicolons</td>
</tr>
<tr>
<td>Commas</td>
</tr>
<tr>
<td>Backslashes</td>
</tr>
<tr>
<td>Forwardslashes</td>
</tr>
</tbody>
</table>
<table 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
rules="all">
<caption>Length Restrictions for Database Name</caption>
<thead>
<tr>
<td>Restriction</td>
<td>Value</td>
</tr>
</thead>
<tbody>
<tr>
<td>Database-name maximum length</td>
<td>64</td>
</tr>
</tbody>
</table>
<table rules="all">
<caption>Create Database Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">instanceId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The instance ID for the specified database instance.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Create Database requests:<?rax-fo keep-with-next?></para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Create Database Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">POST /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/databases HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
&lt;databases xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;database collate="utf8_general_ci" name="testingdb" character_set="utf8"/&gt;
&lt;database name="anotherdb"/&gt;
&lt;database name="oneMoreDB"/&gt;
&lt;/databases&gt;
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Create Database Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">POST /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/databases HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
{
"databases": [
{
"character_set": "utf8",
"collate": "utf8_general_ci",
"name": "testingdb"
},
{
"name": "anotherdb"
},
{
"name": "oneMoreDB"
}
]
}
</programlisting>
</example>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Create Database responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Create Database Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: application/xml
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Create Database Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</section>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="GET_getDatabases__version___accountId__instances__instanceId__databases_">
<title>List Databases for Instance</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances/{instanceId}/databases</code>
</td>
<td>Lists databases for the specified instance.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>200</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation lists the databases for the specified instance.</para>
<note 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">
<para>This operation returns only the user-defined databases, not the system databases. The system databases (mysql,
information_schema, lost+found) can only be viewed by a database administrator.</para>
</note>
<table rules="all">
<caption>List Databases for Instance Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">instanceId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The instance ID for the specified database instance.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the List Databases for Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Databases for Instance Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">GET /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/databases HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Databases for Instance Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">GET /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/databases HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the <emphasis>paginated</emphasis> List Databases for Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Databases for Instance Paged Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">GET /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/databases?limit=2 HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Databases for Instance Paged Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">GET /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/databases?limit=1 HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
<para>This operation does not require a request body.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the List Databases for Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Databases for Instance Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 241
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
&lt;databases xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;database name="anotherdb"/&gt;
&lt;database name="nextround"/&gt;
&lt;database name="oneMoreDB"/&gt;
&lt;database name="sampledb"/&gt;
&lt;database name="testingdb"/&gt;
&lt;/databases&gt;
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Databases for Instance Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 129
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
{
"databases": [
{
"name": "anotherdb"
},
{
"name": "nextround"
},
{
"name": "oneMoreDB"
},
{
"name": "sampledb"
},
{
"name": "testingdb"
}
]
}
</programlisting>
</example>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the <emphasis>paginated</emphasis> List Databases for Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Databases for Instance Paged Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 321
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
&lt;databases xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;database name="anotherdb"/&gt;
&lt;database name="nextround"/&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/databases?marker=nextround&amp;amp;limit=2" rel="next"/&gt;
&lt;/links&gt;
&lt;/databases&gt;
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Databases for Instance Paged Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 192
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
{
"databases": [
{
"name": "anotherdb"
}
],
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/databases?marker=anotherdb&amp;limit=1",
"rel": "next"
}
]
}
</programlisting>
</example>
</section>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="DELETE_deleteDatabase__version___accountId__instances__instanceId__databases__databaseName__">
<title>Delete Database</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>DELETE</command>
</td>
<td>
<code>/instances/{instanceId}/databases/{databaseName}</code>
</td>
<td>Deletes the specified database.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>202</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation deletes the requested database within the specified database instance. Note that all data associated with the database is also deleted.</para>
<table rules="all">
<caption>Delete Database Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">instanceId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The instance ID for the specified database instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">databaseName</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The name for the specified database.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Delete Database requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Delete Database Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">DELETE /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/databases/oneMoreDB HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Delete Database Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">DELETE /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/databases/testingdb HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
<para>This operation does not require a request body.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Delete Database responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Delete Database Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: application/xml
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Delete Database Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</section>
</section>
<section xml:id="user_management">
<title>Users</title>
<para>This section describes the operations that are
supported for managing database users.</para>
<para>In this section, "user has access to a database"
means that the user has full create, read, update, and
delete access to the given database. In other words,
on a cloud database instance, a user named USER and a
database named DATABASE exist, and within MySQL, a
GRANT ALL ON DATABASE.* TO USER has been issued on the
instance. </para>
<warning>
<para>There is a bug in a python library that
development is using that may cause incorrect user
deletions to occur if a period (.) is used in the
user name. In this case, the user name is
truncated to remove the portion of the name from
the period to the end, leaving only the portion
from the beginning up to the period. For example,
for a user named "my.userA", the bug would
truncate the user name to "my", and if the user
"my" exists, that user will be incorrectly
deleted. To avoid the problem, do not use periods
in user names.</para>
</warning>
<informaltable xmlns:xs="http://www.w3.org/2001/XMLSchema" rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances/{instanceId}/users</code>
</td>
<td>Creates a user for the specified database instance.</td>
</tr>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances/{instanceId}/users</code>
</td>
<td>Lists the users in the specified database instance.</td>
</tr>
<tr>
<td>
<command>PUT</command>
</td>
<td>
<code>/instances/{instanceId}/users</code>
</td>
<td>Changes the MySQL password of one or more users.</td>
</tr>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances/{instanceId}/users/{name}</code>
</td>
<td>Lists the specified user's name and a list of databases that the user can access.</td>
</tr>
<tr>
<td>
<command>DELETE</command>
</td>
<td>
<code>/instances/{instanceId}/users/{name}</code>
</td>
<td>Deletes the user identified by {name} for the specified database instance.</td>
</tr>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances/{instanceId}/users/{name}/databases</code>
</td>
<td>Shows a list of all databases a user has access to.</td>
</tr>
<tr>
<td>
<command>PUT</command>
</td>
<td>
<code>/instances/{instanceId}/users/{name}/databases</code>
</td>
<td>Grant access for the specified user to one or more databases for the specified instance.</td>
</tr>
<tr>
<td>
<command>DELETE</command>
</td>
<td>
<code>/instances/{instanceId}/users/{name}/databases/{databaseName}</code>
</td>
<td>Remove access to the specified database for the specified user.</td>
</tr>
</tbody>
</informaltable>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="POST_createUser__version___accountId__instances__instanceId__users_">
<title>Create User</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>POST</command>
</td>
<td>
<code>/instances/{instanceId}/users</code>
</td>
<td>Creates a user for the specified database instance.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>202</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation asynchronously provisions a new user for the specified database instance based on the configuration defined in the request object. Once the request is validated and progress has started on the provisioning process, a 202 Accepted response object is returned.</para>
<remark 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">Writer: please add the following note back into the doc once the List User Details call is added back into the API: Using the identifier, the caller can check on the progress of the operation by performing a GET on users/name (for more details on this operation see the "List User Details" section of this document).</remark>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">If the corresponding request cannot be fulfilled due to insufficient or invalid data, an HTTP 400 "Bad Request" error response is returned with information regarding the nature of the failure. Failures in the validation process are non-recoverable and require the caller to correct the cause of the failure and POST the request again.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following table lists the required attributes for Create User. Refer to the request examples for the required xml/json format:</para>
<table 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
rules="all"
width="500">
<caption>Required Attributes for Create User</caption>
<thead>
<tr>
<td colspan="1">Applies To</td>
<td colspan="1">Name </td>
<td colspan="2">Description</td>
<td colspan="1">Required</td>
</tr>
</thead>
<tbody>
<tr>
<td colspan="1" rowspan="3">User</td>
<td colspan="1">name</td>
<td colspan="2">Name of the user for the
database.</td>
<td colspan="1">Yes</td>
</tr>
<tr>
<td colspan="1">password</td>
<td colspan="2">User password for database
access.</td>
<td colspan="1">Yes</td>
</tr>
<tr>
<td colspan="1">(database) name</td>
<td colspan="2">
<para>Name of the database that the user can access. One or more database names must be specified.</para>
</td>
<td colspan="1">No</td>
</tr>
</tbody>
</table>
<note 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">
<title>Notes</title>
<itemizedlist>
<listitem>
<para>A user is granted all privileges on the specified databases.</para>
</listitem>
<listitem>
<para>The following user name is reserved and cannot be used for creating users: root.</para>
</listitem>
</itemizedlist>
</note>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">Refer to the following tables for information about characters that are valid/invalid for creating database names, user names, and passwords.</para>
<table 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
rules="all"
width="40%">
<caption>Valid Characters That Can Be Used in a Database Name, User Name, and Password</caption>
<col width="100%"/>
<thead>
<tr>
<td>Character</td>
</tr>
</thead>
<tbody>
<tr>
<td>Letters (upper and lower cases allowed)</td>
</tr>
<tr>
<td>Numbers</td>
</tr>
<tr>
<td>'@', '?', '#', and spaces are allowed, but <emphasis>not</emphasis> at the beginning and end of the database name, user name, and password</td>
</tr>
<tr>
<td>"_" is allowed anywhere in the database name, user name, and password</td>
</tr>
</tbody>
</table>
<table 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
rules="all"
width="40%">
<caption>Characters That <emphasis>Cannot</emphasis> Be Used in a Database Name, User Name, and Password</caption>
<col width="100%"/>
<thead>
<tr>
<td>Character</td>
</tr>
</thead>
<tbody>
<tr>
<td>Single quotes</td>
</tr>
<tr>
<td>Double quotes</td>
</tr>
<tr>
<td>Back quotes</td>
</tr>
<tr>
<td>Semicolons</td>
</tr>
<tr>
<td>Commas</td>
</tr>
<tr>
<td>Backslashes</td>
</tr>
<tr>
<td>Forwardslashes</td>
</tr>
<tr>
<td>Spaces at the front or end of the user name or password</td>
</tr>
</tbody>
</table>
<table 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
rules="all">
<caption>Length Restrictions for Database Name, User Name, and Password</caption>
<thead>
<tr>
<td>Restriction</td>
<td>Value</td>
</tr>
</thead>
<tbody>
<tr>
<td>Database name maximum length</td>
<td>64</td>
</tr>
<tr>
<td>User name maximum length</td>
<td>16</td>
</tr>
<tr>
<td>Password maximum length</td>
<td>unlimited (no restrictions)</td>
</tr>
</tbody>
</table>
<table rules="all">
<caption>Create User Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">instanceId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The instance ID for the specified database instance.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Create User requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Create User Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">POST /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/users HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
&lt;users xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;user password="password" name="dbuser1" database="databaseA"/&gt;
&lt;user password="password" name="dbuser2"&gt;
&lt;databases&gt;
&lt;database name="databaseB"/&gt;
&lt;database name="databaseC"/&gt;
&lt;/databases&gt;
&lt;/user&gt;
&lt;user password="password" name="dbuser3" database="databaseD"/&gt;
&lt;/users&gt;
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Create User Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">POST /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/users HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
{
"users": [
{
"database": "databaseA",
"name": "dbuser1",
"password": "password"
},
{
"databases": [
{
"name": "databaseB"
},
{
"name": "databaseC"
}
],
"name": "dbuser2",
"password": "password"
},
{
"database": "databaseD",
"name": "dbuser3",
"password": "password"
}
]
}
</programlisting>
</example>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Create User responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Create User Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: application/xml
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Create User Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</section>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="GET_getUsers__version___accountId__instances__instanceId__users_">
<title>List Users in Database Instance</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances/{instanceId}/users</code>
</td>
<td>Lists the users in the specified database instance.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>200</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation lists the users in the specified database instance, along with the associated databases for that user. </para>
<note 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">
<para>This operation does not return the system users (database administrators that administer the health of the database).
Also, this operation returns the "root" user only if "root" user has been enabled.</para>
</note>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following notes apply to MySQL users:</para>
<itemizedlist 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
spacing="compact">
<listitem>
<para>User names can be up to 16 characters long.</para>
</listitem>
<listitem>
<para>When you create accounts with INSERT, you must use FLUSH PRIVILEGES to tell the server to reload the grant tables.</para>
</listitem>
<listitem>
<para>For additional information, refer to: <link xlink:href="http://dev.mysql.com/doc/refman/5.1/en/user-account-management.html">http://dev.mysql.com/doc/refman/5.1/en/user-account-management.html</link>
</para>
</listitem>
</itemizedlist>
<table rules="all">
<caption>List Users in Database Instance Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">instanceId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The instance ID for the specified database instance.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the List Users in Database Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Users in Database Instance Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">GET /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/users HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Users in Database Instance Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">GET /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/users HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the <emphasis>paginated</emphasis> List Users in Database Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Users in Database Instance Paged Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">GET /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/users?limit=2 HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Users in Database Instance Paged Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">GET /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/users?limit=2 HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
<para>This operation does not require a request body.</para>
<?hard-pagebreak?><para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the List Users in Database Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Users in Database Instance Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 468
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
&lt;users xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;user name="dbuser1"&gt;
&lt;databases/&gt;
&lt;/user&gt;
&lt;user name="dbuser2"&gt;
&lt;databases&gt;
&lt;database name="databaseB"/&gt;
&lt;database name="databaseC"/&gt;
&lt;/databases&gt;
&lt;/user&gt;
&lt;user name="dbuser3"&gt;
&lt;databases/&gt;
&lt;/user&gt;
&lt;user name="demouser"&gt;
&lt;databases&gt;
&lt;database name="sampledb"/&gt;
&lt;/databases&gt;
&lt;/user&gt;
&lt;/users&gt;
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Users in Database Instance Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 228
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
{
"users": [
{
"databases": [],
"name": "dbuser1"
},
{
"databases": [
{
"name": "databaseB"
},
{
"name": "databaseC"
}
],
"name": "dbuser2"
},
{
"databases": [],
"name": "dbuser3"
},
{
"databases": [
{
"name": "sampledb"
}
],
"name": "demouser"
}
]
}
</programlisting>
</example>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the <emphasis>paginated</emphasis> List Users in Database Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Users in Database Instance Paged Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 461
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
&lt;users xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;user name="dbuser1"&gt;
&lt;databases/&gt;
&lt;/user&gt;
&lt;user name="dbuser2"&gt;
&lt;databases&gt;
&lt;database name="databaseB"/&gt;
&lt;database name="databaseC"/&gt;
&lt;/databases&gt;
&lt;/user&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/users?marker=dbuser2&amp;amp;limit=2" rel="next"/&gt;
&lt;/links&gt;
&lt;/users&gt;
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Users in Database Instance Paged Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 279
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
{
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/users?marker=dbuser2&amp;limit=2",
"rel": "next"
}
],
"users": [
{
"databases": [],
"name": "dbuser1"
},
{
"databases": [
{
"name": "databaseB"
},
{
"name": "databaseC"
}
],
"name": "dbuser2"
}
]
}
</programlisting>
</example>
</section>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="PUT_changePass__version___accountId__instances__instanceId__users_">
<title>Change User(s) Password</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>PUT</command>
</td>
<td>
<code>/instances/{instanceId}/users</code>
</td>
<td>Changes the MySQL password of one or more users.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>202</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation changes the MySQL password of one or more users. </para>
<note 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">
<para>For information about choosing a valid password, please refer to
<xref linkend="POST_createUser__version___accountId__instances__instanceId__users_"/> for details.</para>
</note>
<table rules="all">
<caption>Change User(s) Password Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">instanceId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The instance ID for the specified database instance.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Change User(s) Password requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Change User(s) Password Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">PUT /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
&lt;users xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;user password="5" name="exampleuser"/&gt;
&lt;/users&gt;
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Change User(s) Password Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">PUT /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
{
"users": [
{
"name": "dbuser1",
"password": "newpassword"
},
{
"name": "dbuser2",
"password": "anotherpassword"
}
]
}
</programlisting>
</example>
<?hard-pagebreak?><para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Change User(s) Password responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Change User(s) Password Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: application/xml
Content-Length: 501
Date: Wed, 27 Jun 2012 21:56:06 GMT
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Change User(s) Password Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 152
Date: Wed, 21 Mar 2012 17:46:46 GMT
</programlisting>
</example>
</section>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="GET_listUser__version___accountId__instances__instanceId__users__name__">
<title>List User</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances/{instanceId}/users/{name}</code>
</td>
<td>Lists the specified user's name and a list of databases that the user can access.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>200</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation lists the specified user's name and a list of databases that the user can access.</para>
<table rules="all">
<caption>List User Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">instanceId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The instance ID for the specified database instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">name</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The name for the specified user.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the List User requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List User Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">GET /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users/testuser HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List User Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">GET /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users/exampleuser HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
<para>This operation does not require a request body.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the List User responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List User Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 0
Date: Wed, 27 Jun 2012 23:11:19 GMT
&lt;user name="testuser" xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;databases&gt;
&lt;database name="exampledb"/&gt;
&lt;/databases&gt;
&lt;/user&gt;</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List User Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 0
Date: Wed, 27 Jun 2012 23:11:19 GMT
{
"user": {
"name": "exampleuser",
"databases": [
{
"name": "databaseA"
},
{
"name": "databaseB"
}
]
}
}</programlisting>
</example>
</section>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="DELETE_deleteUser__version___accountId__instances__instanceId__users__name__">
<title>Delete User</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>DELETE</command>
</td>
<td>
<code>/instances/{instanceId}/users/{name}</code>
</td>
<td>Deletes the user identified by {name} for the specified database instance.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>202</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation deletes the specified user for the specified database instance.</para>
<warning 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">
<para>There is a bug in a python library that development is using that may cause incorrect user deletions to occur
if a period (.) is used in the user name. In this case, the user name is truncated to remove the portion of the
name from the period to the end, leaving only the portion from the beginning up to the period. For example, for a
user named "my.userA", the bug would truncate the user name to "my", and if the user "my" exists, that user will
be incorrectly deleted. To avoid the problem, do not use periods in user names.</para>
</warning>
<table rules="all">
<caption>Delete User Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">instanceId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The instance ID for the specified database instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">name</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The name for the specified user.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Delete User requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Delete User Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">DELETE /v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81/users/testuser HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Delete User Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">DELETE /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/users/testuser HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
<para>This operation does not require a request body.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Delete User responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Delete User Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: application/xml
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Delete User Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</section>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="GET_getUserAccess__version___accountId__instances__instanceId__users__name__databases_">
<title>List User Access</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/instances/{instanceId}/users/{name}/databases</code>
</td>
<td>Shows a list of all databases a user has access to.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>200</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation shows a list of all databases a user has access to.</para>
<table rules="all">
<caption>List User Access Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">instanceId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The instance ID for the specified database instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">name</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The name for the specified user.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the List User Access requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List User Access Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">GET /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users/testuser/databases HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List User Access Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">GET /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users/exampleuser/databases HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
<para>This operation does not require a request body.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the List User Access responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List User Access Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 0
Date: Wed, 27 Jun 2012 23:11:19 GMT
&lt;databases xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;database name="exampledb"/&gt;
&lt;/databases&gt;</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List User Access Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 0
Date: Wed, 27 Jun 2012 23:11:19 GMT
{
"databases": [
{
"name": "databaseA"
},
{
"name": "databaseB"
}
]
}</programlisting>
</example>
</section>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="PUT_grantUserAccess__version___accountId__instances__instanceId__users__name__databases_">
<title>Grant User Access</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>PUT</command>
</td>
<td>
<code>/instances/{instanceId}/users/{name}/databases</code>
</td>
<td>Grant access for the specified user to one or more databases for the specified instance.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>202</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation grants access for the specified user to one or more databases for the specified instance.
The user is granted ALL privileges on the database. Refer to the information at the beginning of <xref linkend="user_management"/>
for more details on access.</para>
<table rules="all">
<caption>Grant User Access Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">instanceId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The instance ID for the specified database instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">name</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The name for the specified user.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Grant User Access requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Grant User Access Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">PUT /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users/testuser/databases HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
&lt;databases xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;database name="extradb"/&gt;
&lt;/databases&gt;
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Grant User Access Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">PUT /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users/exampleuser/databases HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
{
"databases": [
{
"name": "databaseC"
},
{
"name": "databaseD"
}
]
}
</programlisting>
</example>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Grant User Access responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Grant User Access Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: application/xml
Content-Length: 0
Date: Wed, 27 Jun 2012 23:11:19 GMT
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Grant User Access Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 0
Date: Wed, 27 Jun 2012 23:11:19 GMT
</programlisting>
</example>
</section>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="DELETE_revokeUserAccess__version___accountId__instances__instanceId__users__name__databases__databaseName__">
<title>Revoke User Access</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>DELETE</command>
</td>
<td>
<code>/instances/{instanceId}/users/{name}/databases/{databaseName}</code>
</td>
<td>Remove access to the specified database for the specified user.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>202</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation removes access to the specified database for the specified user.</para>
<table rules="all">
<caption>Revoke User Access Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">instanceId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The instance ID for the specified database instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">name</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The name for the specified user.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">databaseName</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The name for the specified database.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Revoke User Access requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Revoke User Access Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">DELETE /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users/testuser/databases/extradb HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Revoke User Access Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">DELETE /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users/exampleuser/databases/databaseC HTTP/1.1
User-Agent: python-example-client
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
<para>This operation does not require a request body.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the Revoke User Access responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Revoke User Access Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: application/xml
Content-Length: 0
Date: Wed, 27 Jun 2012 23:11:19 GMT
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>Revoke User Access Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 0
Date: Wed, 27 Jun 2012 23:11:19 GMT
</programlisting>
</example>
</section>
</section>
<section xml:id="flavors">
<title>Flavors</title>
<para>This section describes the operations that are
supported for flavors.</para>
<informaltable xmlns:xs="http://www.w3.org/2001/XMLSchema" rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/flavors</code>
</td>
<td>Lists information for all available <glossterm 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
baseform="flavor">flavors</glossterm>.</td>
</tr>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/flavors/{flavorId}</code>
</td>
<td>Lists all flavor information about the specified flavor ID.</td>
</tr>
</tbody>
</informaltable>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="GET_getFlavors__version___accountId__flavors_">
<title>List Flavors</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/flavors</code>
</td>
<td>Lists information for all available <glossterm 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
baseform="flavor">flavors</glossterm>.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>200</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation lists information for all available flavors.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This resource is identical to the flavors found in the OpenStack Nova API, but without the disk property.</para>
<table rules="all">
<caption>List Flavors Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the List Flavors requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Flavors Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">GET /v1.0/1234/flavors HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Flavors Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">GET /v1.0/1234/flavors HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
<para>This operation does not require a request body.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the List Flavors responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Flavors Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 1600
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
&lt;flavors xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;flavor id="1" name="512MB Instance" ram="512"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/flavors/1" rel="self"/&gt;
&lt;link href="https://openstack.example.com/flavors/1" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
&lt;flavor id="2" name="1GB Instance" ram="1024"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/flavors/2" rel="self"/&gt;
&lt;link href="https://openstack.example.com/flavors/2" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
&lt;flavor id="3" name="2GB Instance" ram="2048"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/flavors/3" rel="self"/&gt;
&lt;link href="https://openstack.example.com/flavors/3" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
&lt;flavor id="4" name="4GB Instance" ram="4096"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/flavors/4" rel="self"/&gt;
&lt;link href="https://openstack.example.com/flavors/4" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
&lt;flavor id="5" name="8GB Instance" ram="8192"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/flavors/5" rel="self"/&gt;
&lt;link href="https://openstack.example.com/flavors/5" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
&lt;flavor id="6" name="16GB Instance" ram="16384"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/flavors/6" rel="self"/&gt;
&lt;link href="https://openstack.example.com/flavors/6" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
&lt;/flavors&gt;
</programlisting>
</example>
<?hard-pagebreak?><example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Flavors Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1186
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
{
"flavors": [
{
"id": 1,
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/flavors/1",
"rel": "self"
},
{
"href": "https://openstack.example.com/flavors/1",
"rel": "bookmark"
}
],
"name": "512MB Instance",
"ram": 512
},
{
"id": 2,
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/flavors/2",
"rel": "self"
},
{
"href": "https://openstack.example.com/flavors/2",
"rel": "bookmark"
}
],
"name": "1GB Instance",
"ram": 1024
},
{
"id": 3,
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/flavors/3",
"rel": "self"
},
{
"href": "https://openstack.example.com/flavors/3",
"rel": "bookmark"
}
],
"name": "2GB Instance",
"ram": 2048
},
{
"id": 4,
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/flavors/4",
"rel": "self"
},
{
"href": "https://openstack.example.com/flavors/4",
"rel": "bookmark"
}
],
"name": "4GB Instance",
"ram": 4096
},
{
"id": 5,
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/flavors/5",
"rel": "self"
},
{
"href": "https://openstack.example.com/flavors/5",
"rel": "bookmark"
}
],
"name": "8GB Instance",
"ram": 8192
},
{
"id": 6,
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/flavors/6",
"rel": "self"
},
{
"href": "https://openstack.example.com/flavors/6",
"rel": "bookmark"
}
],
"name": "16GB Instance",
"ram": 16384
}
]
}
</programlisting>
</example>
</section>
<?hard-pagebreak?><section xmlns:xs="http://www.w3.org/2001/XMLSchema"
xml:id="GET_getFlavorById__version___accountId__flavors__flavorId__">
<title>List Flavor By ID</title>
<informaltable rules="all">
<col width="10%"/>
<col width="40%"/>
<col width="50%"/>
<thead>
<tr>
<th align="center">Verb</th>
<th align="center">URI</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<command>GET</command>
</td>
<td>
<code>/flavors/{flavorId}</code>
</td>
<td>Lists all flavor information about the specified flavor ID.</td>
</tr>
</tbody>
</informaltable>
<simpara>
Normal Response Code(s):
<returnvalue>200</returnvalue>
</simpara>
<simpara>
Error Response Code(s):
badRequest (<errorcode>400</errorcode>),
unauthorized (<errorcode>401</errorcode>),
forbidden (<errorcode>403</errorcode>),
badMethod (<errorcode>405</errorcode>),
overLimit (<errorcode>413</errorcode>),
unprocessableEntity (<errorcode>422</errorcode>),
instanceFault (<errorcode>500</errorcode>),
notImplemented (<errorcode>501</errorcode>),
serviceUnavailable (<errorcode>503</errorcode>),
itemNotFound (<errorcode>404</errorcode>)
</simpara>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This operation lists all information for the specified flavor ID with details of the RAM.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">This resource is identical to the flavors found in the OpenStack Nova API, but without the disk property.</para>
<note 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">
<para>The flavorId parameter should be an integer. If a floating point value is used for the flavorId parameter,
the decimal portion is truncated and the integer portion is used as the value of the flavorId.</para>
</note>
<remark 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
security="reviewer">Reviewer / Writer: need to confirm that this behavior is not changed in subsequent releases, and if it is prevented, remove the Note above.</remark>
<table rules="all">
<caption>List Flavor By ID Request Parameters</caption>
<col width="30%"/>
<col width="10%"/>
<col width="10%"/>
<col width="40%"/>
<thead>
<tr>
<th align="center">Name</th>
<th align="center">Style</th>
<th align="center">Type</th>
<th align="center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code role="hyphenate-true">tenantId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The tenant ID of the owner of the specified instance.</para>
</td>
</tr>
<tr>
<td align="left">
<code role="hyphenate-true">flavorId</code>
</td>
<td align="left">Template</td>
<td align="left">​String</td>
<td>
<para>The flavor ID for the specified flavor.</para>
</td>
</tr>
</tbody>
</table>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the List Flavor By ID requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Flavor By ID Request: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">GET /v1.0/1234/flavors/1 HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Flavor By ID Request: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">GET /v1.0/1234/flavors/1 HTTP/1.1
User-Agent: python-reddwarfclient
Host: openstack.example.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
<para>This operation does not require a request body.</para>
<para 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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api">The following examples show the List Flavor By ID responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Flavor By ID Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 283
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
&lt;flavor id="1" name="512MB Instance" ram="512" xmlns="http://docs.openstack.org/database/api/v1.0"&gt;
&lt;links&gt;
&lt;link href="https://openstack.example.com/v1.0/1234/flavors/1" rel="self"/&gt;
&lt;link href="https://openstack.example.com/flavors/1" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
</programlisting>
</example>
<example xmlns:db="http://docbook.org/ns/docbook"
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:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:rax="http://docs.rackspace.com/api"
role="wadl">
<title>List Flavor By ID Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 206
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
{
"flavor": {
"id": 1,
"links": [
{
"href": "https://openstack.example.com/v1.0/1234/flavors/1",
"rel": "self"
},
{
"href": "https://openstack.example.com/flavors/1",
"rel": "bookmark"
}
],
"name": "512MB Instance",
"ram": 512
}
}
</programlisting>
</example>
</section>
</section>
</chapter>
<glossary>
<title>Glossary</title>
<glossentry xml:id="Database-d1e017">
<glossterm>database</glossterm>
<glossdef>
<para>A MySQL database within a database instance.</para>
</glossdef>
</glossentry>
<glossentry xml:id="Database-Instance-d1e016">
<glossterm>database instance</glossterm>
<glossdef>
<para>A database instance is an isolated MySQL instance in a single tenant environment on a
shared physical host machine. Also referred to as instance.</para>
</glossdef>
</glossentry>
<glossentry xml:id="Flavor-d1e018">
<glossterm>flavor</glossterm>
<glossdef>
<para>A flavor is an available hardware configuration for a database instance. Each flavor has a unique combination of memory capacity and priority for CPU time.</para>
</glossdef>
</glossentry>
<glossentry xml:id="Volume-d1e019">
<glossterm>volume</glossterm>
<glossdef>
<para>A volume is user-specified storage that contains the MySQL data directory.
Volumes are automatically provisioned on shared Internet Small Computer System Interface (iSCSI)
storage area networks (SAN) that provide for increased performance, scalability, availability
and manageability. Applications with high I/O demands are performance optimized and data is
protected through both local and network RAID-10. Additionally, network RAID provides synchronous
replication of volumes with automatic failover and load balancing across available storage clusters.</para>
</glossdef>
</glossentry>
</glossary>
</book>
View Git Blame Copy Permalink