openstack-attic/database-api
Code Issues Proposed changes
Files
e434448adb7b92701348eeeb5bee6b1abae31923
database-api/apidocs/target/generated-resources/normalized/api/v1.0/cdb.wadl
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

8490 lines
406 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="UTF-8"?>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xlink="http://www.w3.org/1999/xlink"
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:wadl="http://wadl.dev.java.net/2009/02"
xmlns:dbaas="http://docs.openstack.org/database/api/v1.0"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<grammars>
<include href="xsd/cdb.xsd"/>
</grammars>
<resources base="https://ord.databases.api.rackspacecloud.com">
<resource id="versions" path="">
<method xmlns:rax="http://docs.rackspace.com/api" name="GET" rax:id="getVersions">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List Versions">
<para role="shortdesc">
Lists information about all versions of the API.
</para>
<para>This operation lists information about all versions of the API.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Versions requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Versions responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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://ord.databases.api.rackspacecloud.com/v1.0/" rel="self"/&gt;
&lt;/links&gt;
&lt;/version&gt;
&lt;/versions&gt;</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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://ord.databases.api.rackspacecloud.com/v1.0/",
"rel": "self"
}
],
"status": "CURRENT",
"updated": "2012-01-01T00:00:00Z"
}
]
}
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
</resource>
<resource id="version" path="{version}">
<method xmlns:rax="http://docs.rackspace.com/api" name="GET" rax:id="getVersionInfo">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List Version Details">
<para role="shortdesc">
Returns detailed information about the specified version of the API.
</para>
<para>This operation returns detailed information about the specified version of the API.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Version Details requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Version Details responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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://ord.databases.api.rackspacecloud.com/v1.0/" rel="self"/&gt;
&lt;/links&gt;
&lt;/version&gt;
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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://ord.databases.api.rackspacecloud.com/v1.0/",
"rel": "self"
}
],
"status": "CURRENT",
"updated": "2012-01-01T00:00:00Z"
}
}
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<resource id="accountID" path="{accountId}">
<param xmlns:rax="http://docs.rackspace.com/api" name="accountId" style="template"
type="xsd:string"
rax:id="">
<doc>The account ID of the owner of the specified instance.</doc>
</param>
<resource id="instances" path="instances">
<method xmlns:rax="http://docs.rackspace.com/api" name="POST" rax:id="createInstance">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create Database Instance">
<para role="shortdesc">Creates a new <glossterm>database instance</glossterm>.</para>
<para>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>
<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>The following table lists the required and optional attributes for Create Instance:</para>
<table 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>Refer to <xref linkend="database_instance_status"/> for a list of possible database instance statuses that may be returned.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="dbaas:DatabaseInstance">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Create Database Instance requests and responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" element="dbaas:DatabaseInstance">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.com/flavors/1" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
&lt;/instance&gt;
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/1",
"rel": "bookmark"
}
]
},
"id": "44b277eb-39be-4921-be31-3d61b43651d7",
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.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="http://docbook.org/ns/docbook">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>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method xmlns:rax="http://docs.rackspace.com/api" name="GET" rax:id="getInstance">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List All Database Instances">
<para role="shortdesc">Lists the status and information for all database instances.</para>
<para>This operation lists the status and information for all database instances.</para>
<para>Refer to <xref linkend="database_instance_status"/> for a list of possible database instance statuses that may be returned.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List All Database Instances Detail requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List All Database Instances responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.com/flavors/1" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
&lt;/instance&gt;
&lt;/instances&gt;
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/1",
"rel": "bookmark"
}
]
},
"id": "098653ba-218b-47ce-936a-e0b749101f81",
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/instances/098653ba-218b-47ce-936a-e0b749101f81",
"rel": "bookmark"
}
],
"name": "xml_rack_instance",
"status": "ACTIVE",
"volume": {
"size": 2
}
},
{
"flavor": {
"id": "1",
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/1",
"rel": "bookmark"
}
]
},
"id": "44b277eb-39be-4921-be31-3d61b43651d7",
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/instances/44b277eb-39be-4921-be31-3d61b43651d7",
"rel": "bookmark"
}
],
"name": "json_rack_instance",
"status": "ACTIVE",
"volume": {
"size": 2
}
}
]
}
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<resource id="instanceId" path="{instanceId}">
<param xmlns:rax="http://docs.rackspace.com/api" name="instanceId" style="template"
type="xsd:string"
rax:id="">
<doc>The instance ID for the specified database instance.</doc>
</param>
<method xmlns:rax="http://docs.rackspace.com/api" name="GET" rax:id="getInstanceById">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Database Instance Status and Details">
<para role="shortdesc">Lists status and details for a specified database instance.</para>
<para>This operation lists the status and details of the specified database instance.</para>
<para>This operation lists the volume size in gigabytes (GB) and the approximate GB used.</para>
<note>
<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>Refer to <xref linkend="database_instance_status"/> for a list of possible database instance statuses that may be returned.</para>
<para>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>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Database Instance Status and Details requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" element="dbaas:DatabaseInstance">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Database Instance Status and Details responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.com/flavors/1" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
&lt;/instance&gt;
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:DatabaseInstance">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/1",
"rel": "bookmark"
}
]
},
"id": "44b277eb-39be-4921-be31-3d61b43651d7",
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.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>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method xmlns:rax="http://docs.rackspace.com/api" name="DELETE" rax:id="deleteInstance">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete Database Instance">
<para role="shortdesc">Deletes the specified database instance.</para>
<para>This operation deletes the specified database instance, including any associated data.</para>
<para>Refer to <xref linkend="database_instance_status"/> for a list of possible database instance statuses that may be returned.</para>
<note>
<para>This operation is not allowed when the instance status is <code>BUILD</code>.</para>
</note>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Delete Database Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="202"/>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Delete Database Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:18 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:18 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<resource id="instanceAction" path="action">
<method xmlns:rax="http://docs.rackspace.com/api" name="POST" rax:id="resizeInstance">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Resize the Instance">
<para role="shortdesc">Resize the memory of the instance.</para>
<para>This operation changes the memory size of the instance, assuming a valid flavorRef is provided. Restarts MySQL in the process.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="dbaas:Resize">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Resize Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/2&lt;/flavorRef&gt;
&lt;/resize&gt;
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Resize">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 2eeb3252-0164-40f5-8fb7-85df5faa2698
Accept: application/json
Content-Type: application/json
{
"resize": {
"flavorRef": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/2"
}
}
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Resize Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
<response status="415">
<representation mediaType="application/xml" element="dbaas:badMediaType"/>
<representation mediaType="application/json"/>
</response>
</method>
<method xmlns:rax="http://docs.rackspace.com/api" name="POST" rax:id="resizeVolume">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Resize the Instance Volume">
<para role="shortdesc">Resize the <glossterm>volume</glossterm> attached to the Instance.</para>
<para>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>
<para>You cannot increase the volume to a size larger than the API volume size limit specifies.</para>
</note>
<para>This operation returns a 202 Accepted response.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="dbaas:Resize">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Resize Instance Volume requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Resize">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
{
"resize": {
"volume": {
"size": 4
}
}
}
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Resize Instance Volume responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:18 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:18 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
<response status="415">
<representation mediaType="application/xml" element="dbaas:badMediaType"/>
<representation mediaType="application/json"/>
</response>
</method>
<method xmlns:rax="http://docs.rackspace.com/api" name="POST" rax:id="restartInstance">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Restart Instance">
<para role="shortdesc">Restart the database service on the instance.</para>
<para>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>
<para>The MySQL service will be unavailable until the instance restarts.</para>
</note>
<para>This operation returns a 202 Accepted response.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="dbaas:Restart">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Restart Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Restart">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
{
"restart": {}
}
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Restart Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>Restart Instance Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: application/xml
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:18 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>Restart Instance Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: application/json
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:18 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
<response status="415">
<representation mediaType="application/xml" element="dbaas:badMediaType"/>
<representation mediaType="application/json"/>
</response>
</method>
</resource>
<resource id="databases" path="databases">
<method xmlns:rax="http://docs.rackspace.com/api" name="POST" rax:id="createDatabase">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create Database">
<para role="shortdesc">Creates a new <glossterm>database</glossterm> within the specified instance.</para>
<para>This operation creates a new database within the specified instance.</para>
<para>The <code>name</code> of the database is a required attribute.</para>
<para>The following additional attributes can be specified for each database: <code>collate</code> and <code>character_set</code>.</para>
<table 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>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>
<para>The following database names are reserved and cannot be used for creating databases: lost+found, information_schema, and mysql.</para>
</note>
<para>Refer to the following tables for information about characters that are valid/invalid for creating database names.</para>
<table 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 rules="all" width="40%">
<?dbfo keep-together="always"?>
<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 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>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="dbaas:Database">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Create Database requests:<?rax-fo keep-with-next?></para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Database">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Create Database responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>Create Database Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: application/xml
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>Create Database Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: application/json
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method xmlns:rax="http://docs.rackspace.com/api" name="GET" rax:id="getDatabases">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Databases for Instance">
<para role="shortdesc">Lists databases for the specified instance.</para>
<para>This operation lists the databases for the specified instance.</para>
<note>
<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>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Databases for Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/xml">
<doc title="List Databases for Instance Paged Request: XML">
<para xmlns="http://docbook.org/ns/docbook">The following examples show the <emphasis>paginated</emphasis> List Databases for Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc title="List Databases for Instance Paged Request: JSON">
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" element="dbaas:Databases">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Databases for Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Databases">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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>
</doc>
</representation>
<representation mediaType="application/xml" element="dbaas:Databases">
<doc title="List Databases for Instance Paged Response: XML">
<para xmlns="http://docbook.org/ns/docbook">The following examples show the <emphasis>paginated</emphasis> List Databases for Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.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>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Databases">
<doc title="List Databases for Instance Paged Response: JSON">
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/databases?marker=anotherdb&amp;limit=1",
"rel": "next"
}
]
}
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<resource id="databaseName" path="{databaseName}">
<param xmlns:rax="http://docs.rackspace.com/api" name="databaseName" style="template"
type="xsd:string"
rax:id="">
<doc>The name for the specified database.</doc>
</param>
<method xmlns:rax="http://docs.rackspace.com/api" name="DELETE" rax:id="deleteDatabase">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete Database">
<para role="shortdesc">Deletes the specified database.</para>
<para>This operation deletes the requested database within the specified database instance. Note that all data associated with the database is also deleted.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Delete Database requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Delete Database responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>Delete Database Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: application/xml
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>Delete Database Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: application/json
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
</resource>
</resource>
<resource id="users" path="users">
<method xmlns:rax="http://docs.rackspace.com/api" name="POST" rax:id="createUser">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create User">
<para role="shortdesc">Creates a user for the specified database instance.</para>
<para>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>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>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>The following table lists the required attributes for Create User. Refer to the request examples for the required xml/json format:</para>
<table 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>
<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>Refer to the following tables for information about characters that are valid/invalid for creating database names, user names, and passwords.</para>
<table 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 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 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>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="dbaas:Users">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Create User requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Create User responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>Create User Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: application/xml
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>Create User Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: application/json
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method xmlns:rax="http://docs.rackspace.com/api" name="GET" rax:id="getUsers">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Users in Database Instance">
<para role="shortdesc">Lists the users in the specified database instance.</para>
<para>This operation lists the users in the specified database instance, along with the associated databases for that user. </para>
<note>
<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>The following notes apply to MySQL users:</para>
<itemizedlist 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>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Users in Database Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/xml">
<doc title="List Users in Database Instance Paged Request: XML">
<para xmlns="http://docbook.org/ns/docbook">The following examples show the <emphasis>paginated</emphasis> List Users in Database Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc title="List Users in Database Instance Paged Request: JSON">
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" element="dbaas:Users">
<doc title="List Users in Database Instance Response: XML">
<?hard-pagebreak?>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Users in Database Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Users">
<doc title="List Users in Database Instance Response: JSON">
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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>
</doc>
</representation>
<representation mediaType="application/xml" element="dbaas:Users">
<doc title="List Users in Database Instance Paged Response: XML">
<para xmlns="http://docbook.org/ns/docbook">The following examples show the <emphasis>paginated</emphasis> List Users in Database Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.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>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Users">
<doc title="List Users in Database Instance Paged Response: JSON">
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 279
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
{
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.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>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method xmlns:rax="http://docs.rackspace.com/api" name="PUT" rax:id="changePass">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Change User(s) Password">
<para role="shortdesc">Changes the MySQL password of one or more users.</para>
<para>This operation changes the MySQL password of one or more users. </para>
<note>
<para>For information about choosing a valid password, please refer to
<xref linkend="POST_createUser__version___accountId__instances__instanceId__users_"/> for details.</para>
</note>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="dbaas:Users">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Change User(s) Password requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml" element="dbaas:Users">
<doc>
<?hard-pagebreak?>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Change User(s) Password responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Users">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<resource id="userId" path="{name}">
<param xmlns:rax="http://docs.rackspace.com/api" name="name" style="template"
type="xsd:string"
rax:id="">
<doc>The name for the specified user.</doc>
</param>
<method xmlns:rax="http://docs.rackspace.com/api" name="DELETE" rax:id="deleteUser">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete User">
<para role="shortdesc">Deletes the user identified by {name} for the specified database instance.</para>
<para>This operation deletes the specified user for the specified database 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>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Delete User requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Delete User responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>Delete User Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: application/xml
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>Delete User Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: application/json
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method xmlns:rax="http://docs.rackspace.com/api" name="GET" rax:id="listUser">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List User">
<para role="shortdesc">Lists the specified user's name and a list of databases that the user can access.</para>
<para>This operation lists the specified user's name and a list of databases that the user can access.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List User requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List User responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<resource id="database" path="databases">
<method xmlns:rax="http://docs.rackspace.com/api" name="GET" rax:id="getUserAccess">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List User Access">
<para role="shortdesc">Shows a list of all databases a user has access to.</para>
<para>This operation shows a list of all databases a user has access to.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List User Access requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List User Access responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method xmlns:rax="http://docs.rackspace.com/api" name="PUT" rax:id="grantUserAccess">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Grant User Access">
<para role="shortdesc">Grant access for the specified user to one or more databases for the specified instance.</para>
<para>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>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="dbaas:Database">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Grant User Access requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
{
"databases": [
{
"name": "databaseC"
},
{
"name": "databaseD"
}
]
}
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Grant User Access responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<resource id="dbName" path="{databaseName}">
<param xmlns:rax="http://docs.rackspace.com/api" name="databaseName" style="template"
type="xsd:string"
rax:id="">
<doc>The name for the specified database.</doc>
</param>
<method xmlns:rax="http://docs.rackspace.com/api" name="DELETE" rax:id="revokeUserAccess">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Revoke User Access">
<para role="shortdesc">Remove access to the specified database for the specified user.</para>
<para>This operation removes access to the specified database for the specified user.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Revoke User Access requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Revoke User Access responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
</resource>
</resource>
</resource>
</resource>
<resource id="root" path="root">
<method xmlns:rax="http://docs.rackspace.com/api" name="POST" rax:id="createRoot">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Enable Root User">
<para role="shortdesc">Enables the root user for the specified database instance and returns the root password.</para>
<para>This operation enables login from any host for the root user and provides the user with a generated root password.</para>
<note>
<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>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Enable Root User requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" element="dbaas:User">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Enable Root User responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:User">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method xmlns:rax="http://docs.rackspace.com/api" name="GET" rax:id="isRootEnabled">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Root-Enabled Status">
<para role="shortdesc">Returns true if root user is enabled for the specified database instance or false otherwise.</para>
<para>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>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Check Root User Access requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" element="dbaas:RootEnabled">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Check Root User Access responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:RootEnabled">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 21
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
{
"rootEnabled": true
}
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
</resource>
</resource>
</resource>
<resource id="flavors" path="flavors">
<method xmlns:rax="http://docs.rackspace.com/api" name="GET" rax:id="getFlavors">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List Flavors">
<para role="shortdesc">Lists information for all available <glossterm baseform="flavor">flavors</glossterm>.</para>
<para>This operation lists information for all available flavors.</para>
<para>This resource is identical to the flavors found in the OpenStack Nova API, but without the disk property.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Flavors requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" element="dbaas:Flavors">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Flavors responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>List Flavors Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 200 OK
Content-Type: application/xml
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/2" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/3" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/4" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/5" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/6" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.com/flavors/6" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
&lt;/flavors&gt;
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Flavors">
<doc>
<?hard-pagebreak?>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>List Flavors Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 200 OK
Content-Type: application/json
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/1",
"rel": "bookmark"
}
],
"name": "512MB Instance",
"ram": 512
},
{
"id": 2,
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/2",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/2",
"rel": "bookmark"
}
],
"name": "1GB Instance",
"ram": 1024
},
{
"id": 3,
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/3",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/3",
"rel": "bookmark"
}
],
"name": "2GB Instance",
"ram": 2048
},
{
"id": 4,
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/4",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/4",
"rel": "bookmark"
}
],
"name": "4GB Instance",
"ram": 4096
},
{
"id": 5,
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/5",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/5",
"rel": "bookmark"
}
],
"name": "8GB Instance",
"ram": 8192
},
{
"id": 6,
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/6",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/6",
"rel": "bookmark"
}
],
"name": "16GB Instance",
"ram": 16384
}
]
}
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<resource id="flavorId" path="{flavorId}">
<param xmlns:rax="http://docs.rackspace.com/api" name="flavorId" style="template"
type="xsd:string"
rax:id="">
<doc>The flavor ID for the specified flavor.</doc>
</param>
<method xmlns:rax="http://docs.rackspace.com/api" name="GET" rax:id="getFlavorById">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List Flavor By ID">
<para role="shortdesc">Lists all flavor information about the specified flavor ID.</para>
<para>This operation lists all information for the specified flavor ID with details of the RAM.</para>
<para>This resource is identical to the flavors found in the OpenStack Nova API, but without the disk property.</para>
<note>
<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 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>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Flavor By ID requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" element="dbaas:Flavor">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Flavor By ID responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.com/flavors/1" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Flavor">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/1",
"rel": "bookmark"
}
],
"name": "512MB Instance",
"ram": 512
}
}
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
</resource>
</resource>
</resource>
</resource>
</resources>
<!--Token Methods... -->
<!-- Version -->
<method name="GET" id="getVersionInfo">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List Version Details">
<para role="shortdesc">
Returns detailed information about the specified version of the API.
</para>
<para>This operation returns detailed information about the specified version of the API.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Version Details requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Version Details responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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://ord.databases.api.rackspacecloud.com/v1.0/" rel="self"/&gt;
&lt;/links&gt;
&lt;/version&gt;
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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://ord.databases.api.rackspacecloud.com/v1.0/",
"rel": "self"
}
],
"status": "CURRENT",
"updated": "2012-01-01T00:00:00Z"
}
}
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="GET" id="getVersions">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List Versions">
<para role="shortdesc">
Lists information about all versions of the API.
</para>
<para>This operation lists information about all versions of the API.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Versions requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Versions responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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://ord.databases.api.rackspacecloud.com/v1.0/" rel="self"/&gt;
&lt;/links&gt;
&lt;/version&gt;
&lt;/versions&gt;</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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://ord.databases.api.rackspacecloud.com/v1.0/",
"rel": "self"
}
],
"status": "CURRENT",
"updated": "2012-01-01T00:00:00Z"
}
]
}
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<!-- Instance -->
<method name="POST" id="createInstance">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create Database Instance">
<para role="shortdesc">Creates a new <glossterm>database instance</glossterm>.</para>
<para>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>
<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>The following table lists the required and optional attributes for Create Instance:</para>
<table 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>Refer to <xref linkend="database_instance_status"/> for a list of possible database instance statuses that may be returned.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="dbaas:DatabaseInstance">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Create Database Instance requests and responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" element="dbaas:DatabaseInstance">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.com/flavors/1" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
&lt;/instance&gt;
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/1",
"rel": "bookmark"
}
]
},
"id": "44b277eb-39be-4921-be31-3d61b43651d7",
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.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="http://docbook.org/ns/docbook">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>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="DELETE" id="deleteInstance">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete Database Instance">
<para role="shortdesc">Deletes the specified database instance.</para>
<para>This operation deletes the specified database instance, including any associated data.</para>
<para>Refer to <xref linkend="database_instance_status"/> for a list of possible database instance statuses that may be returned.</para>
<note>
<para>This operation is not allowed when the instance status is <code>BUILD</code>.</para>
</note>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Delete Database Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="202"/>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Delete Database Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:18 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:18 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="GET" id="getInstance">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List All Database Instances">
<para role="shortdesc">Lists the status and information for all database instances.</para>
<para>This operation lists the status and information for all database instances.</para>
<para>Refer to <xref linkend="database_instance_status"/> for a list of possible database instance statuses that may be returned.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List All Database Instances Detail requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List All Database Instances responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.com/flavors/1" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
&lt;/instance&gt;
&lt;/instances&gt;
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/1",
"rel": "bookmark"
}
]
},
"id": "098653ba-218b-47ce-936a-e0b749101f81",
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/instances/098653ba-218b-47ce-936a-e0b749101f81",
"rel": "bookmark"
}
],
"name": "xml_rack_instance",
"status": "ACTIVE",
"volume": {
"size": 2
}
},
{
"flavor": {
"id": "1",
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/1",
"rel": "bookmark"
}
]
},
"id": "44b277eb-39be-4921-be31-3d61b43651d7",
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/instances/44b277eb-39be-4921-be31-3d61b43651d7",
"rel": "bookmark"
}
],
"name": "json_rack_instance",
"status": "ACTIVE",
"volume": {
"size": 2
}
}
]
}
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="GET" id="getInstanceById">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Database Instance Status and Details">
<para role="shortdesc">Lists status and details for a specified database instance.</para>
<para>This operation lists the status and details of the specified database instance.</para>
<para>This operation lists the volume size in gigabytes (GB) and the approximate GB used.</para>
<note>
<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>Refer to <xref linkend="database_instance_status"/> for a list of possible database instance statuses that may be returned.</para>
<para>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>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Database Instance Status and Details requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" element="dbaas:DatabaseInstance">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Database Instance Status and Details responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.com/flavors/1" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
&lt;/instance&gt;
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:DatabaseInstance">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/1",
"rel": "bookmark"
}
]
},
"id": "44b277eb-39be-4921-be31-3d61b43651d7",
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.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>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<!-- Instance Actions -->
<method name="POST" id="restartInstance">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Restart Instance">
<para role="shortdesc">Restart the database service on the instance.</para>
<para>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>
<para>The MySQL service will be unavailable until the instance restarts.</para>
</note>
<para>This operation returns a 202 Accepted response.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="dbaas:Restart">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Restart Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Restart">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
{
"restart": {}
}
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Restart Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>Restart Instance Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: application/xml
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:18 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>Restart Instance Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: application/json
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:18 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
<response status="415">
<representation mediaType="application/xml" element="dbaas:badMediaType"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="POST" id="resizeInstance">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Resize the Instance">
<para role="shortdesc">Resize the memory of the instance.</para>
<para>This operation changes the memory size of the instance, assuming a valid flavorRef is provided. Restarts MySQL in the process.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="dbaas:Resize">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Resize Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/2&lt;/flavorRef&gt;
&lt;/resize&gt;
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Resize">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 2eeb3252-0164-40f5-8fb7-85df5faa2698
Accept: application/json
Content-Type: application/json
{
"resize": {
"flavorRef": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/2"
}
}
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Resize Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
<response status="415">
<representation mediaType="application/xml" element="dbaas:badMediaType"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="POST" id="resizeVolume">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Resize the Instance Volume">
<para role="shortdesc">Resize the <glossterm>volume</glossterm> attached to the Instance.</para>
<para>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>
<para>You cannot increase the volume to a size larger than the API volume size limit specifies.</para>
</note>
<para>This operation returns a 202 Accepted response.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="dbaas:Resize">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Resize Instance Volume requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Resize">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
{
"resize": {
"volume": {
"size": 4
}
}
}
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Resize Instance Volume responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:18 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:18 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
<response status="415">
<representation mediaType="application/xml" element="dbaas:badMediaType"/>
<representation mediaType="application/json"/>
</response>
</method>
<!-- Database -->
<method name="POST" id="createDatabase">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create Database">
<para role="shortdesc">Creates a new <glossterm>database</glossterm> within the specified instance.</para>
<para>This operation creates a new database within the specified instance.</para>
<para>The <code>name</code> of the database is a required attribute.</para>
<para>The following additional attributes can be specified for each database: <code>collate</code> and <code>character_set</code>.</para>
<table 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>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>
<para>The following database names are reserved and cannot be used for creating databases: lost+found, information_schema, and mysql.</para>
</note>
<para>Refer to the following tables for information about characters that are valid/invalid for creating database names.</para>
<table 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 rules="all" width="40%">
<?dbfo keep-together="always"?>
<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 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>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="dbaas:Database">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Create Database requests:<?rax-fo keep-with-next?></para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Database">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Create Database responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>Create Database Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: application/xml
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>Create Database Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: application/json
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="GET" id="getDatabases">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Databases for Instance">
<para role="shortdesc">Lists databases for the specified instance.</para>
<para>This operation lists the databases for the specified instance.</para>
<note>
<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>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Databases for Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/xml">
<doc title="List Databases for Instance Paged Request: XML">
<para xmlns="http://docbook.org/ns/docbook">The following examples show the <emphasis>paginated</emphasis> List Databases for Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc title="List Databases for Instance Paged Request: JSON">
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" element="dbaas:Databases">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Databases for Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Databases">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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>
</doc>
</representation>
<representation mediaType="application/xml" element="dbaas:Databases">
<doc title="List Databases for Instance Paged Response: XML">
<para xmlns="http://docbook.org/ns/docbook">The following examples show the <emphasis>paginated</emphasis> List Databases for Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.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>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Databases">
<doc title="List Databases for Instance Paged Response: JSON">
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/databases?marker=anotherdb&amp;limit=1",
"rel": "next"
}
]
}
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="DELETE" id="deleteDatabase">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete Database">
<para role="shortdesc">Deletes the specified database.</para>
<para>This operation deletes the requested database within the specified database instance. Note that all data associated with the database is also deleted.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Delete Database requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Delete Database responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>Delete Database Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: application/xml
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>Delete Database Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: application/json
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<!-- User -->
<method name="POST" id="createUser">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create User">
<para role="shortdesc">Creates a user for the specified database instance.</para>
<para>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>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>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>The following table lists the required attributes for Create User. Refer to the request examples for the required xml/json format:</para>
<table 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>
<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>Refer to the following tables for information about characters that are valid/invalid for creating database names, user names, and passwords.</para>
<table 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 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 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>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="dbaas:Users">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Create User requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Create User responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>Create User Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: application/xml
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>Create User Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: application/json
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="GET" id="getUsers">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Users in Database Instance">
<para role="shortdesc">Lists the users in the specified database instance.</para>
<para>This operation lists the users in the specified database instance, along with the associated databases for that user. </para>
<note>
<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>The following notes apply to MySQL users:</para>
<itemizedlist 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>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Users in Database Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/xml">
<doc title="List Users in Database Instance Paged Request: XML">
<para xmlns="http://docbook.org/ns/docbook">The following examples show the <emphasis>paginated</emphasis> List Users in Database Instance requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc title="List Users in Database Instance Paged Request: JSON">
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" element="dbaas:Users">
<doc title="List Users in Database Instance Response: XML">
<?hard-pagebreak?>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Users in Database Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Users">
<doc title="List Users in Database Instance Response: JSON">
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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>
</doc>
</representation>
<representation mediaType="application/xml" element="dbaas:Users">
<doc title="List Users in Database Instance Paged Response: XML">
<para xmlns="http://docbook.org/ns/docbook">The following examples show the <emphasis>paginated</emphasis> List Users in Database Instance responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.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>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Users">
<doc title="List Users in Database Instance Paged Response: JSON">
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 279
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
{
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.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>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="PUT" id="changePass">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Change User(s) Password">
<para role="shortdesc">Changes the MySQL password of one or more users.</para>
<para>This operation changes the MySQL password of one or more users. </para>
<note>
<para>For information about choosing a valid password, please refer to
<xref linkend="POST_createUser__version___accountId__instances__instanceId__users_"/> for details.</para>
</note>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="dbaas:Users">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Change User(s) Password requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml" element="dbaas:Users">
<doc>
<?hard-pagebreak?>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Change User(s) Password responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Users">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="DELETE" id="deleteUser">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete User">
<para role="shortdesc">Deletes the user identified by {name} for the specified database instance.</para>
<para>This operation deletes the specified user for the specified database 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>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Delete User requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Delete User responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>Delete User Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 202 Accepted
Content-Type: application/xml
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>Delete User Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 202 Accepted
Content-Type: application/json
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 0
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="GET" id="listUser">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List User">
<para role="shortdesc">Lists the specified user's name and a list of databases that the user can access.</para>
<para>This operation lists the specified user's name and a list of databases that the user can access.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List User requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List User responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="GET" id="getUserAccess">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List User Access">
<para role="shortdesc">Shows a list of all databases a user has access to.</para>
<para>This operation shows a list of all databases a user has access to.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List User Access requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List User Access responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="PUT" id="grantUserAccess">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Grant User Access">
<para role="shortdesc">Grant access for the specified user to one or more databases for the specified instance.</para>
<para>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>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="dbaas:Database">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Grant User Access requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.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>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
{
"databases": [
{
"name": "databaseC"
},
{
"name": "databaseD"
}
]
}
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Grant User Access responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="DELETE" id="revokeUserAccess">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Revoke User Access">
<para role="shortdesc">Remove access to the specified database for the specified user.</para>
<para>This operation removes access to the specified database for the specified user.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Revoke User Access requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Revoke User Access responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<!-- Root -->
<method name="POST" id="createRoot">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Enable Root User">
<para role="shortdesc">Enables the root user for the specified database instance and returns the root password.</para>
<para>This operation enables login from any host for the root user and provides the user with a generated root password.</para>
<note>
<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>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Enable Root User requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" element="dbaas:User">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Enable Root User responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:User">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="GET" id="isRootEnabled">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Root-Enabled Status">
<para role="shortdesc">Returns true if root user is enabled for the specified database instance or false otherwise.</para>
<para>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>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Check Root User Access requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" element="dbaas:RootEnabled">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Check Root User Access responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:RootEnabled">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
Content-Length: 21
Date: Mon, 18 Mar 2013 19:09:17 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
{
"rootEnabled": true
}
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<!-- Flavor -->
<method name="GET" id="getFlavors">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List Flavors">
<para role="shortdesc">Lists information for all available <glossterm baseform="flavor">flavors</glossterm>.</para>
<para>This operation lists information for all available flavors.</para>
<para>This resource is identical to the flavors found in the OpenStack Nova API, but without the disk property.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Flavors requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" element="dbaas:Flavors">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Flavors responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>List Flavors Response: XML</title>
<?dbfo keep-together="auto"?><programlisting language="xml">HTTP/1.1 200 OK
Content-Type: application/xml
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/2" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/3" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/4" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/5" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/6" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.com/flavors/6" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
&lt;/flavors&gt;
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Flavors">
<doc>
<?hard-pagebreak?>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
role="wadl">
<title>List Flavors Response: JSON</title>
<?dbfo keep-together="auto"?><programlisting language="javascript">HTTP/1.1 200 OK
Content-Type: application/json
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/1",
"rel": "bookmark"
}
],
"name": "512MB Instance",
"ram": 512
},
{
"id": 2,
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/2",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/2",
"rel": "bookmark"
}
],
"name": "1GB Instance",
"ram": 1024
},
{
"id": 3,
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/3",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/3",
"rel": "bookmark"
}
],
"name": "2GB Instance",
"ram": 2048
},
{
"id": 4,
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/4",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/4",
"rel": "bookmark"
}
],
"name": "4GB Instance",
"ram": 4096
},
{
"id": 5,
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/5",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/5",
"rel": "bookmark"
}
],
"name": "8GB Instance",
"ram": 8192
},
{
"id": 6,
"links": [
{
"href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/6",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/6",
"rel": "bookmark"
}
],
"name": "16GB Instance",
"ram": 16384
}
]
}
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="GET" id="getFlavorById">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List Flavor By ID">
<para role="shortdesc">Lists all flavor information about the specified flavor ID.</para>
<para>This operation lists all information for the specified flavor ID with details of the RAM.</para>
<para>This resource is identical to the flavors found in the OpenStack Nova API, but without the disk property.</para>
<note>
<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 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>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Flavor By ID requests:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/xml
Content-Type: application/xml
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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: ord.databases.api.rackspacecloud.com
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
Accept: application/json
Content-Type: application/json
</programlisting>
</example>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" element="dbaas:Flavor">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Flavor By ID responses:</para>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1" rel="self"/&gt;
&lt;link href="https://ord.databases.api.rackspacecloud.com/flavors/1" rel="bookmark"/&gt;
&lt;/links&gt;
&lt;/flavor&gt;
</programlisting>
</example>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Flavor">
<doc>
<example xmlns:db="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
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
Via: 1.1 Repose (Repose/2.6.7)
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://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1",
"rel": "self"
},
{
"href": "https://ord.databases.api.rackspacecloud.com/flavors/1",
"rel": "bookmark"
}
],
"name": "512MB Instance",
"ram": 512
}
}
</programlisting>
</example>
</doc>
</representation>
</response>
<response status="400">
<representation mediaType="application/xml" element="dbaas:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401">
<representation mediaType="application/xml" element="dbaas:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403">
<representation mediaType="application/xml" element="dbaas:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405">
<representation mediaType="application/xml" element="dbaas:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413">
<representation mediaType="application/xml" element="dbaas:overLimit"/>
<representation mediaType="application/json"/>
</response>
<response status="422">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500">
<representation mediaType="application/xml" element="dbaas:instanceFault"/>
<representation mediaType="application/json"/>
</response>
<response status="501">
<representation mediaType="application/xml" element="dbaas:notImplemented"/>
<representation mediaType="application/json"/>
</response>
<response status="503">
<representation mediaType="application/xml" element="dbaas:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="404">
<representation mediaType="application/xml" element="dbaas:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
</application>
View Git Blame Copy Permalink