Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

final doc updates for EAP; combined 1 section and added 2 new ones to…

… Getting Started
  • Loading branch information...
commit c33db5c8be0a4611007038aa19731f54d3f707bd 1 parent c408cab
@masthalter authored
View
5 apidocs/pom.xml
@@ -167,7 +167,7 @@
</goals>
<phase>generate-sources</phase>
<configuration>
- <security>internal</security>
+
<xincludeSupported>true</xincludeSupported>
<sourceDirectory>src/resources</sourceDirectory>
<highlightSource>false</highlightSource>
@@ -191,7 +191,7 @@
</goals>
<phase>generate-sources</phase>
<configuration>
- <security>internal</security>
+
<xincludeSupported>true</xincludeSupported>
<sourceDirectory>src/resources</sourceDirectory>
<highlightSource>false</highlightSource>
@@ -206,6 +206,7 @@
</executions>
<configuration>
+ <socialIcons>1</socialIcons>
<branding>rackspace</branding>
</configuration>
</plugin>
View
52 apidocs/src/resources/cdb-devguide.xml
@@ -36,12 +36,11 @@
xmlns:m="http://www.w3.org/1998/Math/MathML"
xmlns:html="http://www.w3.org/1999/xhtml"
xml:id="cdb-devguide"
- status="draft"
version="5.0">
- <?rax status.bar.text="BETA"?>
+ <?rax status.bar.text="Early Access"?>
<?rax title.font.size="35px" subtitle.font.size="20px"?>
- <title>Rackspace Cloud Database BETA Developer Guide</title>
- <titleabbrev>Rackspace Cloud Database BETA Dev Guide</titleabbrev>
+ <title>Rackspace Cloud Database Developer Guide</title>
+ <titleabbrev>Rackspace Cloud Database Developer Guide</titleabbrev>
<info>
<author>
<personname>
@@ -58,9 +57,9 @@
<year>2012</year>
<holder>Rackspace US, Inc.</holder>
</copyright>
- <releaseinfo>API v1.0 BETA</releaseinfo>
+ <releaseinfo>API v1.0 EAP</releaseinfo>
<productname>Rackspace Cloud Database</productname>
- <pubdate>2012-04-04</pubdate>
+ <pubdate>2012-04-06</pubdate>
<legalnotice role="rs-api">
<annotation>
<remark>Copyright details are filled in by the template.</remark>
@@ -75,11 +74,21 @@
<revhistory>
<revision>
- <date>2012-04-04</date>
+ <date>2012-04-06</date>
<revdescription>
<itemizedlist spacing="compact">
<listitem>
- <para>Added volume capacity information to
+ <para>Removed listing of vcpus in List
+ Flavor By ID response (see <xref
+ linkend="GET_getFlavorById__version___accountID__flavors__flavorId__flavors"
+ />) and List Flavors Detail response
+ (see <xref
+ linkend="GET_getFlavorDetails__version___accountID__flavors_detail_flavors"
+ />).</para>
+ </listitem>
+ <listitem>
+ <para>Removed listing of databases and
+ added volume capacity information to
List Database Instance Status and
Details response (see <xref
linkend="GET_getInstanceById__version___accountID__instances__instanceId__Database_Instances"
@@ -386,6 +395,13 @@
>http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html</link>.
</para>
</section>
+ <section xml:id="API_Contract_Changes-d1e363">
+ <title>API Contract Changes</title>
+ <para>The API contract is not locked and may change during
+ the Early Access program.</para>
+ <para>Rackspace will notify customers in Release Notes
+ when and if the contract does change.</para>
+ </section>
</chapter>
<chapter xml:id="Concepts-d1e563">
<title>Concepts</title>
@@ -422,9 +438,9 @@
<title>Volume</title>
<para>A volume is user-specified storage that contains the
MySQL data directory. Volumes are automatically
- provisioned on dedicated Internet Small Computer
- System Interface (iSCSI) storage area networks (SAN)
- that provide for increased performance, scalability,
+ provisioned on shared Internet Small Computer System
+ Interface (iSCSI) storage area networks (SAN) that
+ provide for increased performance, scalability,
availability and manageability. Applications with high
I/O demands are performance optimized and data is
protected through both local and network RAID-10.
@@ -546,7 +562,7 @@
<area xml:id="credentials.json.key"
units="linecolumn" coords="12 18"/>
</areaspec>
- <programlisting language="javascript">
+ <programlisting language="json">
<xi:include href="samples/db-credentials.json" parse="text"/>
</programlisting>
</programlistingco>
@@ -611,7 +627,7 @@
<area xml:id="auth.json.sc.s.e.iu"
units="linecolumn" coords="19 36"/>
</areaspec>
- <programlisting language="javascript">
+ <programlisting language="json">
<xi:include href="samples/db-auth.json" parse="text"/>
</programlisting>
</programlistingco>
@@ -892,7 +908,7 @@
<example xml:id="request_with_headers_json">
<title>Request with Headers: JSON</title>
<?dbfo keep-together="always"?>
- <programlisting language="xml"><xi:include href="samples/db-request-types.json" parse="text"><xi:fallback>Missing code sample!<?rax fail?></xi:fallback></xi:include></programlisting>
+ <programlisting language="json"><xi:include href="samples/db-request-types.json" parse="text"><xi:fallback>Missing code sample!<?rax fail?></xi:fallback></xi:include></programlisting>
</example>
<para><?rax-fo keep-with-next?>Therefore an XML response format is returned:</para>
<example>
@@ -926,7 +942,7 @@
<example>
<title>202 ACCEPTED Response: JSON</title>
<?dbfo keep-together="always"?>
- <programlisting language="xml">Reviewer: need code example</programlisting>
+ <programlisting language="json">Reviewer: need code example</programlisting>
</example>
<para>The following table shows the attributes for asynchronous responses:</para>
<table rules="all">
@@ -1530,7 +1546,7 @@
<example>
<title>Example Fault Response: JSON</title>
<?dbfo keep-together="always"?>
- <programlisting language="xml">
+ <programlisting language="json">
<xi:include href="samples/db-faults-instanceFault.json" parse="text"/>
</programlisting>
</example>
@@ -1557,7 +1573,7 @@
<title>Example badRequest Fault on Volume Size Errors:
JSON</title>
<?dbfo keep-together="always"?>
- <programlisting language="xml">
+ <programlisting language="json">
<xi:include href="samples/db-faults-badRequest.json" parse="text"/>
</programlisting>
</example>
@@ -1573,7 +1589,7 @@
<example>
<title>Example itemNotFound Fault: JSON</title>
<?dbfo keep-together="always"?>
- <programlisting language="xml">
+ <programlisting language="json">
<xi:include href="samples/db-faults-itemNotFound.json" parse="text"/>
</programlisting>
</example>
View
333 apidocs/src/resources/cdb-getting-started.xml
@@ -31,9 +31,8 @@
xmlns:m="http://www.w3.org/1998/Math/MathML"
xmlns:html="http://www.w3.org/1999/xhtml"
xml:id="cdb-getting-started"
- class="specification"
- status="draft">
- <?rax status.bar.text="BETA"?>
+ class="specification">
+ <?rax status.bar.text="Early Access"?>
<info>
<title>Getting Started with Rackspace Cloud Database and
Servers</title>
@@ -42,17 +41,31 @@
<year>2012</year>
<holder>Rackspace US, Inc.</holder>
</copyright>
- <releaseinfo>API v1.0 BETA</releaseinfo>
- <pubdate>2012-03-xx</pubdate>
+ <releaseinfo>API v1.0 EAP</releaseinfo>
+ <pubdate>2012-04-06</pubdate>
<revhistory>
<revision>
- <date>2012-03-xx</date>
+ <date>2012-04-06</date>
<revdescription>
<itemizedlist spacing="compact">
<listitem>
<para>Added trademark to Cloud
Servers.</para>
</listitem>
+ <listitem>
+ <para>Combined section on creating a user
+ with Creating a Database Instance with
+ a Database (see <xref
+ linkend="Create_DB_Instance"
+ />).</para>
+ </listitem>
+ <listitem>
+ <para>Added sections <xref
+ linkend="List_DBS_For_Instance"/>
+ and <xref
+ linkend="List_Users_DB_Instance"
+ />.</para>
+ </listitem>
</itemizedlist>
</revdescription>
</revision>
@@ -186,8 +199,8 @@
<revdescription>
<itemizedlist spacing="compact">
<listitem>
- <para>Fixed cURL XML and JSON examples for <xref
- linkend="Create_DB_User"/>.</para>
+ <para>Fixed cURL XML and JSON examples for
+ Create User.</para>
</listitem>
</itemizedlist>
</revdescription>
@@ -474,7 +487,7 @@
<example>
<title>cURL Authenticate Request: XML</title>
<?dbfo keep-together="always"?>
- <screen><command>curl</command> <option>-i</option> <option>-d</option> \
+ <screen language="xml"><command>curl</command> <option>-i</option> <option>-d</option> \
'&lt;?xml version="1.0" encoding="UTF-8"?>
&lt;credentials xmlns="http://docs.rackspacecloud.com/auth/api/v1.1"
username="<emphasis role="bold">your_username</emphasis>"
@@ -486,7 +499,7 @@
<example>
<title>cURL Authenticate Request: JSON</title>
<?dbfo keep-together="always"?>
- <programlisting><command>curl</command> <option>-i</option> <option>-d</option> \
+ <programlisting language="json"><command>curl</command> <option>-i</option> <option>-d</option> \
'{
"credentials": {
"username": "<emphasis role="bold">your_username</emphasis>",
@@ -502,7 +515,7 @@
</example>
<example>
<title>Authenticate Response: JSON</title>
- <programlisting language="xml"><xi:include href="../../src/resources/samples/db-auth.json" parse="text"><xi:fallback>Missing code sample! <?rax fail?></xi:fallback></xi:include></programlisting>
+ <programlisting language="json"><xi:include href="../../src/resources/samples/db-auth.json" parse="text"><xi:fallback>Missing code sample! <?rax fail?></xi:fallback></xi:include></programlisting>
</example>
<para>The authentication token <code>id</code> is returned
along with an <code>expires</code> attribute that
@@ -651,14 +664,14 @@
Flavors Details:</para>
<example>
<title>cURL List Flavors Details Request: XML</title>
- <programlisting><command>curl -i</command> \
+ <programlisting language="xml"><command>curl -i</command> \
-H 'X-Auth-Token: <emphasis role="bold">your_auth_token</emphasis>' \
<option>-H 'Accept: application/xml'</option> \
<uri>'https://ord.databases.api.rackspacecloud.com/v1.0/</uri><emphasis role="bold">your_acct_id</emphasis><uri>/flavors/detail'</uri></programlisting>
</example>
<example>
<title>cURL List Flavors Details Request: JSON</title>
- <programlisting><command>curl -i</command> \
+ <programlisting language="json"><command>curl -i</command> \
-H 'X-Auth-Token: <emphasis role="bold">your_auth_token</emphasis>' \
<option>-H 'Accept: application/json'</option> \
<uri>'https://ord.databases.api.rackspacecloud.com/v1.0/</uri><emphasis role="bold">your_acct_id</emphasis><uri>/flavors/detail'</uri></programlisting>
@@ -688,7 +701,7 @@
</example>
<example>
<title>List Flavors Details Response: JSON</title>
- <programlisting language="xml"><xi:include href="../../src/resources/samples/db-flavors-detail-response.json" parse="text"><xi:fallback>Missing code sample! <?rax fail?></xi:fallback></xi:include></programlisting>
+ <programlisting language="json"><xi:include href="../../src/resources/samples/db-flavors-detail-response.json" parse="text"><xi:fallback>Missing code sample! <?rax fail?></xi:fallback></xi:include></programlisting>
</example>
<para>In the previous examples, you can see from the flavor
<code>name</code> that there are multiple flavors
@@ -701,22 +714,45 @@
</section>
<section xml:id="Create_DB_Instance">
- <title>Create a Database Instance with a Database</title>
+ <title>Create a Database Instance with a Database and a
+ User</title>
<para>A database instance is an isolated MySQL instance in
a single tenant environment on a shared physical host
machine. In the example below, you create a database
- instance with a database using the tiny flavor and volume
- size of 2 gigabytes (GB). </para>
+ instance with a database and a user. The example instance
+ uses the tiny flavor and a volume size of 2 gigabytes
+ (GB). </para>
<para>Refer to <link
- xlink:href="http://docs-beta.rackspace.com/cdb/api/v1.0/cdb-devguide/content/POST_createDatabase__version__instances__instanceId__databases_databases.html"
+ xlink:href="http://docs-beta.rackspace.com/cdb/api/v1.0/cdb-devguide/content/POST_createDatabase__version___accountID__instances__instanceId__databases_databases.html"
>Create Database</link> in the <citetitle>Cloud
Database Developer Guide</citetitle> for the
restrictions for choosing the database name.</para>
<para>The example creates a database instance
- <code>myrackinstance</code>, with a database named
- <code>sampledb</code>, <code>utf8</code> character
- set, and <code>utf8_general_ci</code> collation, using the
- tiny flavor and volume size of 2 gigabytes (GB).</para>
+ <code>myrackinstance</code>, with the following: <itemizedlist>
+ <listitem>
+ <para>the tiny flavor</para>
+ </listitem>
+ <listitem>
+ <para>volume size of 2 gigabytes (GB)</para>
+ </listitem>
+ <listitem>
+ <para>a database named <code>sampledb</code> with:<itemizedlist>
+ <listitem>
+ <para><code>utf8</code> character
+ set</para>
+ </listitem>
+ <listitem>
+ <para><code>utf8_general_ci</code>
+ collation</para>
+ </listitem>
+ </itemizedlist></para>
+ </listitem>
+ <listitem>
+ <para>a user <code>simplestUser</code> with
+ password <code>password</code></para>
+ </listitem>
+ </itemizedlist>
+ </para>
<para>Notice that the request specifies the flavor reference
(<code>flavorRef</code>) to the tiny flavor (id 1)
that was returned by the List Flavors Details call:
@@ -726,17 +762,24 @@
<para>The following examples show the cURL requests for Create
Instance:</para>
<example>
- <title>cURL Create Instance Request : XML</title>
- <programlisting><command>curl</command> <option>-i</option> <option>-d</option> \
+ <title>cURL Create Instance Request: XML</title>
+ <programlisting language="xml"><command>curl</command> <option>-i</option> <option>-d</option> \
'&lt;?xml version="1.0" ?>
&lt;instance xmlns="http://docs.openstack.org/database/api/v1.0"
name="myrackinstance"
flavorRef=
- "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1">
+ "https://ord.databases.api.rackspacecloud.com/v1.0/<emphasis role="bold">your_acct_id</emphasis>/flavors/1">
&lt;databases>
&lt;database name="sampledb" character_set="utf8"
collate="utf8_general_ci" />
- &lt;/databases>
+ &lt;/databases>
+ &lt;users>
+ &lt;user name="simplestUser" password="password">
+ &lt;databases>
+ &lt;database name="sampledb"/>
+ &lt;/databases>
+ &lt;/user>
+ &lt;/users>
&lt;volume size="2" />
&lt;/instance>' \
-H 'X-Auth-Token: <emphasis role="bold">your_auth_token</emphasis>' \
@@ -745,25 +788,35 @@
<uri>'https://ord.databases.api.rackspacecloud.com/v1.0/</uri><emphasis role="bold">your_acct_id</emphasis><uri>/instances'</uri></programlisting>
</example>
<example>
- <title>cURL Create Instance Request : JSON</title>
- <programlisting><command>curl</command> <option>-i</option> <option>-d</option> \
-'{
- "instance": {
- "name": "myrackinstance",
- "flavorRef":
-"https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1",
- "databases": [
- {
- "name": "sampledb",
- "character_set": "utf8",
- "collate": "utf8_general_ci"
- }
- ],
+ <title>cURL Create Instance Request: JSON</title>
+ <programlisting language="json"><command>curl</command> <option>-i</option> <option>-d</option> \
+'{
+ "instance": {
+ "databases": [
+ {
+ "character_set": "utf8",
+ "collate": "utf8_general_ci",
+ "name": "sampledb"
+ }
+ ],
+ "flavorRef": "https://ord.databases.api.rackspacecloud.com/v1.0/<emphasis role="bold">your_acct_id</emphasis>/flavors/1",
+ "name": "myrackinstance",
+ "users": [
+ {
+ "databases": [
+ {
+ "name": "sampledb"
+ }
+ ],
+ "name": "simplestUser",
+ "password": "password"
+ }
+ ],
"volume":
- {
- "size": "2"
- }
- }
+ {
+ "size": "2"
+ }
+ }
}' \
-H 'X-Auth-Token: <emphasis role="bold">your_auth_token</emphasis>' \
<option>-H 'Content-Type: application/json'</option> \
@@ -786,9 +839,9 @@
be replaced in the request URL)</para>
</listitem>
</itemizedlist></para>
- <para>Also remember to replace the dummy account id
- <code>1234</code> shown in the <code>flavorRef</code>
- property for the examples with your actual account id:
+ <para>Remember to replace the account id shown in the
+ <code>flavorRef</code> property for the examples with
+ your actual account id:
<code>"https://ord.databases.api.rackspacecloud.com/v1.0/</code><emphasis
role="bold"
>your_acct_id</emphasis><code>/flavors/1"</code>.</para>
@@ -797,62 +850,47 @@
<example>
<title>Create Instance Response: XML</title>
- <programlisting language="xml"><xi:include href="../../src/resources/samples/db-create-database-instance-response.xml" parse="text"><xi:fallback>Missing code sample! <?rax fail?></xi:fallback></xi:include></programlisting>
+ <programlisting language="xml"><xi:include href="../../src/resources/samples/db-gs-create-database-instance-response.xml" parse="text"><xi:fallback>Missing code sample! <?rax fail?></xi:fallback></xi:include></programlisting>
</example>
<example>
<title>Create Instance Response: JSON</title>
- <programlisting language="xml"><xi:include href="../../src/resources/samples/db-create-database-instance-response.json" parse="text"><xi:fallback>Missing code sample! <?rax fail?></xi:fallback></xi:include></programlisting>
+ <programlisting language="json"><xi:include href="../../src/resources/samples/db-gs-create-database-instance-response.json" parse="text"><xi:fallback>Missing code sample! <?rax fail?></xi:fallback></xi:include></programlisting>
</example>
<para>You will need to specify the instance id returned (in
the response examples above:
- <code>id="00ff11ee-22dd-33cc-44bb-55aa66007799"</code>)
- on subsequent API calls that require it, for example
- Create User.</para>
+ <code>id="d379ba5c-9a1f-4aa9-9a17-afe237d04c65"</code>)
+ on subsequent API calls that require it, for example List
+ Databases for Instance.</para>
+ <para>Note that the database and user are not listed in the
+ Create Instance responses. Next you will verify that both
+ were successfully created.</para>
</section>
- <section xml:id="Create_DB_User">
- <title>Create User</title>
- <para>Create a new user within the database instance. The user
- name and password are required.</para>
- <para>This operation asynchronously provisions a new user
- (<code>simplestUser</code>) and password
- (<code>password</code>) for the specified database
- instance (<emphasis role="bold">instance_id</emphasis>) and database
- (<code>sampledb</code>), as specified in the request. </para>
- <para>Once the request is validated and progress has started
- on the provisioning process, a 202 Accepted response
- object is returned.</para>
+ <section xml:id="List_DBS_For_Instance">
+ <title>List Databases for Instance</title>
+ <para>In this section you will list the databases in the
+ specified database instance.</para>
+ <para>This operation does not require a request body.</para>
<para xmlns="http://docbook.org/ns/docbook">The following
- examples show the cURL requests for Create User:</para>
+ examples show the cURL requests for List Databases for
+ Instance:</para>
<example>
- <title>cURL Create User Request: XML</title>
- <programlisting><command>curl</command> <option>-d</option> \
-'&lt;?xml version="1.0" ?>
-&lt;users xmlns="http://docs.openstack.org/database/api/v1.0">
- &lt;user name="simplestUser"
- password="password" database="sampledb"/>
-&lt;/users>' \
+ <title>cURL List Databases for Instance Request:
+ XML</title>
+ <programlisting language="xml"><command>curl</command> <option>-i</option> \
-H 'X-Auth-Token: <emphasis role="bold">your_auth_token</emphasis>' \
<option>-H 'Content-Type: application/xml'</option> \
<option>-H 'Accept: application/xml'</option> \
-<uri>'https://ord.databases.api.rackspacecloud.com/v1.0/</uri><emphasis role="bold">your_acct_id</emphasis><uri>/instances/</uri><emphasis role="bold">instance_id</emphasis><uri>/users'</uri></programlisting>
+<uri>'https://ord.databases.api.rackspacecloud.com/v1.0/</uri><emphasis role="bold">your_acct_id</emphasis><uri>/instances/</uri><emphasis role="bold">instance_id</emphasis><uri>/databases'</uri></programlisting>
</example>
<example>
<?dbfo keep-together="always"?>
- <title>cURL Create User Request: JSON</title>
- <programlisting><command>curl</command> <option>-d</option> \
-'{
- "users": [
- {
- "name": "simplestUser",
- "password": "password",
- "database": "sampledb"
- }
- ]
-}' \
+ <title>cURL List Databases for Instance Request:
+ JSON</title>
+ <programlisting language="xml"><command>curl</command> <option>-i</option> \
-H 'X-Auth-Token: <emphasis role="bold">your_auth_token</emphasis>' \
<option>-H 'Content-Type: application/json'</option> \
-<uri>'https://ord.databases.api.rackspacecloud.com/v1.0/</uri><emphasis role="bold">your_acct_id</emphasis><uri>/instances/</uri><emphasis role="bold">instance_id</emphasis><uri>/users'</uri></programlisting>
+<uri>'https://ord.databases.api.rackspacecloud.com/v1.0/</uri><emphasis role="bold">your_acct_id</emphasis><uri>/instances/</uri><emphasis role="bold">instance_id</emphasis><uri>/databases'</uri></programlisting>
</example>
<para>Remember to replace the names in the examples above with
their actual respective values:<itemizedlist spacing="compact">
@@ -877,17 +915,132 @@
linkend="Create_DB_Instance"/>)</para>
</listitem>
</itemizedlist></para>
- <para>This operation does not return a response body.</para>
<para>The following examples show the responses for Create
User:</para>
<example>
- <title>Create User Response: XML</title>
- <programlisting language="xml"><xi:include href="../../src/resources/samples/db-create-users-response.xml" parse="text"><xi:fallback>Missing code sample! <?rax fail?></xi:fallback></xi:include></programlisting>
+ <title>List Databases for Instance Response: XML</title>
+ <programlisting language="xml">HTTP/1.1 200 OK
+Content-Type: application/xml
+Content-Length: 109
+Date: Thu, 05 Apr 2012 18:20:18 GMT
+
+&lt;databases xmlns="http://docs.openstack.org/database/api/v1.0">
+ &lt;database name="sampledb"/>
+&lt;/databases>
+</programlisting>
+ </example>
+ <example>
+ <title>List Databases for Instance Response: JSON</title>
+ <programlisting language="json">HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 37
+Date: Thu, 05 Apr 2012 18:13:53 GMT
+
+{
+ "databases": [
+ {
+ "name": "sampledb"
+ }
+ ]
+}</programlisting>
</example>
+ <para>You can see that the database <code>sampledb</code> was
+ successfully created. Next you will list the users.</para>
+ </section>
+ <section xml:id="List_Users_DB_Instance">
+ <title>List Users in Database Instance</title>
+ <para>In this section you will list the users in the specified
+ database instance.</para>
+ <para>This operation does not require a request body.</para>
+ <para>The following examples show the cURL requests for List
+ Users in Database Instance:</para>
<example>
- <title>Create User Response: JSON</title>
- <programlisting language="xml"><xi:include href="../../src/resources/samples/db-create-users-response.json" parse="text"><xi:fallback>Missing code sample! <?rax fail?></xi:fallback></xi:include></programlisting>
+ <title>cURL List Users in Database Instance Request:
+ XML</title>
+ <programlisting language="xml"><command>curl</command> <option>-i</option> \
+-H 'X-Auth-Token: <emphasis role="bold">your_auth_token</emphasis>' \
+<option>-H 'Content-Type: application/xml'</option> \
+<option>-H 'Accept: application/xml'</option> \
+<uri>'https://ord.databases.api.rackspacecloud.com/v1.0/</uri><emphasis role="bold">your_acct_id</emphasis><uri>/instances/</uri><emphasis role="bold">instance_id</emphasis><uri>/users'</uri></programlisting>
+ </example>
+ <example>
+ <?dbfo keep-together="always"?>
+ <title>cURL List Users in Database Instance Request:
+ JSON</title>
+ <programlisting language="json"><command>curl</command> <option>-i</option> \
+-H 'X-Auth-Token: <emphasis role="bold">your_auth_token</emphasis>' \
+<option>-H 'Content-Type: application/json'</option> \
+<uri>'https://ord.databases.api.rackspacecloud.com/v1.0/</uri><emphasis role="bold">your_acct_id</emphasis><uri>/instances/</uri><emphasis role="bold">instance_id</emphasis><uri>/users'</uri></programlisting>
+ </example>
+ <para>Remember to replace the names in the examples above with
+ their actual respective values:<itemizedlist
+ spacing="compact">
+ <listitem>
+ <para><emphasis role="bold"
+ >your_auth_token</emphasis> &mdash; as
+ returned in your authentication response (see
+ the examples in <xref
+ linkend="Generating_Auth_Token"/>)</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold"
+ >your_acct_id</emphasis> &mdash; as
+ returned in your authentication response (see
+ the examples in <xref
+ linkend="Generating_Auth_Token"/>)</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">instance_id</emphasis>
+ &mdash; as returned in your create instance
+ response (see the examples in <xref
+ linkend="Create_DB_Instance"/>)</para>
+ </listitem>
+ </itemizedlist></para>
+ <para>The following examples show the responses for List
+ Users in Database Instance:</para>
+ <example>
+ <title>List Users in Database Instance Response:
+ XML</title>
+ <programlisting language="xml">HTTP/1.1 200 OK
+Content-Type: application/xml
+Content-Length: 109
+Date: Thu, 05 Apr 2012 18:20:18 GMT
+
+&lt;?xml version="1.0" ?>
+&lt;users xmlns="http://docs.openstack.org/database/api/v1.0">
+ &lt;user name="simplestUser">
+ &lt;databases>
+ &lt;database>
+ &lt;name>sampledb&lt;/name>
+ &lt;/database>
+ &lt;/databases>
+ &lt;/user>
+&lt;/users>
+</programlisting>
+ </example>
+ <example>
+ <title>List Users in Database Instance Response:
+ JSON</title>
+ <programlisting language="json">HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 113
+Date: Thu, 05 Apr 2012 18:13:53 GMT
+
+{
+ "users": [
+ {
+ "databases": [
+ {
+ "name": "sampledb"
+ }
+ ],
+ "name": "simplestUser"
+ }
+ ]
+}</programlisting>
</example>
+ <para>You can see that the user <code>simplestUser</code> was
+ successfully created.</para>
</section>
<section xml:id="Create_Cloud_Server">
<title>Create a New Cloud Server</title>
View
16 apidocs/src/resources/cdb-mgmt-devguide.xml
@@ -32,13 +32,13 @@
xmlns:m="http://www.w3.org/1998/Math/MathML"
xmlns:html="http://www.w3.org/1999/xhtml"
xml:id="cdb-devguide"
- status="draft"
+
version="5.0">
- <?rax status.bar.text="BETA"?>
+ <?rax status.bar.text="Early Access"?>
<?rax title.font.size="35px" subtitle.font.size="20px"?>
- <title>Rackspace Cloud Database BETA Developer Guide for Service Management</title>
+ <title>Rackspace Cloud Database Developer Guide for Service Management</title>
<?rax status.bar.text="RAX INTERNAL"?>
- <titleabbrev>Rackspace Cloud Database BETA Mgmt Dev Guide</titleabbrev>
+ <titleabbrev>Rackspace Cloud Database Management Developer Guide</titleabbrev>
<info>
<author>
<personname>
@@ -54,9 +54,9 @@
<year>2012</year>
<holder>Rackspace US, Inc.</holder>
</copyright>
- <releaseinfo>API v1.0 BETA</releaseinfo>
- <productname>Rackspace Cloud Database BETA</productname>
- <pubdate>2012-04-04</pubdate>
+ <releaseinfo>API v1.0 EAP</releaseinfo>
+ <productname>Rackspace Cloud Database</productname>
+ <pubdate>2012-04-06</pubdate>
<legalnotice role="rs-api">
<annotation>
<remark>Copyright details are filled in by the template.</remark>
@@ -72,7 +72,7 @@
<revhistory>
<revision>
- <date>2012-04-04</date>
+ <date>2012-04-06</date>
<revdescription>
<itemizedlist spacing="compact">
<listitem>
View
41 apidocs/src/resources/samples/db-create-database-instance-response.json
@@ -1,41 +0,0 @@
-HTTP/1.1 200 OK
-Content-Type: application/json
-Content-Length: 632
-Date: Mon, 28 Nov 2011 21:35:41 GMT
-
-{
- "instance": {
- "created": "2011-11-03T15:55:26Z",
- "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"
- }
- ]
- },
- "hostname": "d735f61b985bb003a61dc72948dbf4e7174da12c.rackspaceclouddb.com",
- "id": "00ff11ee-22dd-33cc-44bb-55aa66007799",
- "links": [
- {
- "href": "https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/00ff11ee-22dd-33cc-44bb-55aa66007799",
- "rel": "self"
- },
- {
- "href": "https://ord.databases.api.rackspacecloud.com/instances/00ff11ee-22dd-33cc-44bb-55aa66007799",
- "rel": "bookmark"
- }
- ],
- "name": "myrackinstance",
- "status": "BUILD",
- "updated": "2011-11-03T15:55:27Z",
- "volume": {
- "size": "2"
- }
- }
-}
View
24 apidocs/src/resources/samples/db-create-database-instance-response.xml
@@ -1,24 +0,0 @@
-HTTP/1.1 200 OK
-Content-Type: application/xml
-Content-Length: 639
-Date: Mon, 28 Nov 2011 16:19:34 GMT
-
-<instance created="2011-11-03T15:57:52Z"
- hostname="d735f61b985bb003a61dc72948dbf4e7174da12c.rackspaceclouddb.com"
- id="00ff11ee-22dd-33cc-44bb-55aa66007799" name="myrackinstance" status="BUILD" updated="2011-11-03T15:57:55Z"
- xmlns="http://docs.openstack.org/database/api/v1.0">
- <links>
- <link href="https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/00ff11ee-22dd-33cc-44bb-55aa66007799" rel="self"/>
- <link href="https://ord.databases.api.rackspacecloud.com/instances/00ff11ee-22dd-33cc-44bb-55aa66007799" rel="bookmark"
- />
- </links>
- <volume size="2"/>
- <flavor id="1">
- <links>
- <link href="https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1"
- rel="self"/>
- <link href="https://ord.databases.api.rackspacecloud.com/flavors/1"
- rel="bookmark"/>
- </links>
- </flavor>
-</instance>
View
3  apidocs/src/resources/samples/db-flavors-by-id-response.json
@@ -17,7 +17,6 @@ Date: Wed, 25 Jan 2012 21:53:05 GMT
}
],
"name": "m1.tiny",
- "ram": 512,
- "vcpus": 1
+ "ram": 512
}
}
View
2  apidocs/src/resources/samples/db-flavors-by-id-response.xml
@@ -3,7 +3,7 @@ Content-Type: application/xml
Content-Length: 284
Date: Wed, 25 Jan 2012 21:53:05 GMT
-<flavor id="1" name="m1.tiny" ram="512" vcpus="1" xmlns="http://docs.openstack.org/database/api/v1.0">
+<flavor id="1" name="m1.tiny" ram="512" xmlns="http://docs.openstack.org/database/api/v1.0">
<links>
<link href="https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1" rel="self"/>
<link href="https://ord.databases.api.rackspacecloud.com/flavors/1" rel="bookmark"/>
View
18 apidocs/src/resources/samples/db-flavors-detail-response.json
@@ -18,8 +18,7 @@ Date: Wed, 25 Jan 2012 21:53:05 GMT
}
],
"name": "m1.medium",
- "ram": 2048,
- "vcpus": 1
+ "ram": 2048
},
{
"id": 2,
@@ -34,8 +33,7 @@ Date: Wed, 25 Jan 2012 21:53:05 GMT
}
],
"name": "m1.small",
- "ram": 1024,
- "vcpus": 1
+ "ram": 1024
},
{
"id": 4,
@@ -50,8 +48,7 @@ Date: Wed, 25 Jan 2012 21:53:05 GMT
}
],
"name": "m1.large",
- "ram": 4096,
- "vcpus": 1
+ "ram": 4096
},
{
"id": 6,
@@ -66,8 +63,7 @@ Date: Wed, 25 Jan 2012 21:53:05 GMT
}
],
"name": "m1.xxlarge",
- "ram": 16384,
- "vcpus": 4
+ "ram": 16384
},
{
"id": 1,
@@ -82,8 +78,7 @@ Date: Wed, 25 Jan 2012 21:53:05 GMT
}
],
"name": "m1.tiny",
- "ram": 512,
- "vcpus": 1
+ "ram": 512
},
{
"id": 5,
@@ -98,8 +93,7 @@ Date: Wed, 25 Jan 2012 21:53:05 GMT
}
],
"name": "m1.xlarge",
- "ram": 8192,
- "vcpus": 2
+ "ram": 8192
}
]
}
View
12 apidocs/src/resources/samples/db-flavors-detail-response.xml
@@ -4,37 +4,37 @@ Content-Length: 1624
Date: Wed, 25 Jan 2012 21:53:05 GMT
<flavors xmlns="http://docs.openstack.org/database/api/v1.0">
- <flavor id="3" name="m1.medium" ram="2048" vcpus="1">
+ <flavor id="3" name="m1.medium" ram="2048">
<links>
<link href="https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/3" rel="self"/>
<link href="https://ord.databases.api.rackspacecloud.com/flavors/3" rel="bookmark"/>
</links>
</flavor>
- <flavor id="2" name="m1.small" ram="1024" vcpus="1">
+ <flavor id="2" name="m1.small" ram="1024">
<links>
<link href="https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/2" rel="self"/>
<link href="https://ord.databases.api.rackspacecloud.com/flavors/2" rel="bookmark"/>
</links>
</flavor>
- <flavor id="4" name="m1.large" ram="4096" vcpus="1">
+ <flavor id="4" name="m1.large" ram="4096">
<links>
<link href="https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/4" rel="self"/>
<link href="https://ord.databases.api.rackspacecloud.com/flavors/4" rel="bookmark"/>
</links>
</flavor>
- <flavor id="6" name="m1.xxlarge" ram="16384" vcpus="4">
+ <flavor id="6" name="m1.xxlarge" ram="16384">
<links>
<link href="https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/6" rel="self"/>
<link href="https://ord.databases.api.rackspacecloud.com/flavors/6" rel="bookmark"/>
</links>
</flavor>
- <flavor id="1" name="m1.tiny" ram="512" vcpus="1">
+ <flavor id="1" name="m1.tiny" ram="512">
<links>
<link href="https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1" rel="self"/>
<link href="https://ord.databases.api.rackspacecloud.com/flavors/1" rel="bookmark"/>
</links>
</flavor>
- <flavor id="5" name="m1.xlarge" ram="8192" vcpus="2">
+ <flavor id="5" name="m1.xlarge" ram="8192">
<links>
<link href="https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/5" rel="self"/>
<link href="https://ord.databases.api.rackspacecloud.com/flavors/5" rel="bookmark"/>
View
41 apidocs/src/resources/samples/db-gs-create-database-instance-response.json
@@ -0,0 +1,41 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 756
+Date: Thu, 05 Apr 2012 16:48:44 GMT
+
+{
+ "instance": {
+ "status": "BUILD",
+ "updated": "2012-04-05T16:48:44Z",
+ "name": "myrackinstance",
+ "links": [
+ {
+ "href": "http://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/d379ba5c-9a1f-4aa9-9a17-afe237d04c65",
+ "rel": "self"
+ },
+ {
+ "href": "http://ord.databases.api.rackspacecloud.com/instances/d379ba5c-9a1f-4aa9-9a17-afe237d04c65",
+ "rel": "bookmark"
+ }
+ ],
+ "created": "2012-04-05T16:48:44Z",
+ "hostname": "ca9fa2985e47b351915c75f1a8e95d0729068892.rackspaceclouddb.com",
+ "volume": {
+ "size": "2"
+ },
+ "flavor": {
+ "id": "1",
+ "links": [
+ {
+ "href": "http://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1",
+ "rel": "self"
+ },
+ { "href": "http://ord.databases.api.rackspacecloud.com/flavors/1",
+ "rel": "bookmark"
+ }
+ ]
+ },
+ "id": "d379ba5c-9a1f-4aa9-9a17-afe237d04c65"
+ }
+}
+
View
22 apidocs/src/resources/samples/db-gs-create-database-instance-response.xml
@@ -0,0 +1,22 @@
+HTTP/1.1 200 OK
+Content-Type: application/xml
+Content-Length: 870
+Date: Thu, 05 Apr 2012 16:17:29 GMT
+
+<instance created="2012-04-05T16:17:29Z"
+ hostname="8ba52fad9ec4aab5d75eabd1136c9750f64233ba.rackspaceclouddb.com"
+ id="d379ba5c-9a1f-4aa9-9a17-afe237d04c65" name="myrackinstance" status="BUILD" updated="2012-04-05T16:17:29Z"
+ xmlns="http://docs.openstack.org/database/api/v1.0">
+ <links>
+ <link href="http://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/d379ba5c-9a1f-4aa9-9a17-afe237d04c65" rel="self"/>
+ <link href="http://ord.databases.api.rackspacecloud.com/instances/d379ba5c-9a1f-4aa9-9a17-afe237d04c65" rel="bookmark"/>
+ </links>
+ <volume size="2"/>
+ <flavor id="1">
+ <links>
+ <link href="http://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1" rel="self"/>
+ <link href="http://ord.databases.api.rackspacecloud.com/flavors/1" rel="bookmark"/>
+ </links>
+ </flavor>
+</instance>
+
View
3  apidocs/src/resources/samples/db-instance-status-detail-response.json
@@ -31,8 +31,7 @@ Date: Wed, 28 Mar 2012 21:37:29 GMT
"rel": "bookmark"
}
],
- "name": "xml_rack_instance",
- "rootEnabled": true,
+ "name": "xml_rack_instance",
"status": "ACTIVE",
"updated": "2012-03-28T21:34:25Z",
"volume": {
View
2  apidocs/src/resources/samples/db-instance-status-detail-response.xml
@@ -4,7 +4,7 @@ Content-Length: 796
Date: Wed, 28 Mar 2012 21:37:31 GMT
<?xml version="1.0" ?>
-<instance created="2012-03-28T21:30:50Z" hostname="e09ad9a3f73309469cf1f43d11e79549caf9acf2.rackspaceclouddb.com" id="da6fb68c-190d-4520-af04-ecb1e2b3e850" name="json_rack_instance" rootEnabled="True" status="ACTIVE" updated="2012-03-28T21:34:17Z" xmlns="http://docs.openstack.org/database/api/v1.0">
+<instance created="2012-03-28T21:30:50Z" hostname="e09ad9a3f73309469cf1f43d11e79549caf9acf2.rackspaceclouddb.com" id="da6fb68c-190d-4520-af04-ecb1e2b3e850" name="json_rack_instance" status="ACTIVE" updated="2012-03-28T21:34:17Z" xmlns="http://docs.openstack.org/database/api/v1.0">
<links>
<link href="https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/da6fb68c-190d-4520-af04-ecb1e2b3e850" rel="self"/>
<link href="https://ord.databases.api.rackspacecloud.com/instances/da6fb68c-190d-4520-af04-ecb1e2b3e850" rel="bookmark"/>
View
8 xsd/dbaas.wadl
@@ -405,6 +405,10 @@
<wadl:doc xml:lang="EN" title="List Database Instance Status and Details" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists status and details for a specified database instance or all database instances associated with an account.</para>
<para>This operation lists the status and details of the specified database instance or, if no database instance is specified, all database instances associated with an account.</para>
+ <para>If a database instance is specified, this operation lists the volume size in gigabytes (GB) and the approximate GB used.</para>
+ <note>After instance creation, the used 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.</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>
@@ -959,7 +963,7 @@
<listitem>
<para>For additional information, refer to: <link
xlink:href="http://dev.mysql.com/doc/refman/5.1/en/user-account-management.html"
- >http://http://dev.mysql.com/doc/refman/5.1/en/user-account-management.html</link></para>
+ >http://dev.mysql.com/doc/refman/5.1/en/user-account-management.html</link></para>
</listitem>
</itemizedlist>
</wadl:doc>
@@ -1157,7 +1161,7 @@
<method name="GET" id="getFlavorDetails">
<wadl:doc xml:lang="EN" title="List Flavors Details" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists all details for all available flavors.</para>
- <para>This operation lists all available flavors with details of the RAM.</para>
+ <para>This operation lists all available flavors with details on the available RAM.</para>
<para>This resource is identical to the flavors found in the OpenStack Nova API, but without the disk property.</para>
</wadl:doc>
<request>
View
15 xsd/management.wadl
@@ -27,11 +27,7 @@
</resource>
</resource>
<resource id="instances" path="instances">
- <method href="#getIndex" name="GET">
- <request>
- <param name="deleted" style="query" type="xsd:boolean" />
- </request>
- </method>
+ <method href="#getIndex"/>
<resource id="instanceId" path="{instanceId}">
<param name="instanceId" style="template" type="xsd:string">
<doc>The instance ID for the specified database instance.</doc></param>
@@ -178,6 +174,13 @@
</para>
</wadl:doc>
<request>
+ <param name="deleted" style="query" type="xsd:boolean">
+ <wadl:doc xmlns="http://docbook.org/ns/docbook">
+ <para>This query parameter specifies whether or not to list deleted instances.
+ If <code>true</code>, deleted instances are listed. If <code>false</code>, deleted instances are not listed.
+ </para>
+ </wadl:doc>
+ </param>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List All Instances requests:</para>
@@ -200,6 +203,8 @@
<representation mediaType="application/json">
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-mgmt-instance-index-response.json"/>
+ <para xmlns="http://docbook.org/ns/docbook">By default, all instances (both deleted and not deleted) are displayed.
+ Use the <code>deleted</code> query parameter to list only the deleted or not deleted instances.</para>
</doc>
</representation>
</response>
Please sign in to comment.
Something went wrong with that request. Please try again.