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
This commit is contained in:
Nikhil Manchanda
committed by
Mike Asthalter
Mike Asthalter
parent
8c12474c23
commit
e434448adb
15
apidocs/includewars.xml
Normal file
15
apidocs/includewars.xml
Normal file
@@ -0,0 +1,15 @@
|
||||
<assembly>
|
||||
<id>includewars</id>
|
||||
<formats>
|
||||
<format>jar</format>
|
||||
</formats>
|
||||
<includeBaseDirectory>false</includeBaseDirectory>
|
||||
<fileSets>
|
||||
<fileSet>
|
||||
<directory>${project.basedir}/target/docbkx/webhelp</directory>
|
||||
<includes>
|
||||
<include>**.war</include>
|
||||
</includes>
|
||||
</fileSet>
|
||||
</fileSets>
|
||||
</assembly>
|
||||
170
apidocs/pom.xml
Normal file
170
apidocs/pom.xml
Normal file
@@ -0,0 +1,170 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<groupId>com.rackspace.cloud.dbaas</groupId>
|
||||
<artifactId>dbaas-docs</artifactId>
|
||||
<version>1.0.0-SNAPSHOT</version>
|
||||
<name>Database Public API Spec</name>
|
||||
<packaging>jar</packaging>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>net.sourceforge.saxon</groupId>
|
||||
<artifactId>saxon</artifactId>
|
||||
<version>9.1.0.8</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.rackspace.cloud.api</groupId>
|
||||
<artifactId>wadl-tools</artifactId>
|
||||
<version>1.0.9</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>com.rackspace.cloud.api</groupId>
|
||||
<artifactId>clouddocs-maven-plugin</artifactId>
|
||||
<!-- this <version> relates only to the *plugin* used for document formatting -->
|
||||
<!-- the version of the *API* that is the subject of the document is indicated within each document -->
|
||||
<version>1.7.2-SNAPSHOT</version>
|
||||
<executions>
|
||||
|
||||
<execution>
|
||||
<id>cdb-devguide</id>
|
||||
<goals>
|
||||
<goal>generate-webhelp</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<security>reviewer</security>
|
||||
<sourceDirectory>src/resources</sourceDirectory>
|
||||
<highlightSource>false</highlightSource>
|
||||
<trimWadlUriCount>2</trimWadlUriCount>
|
||||
<!-- this is the public-facing client developer guide formerly known as PublicAPISpec.xml -->
|
||||
<!-- this document that will be published as cdb-devguide-latest.pdf at http://docs.rackspacecloud.com/api/ -->
|
||||
<enableDisqus>1</enableDisqus>
|
||||
<googleAnalyticsId>UA-23102455-4</googleAnalyticsId>
|
||||
<includes>cdb-devguide.xml</includes>
|
||||
<canonicalUrlBase>http://docs.rackspace.com/cdb/api/v1.0/cdb-devguide/content</canonicalUrlBase>
|
||||
<feedbackEmail>mike.asthalter@rackspace.com</feedbackEmail>
|
||||
</configuration>
|
||||
</execution>
|
||||
|
||||
</executions>
|
||||
<configuration>
|
||||
<socialIcons>1</socialIcons>
|
||||
<feedbackEmail>mike.asthalter@rackspace.com</feedbackEmail>
|
||||
<branding>openstack</branding>
|
||||
<!-- <failOnValidationError>false</failOnValidationError> -->
|
||||
</configuration>
|
||||
</plugin>
|
||||
<!-- Unpack the wadl normalization xslts -->
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-dependency-plugin</artifactId>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>unpack-shared-resources</id>
|
||||
<goals>
|
||||
<goal>unpack-dependencies</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<outputDirectory>${project.build.directory}/generated-resources</outputDirectory>
|
||||
<includeGroupIds>com.rackspace.cloud.api</includeGroupIds>
|
||||
<includeArtifactIds>wadl-tools</includeArtifactIds>
|
||||
<excludeTransitive>true</excludeTransitive>
|
||||
<includes>**/xsl/*.xsl</includes>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<!-- Normalize the dbaas wadl -->
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-antrun-plugin</artifactId>
|
||||
<version>1.5</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>ant</id>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<target>
|
||||
<copy todir="${project.build.directory}/generated-resources/normalized/api/v1.0">
|
||||
<fileset dir="src/resources">
|
||||
<include name="xslts/**"/>
|
||||
</fileset>
|
||||
<fileset dir="src/resources">
|
||||
<include name="samples/**"/>
|
||||
</fileset>
|
||||
</copy>
|
||||
<copy file="../xsd/dbaas.xsd" tofile="${project.build.directory}/generated-resources/normalized/api/v1.0/xsd/cdb.xsd"/>
|
||||
<copy file="../xsd/dbaas.xsd" tofile="${project.build.directory}/generated-resources/normalized/api/v1.0/cdb.xsd"/>
|
||||
<copy file="src/resources/bookinfo.xml" tofile="${project.build.directory}/generated-resources/normalized/bookinfo.xml"/>
|
||||
<java
|
||||
jar="${net.sourceforge.saxon:saxon:jar}"
|
||||
fork="true">
|
||||
<arg value="-u"/>
|
||||
<arg value="-s:../xsd/dbaas.wadl"/>
|
||||
<arg value="-xsl:${project.build.directory}/generated-resources/xsl/normalizeWadl.xsl"/>
|
||||
<arg value="-o:${project.build.directory}/generated-resources/normalized/api/v1.0/cdb.wadl"/>
|
||||
<arg value="flattenXsds=false"/>
|
||||
</java>
|
||||
<replaceregexp file="${project.build.directory}/generated-resources/normalized/api/v1.0/cdb.wadl"
|
||||
match="file:/.*/xsd/dbaas.xsd"
|
||||
replace="xsd/cdb.xsd"/>
|
||||
<war destfile="${project.build.directory}/docbkx/webhelp/cdb-wadls.war" needxmlfile="false">
|
||||
<fileset dir="${project.build.directory}/generated-resources/normalized"/>
|
||||
</war>
|
||||
</target>
|
||||
</configuration>
|
||||
<goals>
|
||||
<goal>run</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-assembly-plugin</artifactId>
|
||||
<version>2.3</version>
|
||||
<configuration>
|
||||
<descriptors>
|
||||
<descriptor>includewars.xml</descriptor>
|
||||
</descriptors>
|
||||
</configuration>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>assembly</id>
|
||||
<goals>
|
||||
<goal>single</goal>
|
||||
</goals>
|
||||
<phase>package</phase>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
<profiles>
|
||||
<profile>
|
||||
<id>Rackspace Research Repositories</id>
|
||||
<activation>
|
||||
<activeByDefault>true</activeByDefault>
|
||||
</activation>
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>rackspace-research</id>
|
||||
<name>Rackspace Research Repository</name>
|
||||
<url>http://maven.research.rackspacecloud.com/content/groups/public/</url>
|
||||
</repository>
|
||||
</repositories>
|
||||
<pluginRepositories>
|
||||
<pluginRepository>
|
||||
<id>rackspace-research</id>
|
||||
<name>Rackspace Research Repository</name>
|
||||
<url>http://maven.research.rackspacecloud.com/content/groups/public/</url>
|
||||
</pluginRepository>
|
||||
</pluginRepositories>
|
||||
</profile>
|
||||
</profiles>
|
||||
</project>
|
||||
6
apidocs/replacements.config
Normal file
6
apidocs/replacements.config
Normal file
@@ -0,0 +1,6 @@
|
||||
XPATH=//text()
|
||||
accountId->tenantId
|
||||
accountID->tenantID
|
||||
account ID->tenant ID
|
||||
ord.databases.api.rackspacecloud.com->openstack.example.com
|
||||
.*Repose.*\n->
|
||||
24
apidocs/src/resources/bookinfo.xml
Normal file
24
apidocs/src/resources/bookinfo.xml
Normal file
@@ -0,0 +1,24 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<products xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<docname>CDB Wadl</docname>
|
||||
<productname>CDB</productname>
|
||||
<webappname>cdb-wadls</webappname>
|
||||
<pominfo>
|
||||
<groupid>com.rackspace.cloud.apidocs</groupid>
|
||||
<artifactid>cdb-wadls</artifactid>
|
||||
<version>1.0.0-SNAPSHOT</version>
|
||||
<name>CDB Wadl</name>
|
||||
</pominfo>
|
||||
<emails>
|
||||
<email>
|
||||
<name>CDT Publication Events</name>
|
||||
<to>cdt-publication-events@lists.rackspace.com</to>
|
||||
<from>clouddoctoolsteam@lists.rackspace.com</from>
|
||||
</email>
|
||||
<email>
|
||||
<name>CDB wadl publication event</name>
|
||||
<to>mike.asthalter@rackspace.com</to>
|
||||
<from>clouddoctoolsteam@lists.rackspace.com</from>
|
||||
</email>
|
||||
</emails>
|
||||
</products>
|
||||
913
apidocs/src/resources/cdb-devguide.xml
Normal file
913
apidocs/src/resources/cdb-devguide.xml
Normal file
@@ -0,0 +1,913 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE book [
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
|
||||
<!-- changing authentication endpoints; define entities for US & UK rather than maintaining in text -->
|
||||
<!ENTITY ENDPOINT-US "https://identity.api.rackspacecloud.com/v1.1/">
|
||||
<!ENTITY ENDPOINT-UK "https://lon.identity.api.rackspacecloud.com/v1.1/">
|
||||
<!ENTITY ENDPOINT-US-20 "https://identity.api.rackspacecloud.com/v2.0/">
|
||||
<!ENTITY ENDPOINT-UK-20 "https://lon.identity.api.rackspacecloud.com/v2.0/">
|
||||
|
||||
<!ENTITY CHECK '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
|
||||
<imageobject>
|
||||
<imagedata fileref="img/Check_mark_23x20_02.svg"
|
||||
format="SVG" scale="60"/>
|
||||
</imageobject>
|
||||
</inlinemediaobject>'>
|
||||
|
||||
<!ENTITY ARROW '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
|
||||
<imageobject>
|
||||
<imagedata fileref="img/Arrow_east.svg"
|
||||
format="SVG" scale="60"/>
|
||||
</imageobject>
|
||||
</inlinemediaobject>'>
|
||||
]>
|
||||
<book xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:svg="http://www.w3.org/2000/svg"
|
||||
xmlns:m="http://www.w3.org/1998/Math/MathML"
|
||||
xmlns:html="http://www.w3.org/1999/xhtml"
|
||||
xml:id="cdb-devguide"
|
||||
version="5.0">
|
||||
|
||||
<?rax title.font.size="35px" subtitle.font.size="20px"?>
|
||||
<title>OpenStack Cloud Databases Developer Guide</title>
|
||||
<titleabbrev>OpenStack Cloud Databases Developer
|
||||
Guide</titleabbrev>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname/>
|
||||
<surname/>
|
||||
</personname>
|
||||
<affiliation>
|
||||
<orgname>OpenStack LLC</orgname>
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2010</year>
|
||||
<year>2011</year>
|
||||
<year>2012</year>
|
||||
<year>2013</year>
|
||||
<holder>OpenStack LLC</holder>
|
||||
</copyright>
|
||||
<releaseinfo>API v1.0</releaseinfo>
|
||||
<productname>OpenStack Cloud Databases</productname>
|
||||
<pubdate>2013-05-02</pubdate>
|
||||
<legalnotice role="apache2">
|
||||
<annotation>
|
||||
<remark>Copyright details are filled in by the template.</remark>
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
<abstract>
|
||||
<para>This document is intended for software developers
|
||||
interested in developing applications using the
|
||||
OpenStack Cloud Databases Application Programming
|
||||
Interface (<abbrev>API</abbrev>). </para>
|
||||
</abstract>
|
||||
|
||||
<revhistory>
|
||||
<revision>
|
||||
<date>2013-05-02</date>
|
||||
<revdescription>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>This document is for the initial
|
||||
OpenStack review.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</revdescription>
|
||||
</revision>
|
||||
</revhistory>
|
||||
|
||||
<cover>
|
||||
<para>this is a placeholder for the front cover</para>
|
||||
</cover>
|
||||
<cover>
|
||||
<para>this is a placeholder for the back cover</para>
|
||||
</cover>
|
||||
<raxm:metadata xmlns:raxm="http://docs.rackspace.com/api/metadata">
|
||||
<raxm:displayname>API Developer Guide</raxm:displayname>
|
||||
<raxm:product version="v1.0">cdb</raxm:product>
|
||||
<raxm:priority>20</raxm:priority>
|
||||
</raxm:metadata>
|
||||
</info>
|
||||
<chapter xml:id="overview">
|
||||
<title>Overview</title>
|
||||
<para>OpenStack Cloud Databases is an OpenStack-based MySQL
|
||||
relational database service that allows customers to
|
||||
easily provision database instances of varying virtual
|
||||
resource sizes without the need to maintain and/or update
|
||||
MySQL. Interactions with Cloud Databases occur
|
||||
programmatically via the Cloud Databases API as described
|
||||
in this developer guide.</para>
|
||||
<note>
|
||||
<para>OpenStack recommends that Cloud Databases users back
|
||||
up their data using <emphasis role="bold"
|
||||
>mysqldump</emphasis> until backups are supported
|
||||
in Cloud Databases.</para>
|
||||
</note>
|
||||
<para>The following figure shows an
|
||||
overview of Cloud Databases Infrastructure: <informalfigure>
|
||||
<mediaobject>
|
||||
<imageobject>
|
||||
<imagedata
|
||||
fileref="images/Cloud_DB_Infographic-1.svg"
|
||||
contentwidth="6in"/>
|
||||
</imageobject>
|
||||
</mediaobject>
|
||||
</informalfigure>
|
||||
</para>
|
||||
<remark security="reviewer">Reviewer: need to edit graphic
|
||||
above so it says "The Cloud" rather than "The Rackspace
|
||||
Cloud".</remark>
|
||||
<?hard-pagebreak?>
|
||||
<section xml:id="Intended_Audience-d1e122">
|
||||
<title>Intended Audience</title>
|
||||
<para> This Guide is intended to assist software
|
||||
developers who want to develop applications using the
|
||||
Cloud Databases API. It assumes the reader has a
|
||||
general understanding of databases and is familiar
|
||||
with: </para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>ReSTful web services</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>HTTP/1.1 conventions</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>JSON and/or XML data serialization
|
||||
formats</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
<?hard-pagebreak?>
|
||||
<section xml:id="Document_Change_History-d1e166">
|
||||
<title>Document Change History</title>
|
||||
<para>This version of the Developer Guide replaces and
|
||||
obsoletes all previous versions. The most recent
|
||||
changes are described in the table below:</para>
|
||||
<?rax revhistory?>
|
||||
</section>
|
||||
<section xml:id="Additional_Resources-d1e532">
|
||||
<title>Additional Resources</title>
|
||||
<para>You can download the most current versions of this
|
||||
and other API-related documents from <link
|
||||
xlink:href="http://docs.openstack.org/"
|
||||
>http://docs.openstack.org/</link>. </para>
|
||||
<para>We welcome feedback, comments, and bug reports at
|
||||
<link xlink:href="https://bugs.launchpad.net/reddwarf"
|
||||
>https://bugs.launchpad.net/reddwarf</link>. </para>
|
||||
<para>This API uses standard HTTP 1.1 response codes as
|
||||
documented at: <link
|
||||
xlink:href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
|
||||
>http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html</link>. </para>
|
||||
</section>
|
||||
<?hard-pagebreak?>
|
||||
</chapter>
|
||||
|
||||
<chapter xml:id="Concepts-d1e563">
|
||||
<title>Concepts</title>
|
||||
<?dbhtml stop-chunking?>
|
||||
<para> To use the Cloud Databases API effectively, you should
|
||||
understand several key concepts: </para>
|
||||
<section xml:id="DatabaseInstance-d1e588">
|
||||
<title>Database Instance</title>
|
||||
<para>A database instance is an isolated MySQL instance in
|
||||
a single tenant environment on a shared physical host
|
||||
machine.</para>
|
||||
<remark security="writeronly">Writer: once we support
|
||||
MSSQL, we need to describe here what is used for MSSQL
|
||||
in place of database instance.</remark>
|
||||
</section>
|
||||
<section xml:id="Database">
|
||||
<title>Database</title>
|
||||
<para>A MySQL database within a database instance.</para>
|
||||
<remark security="writeronly">Writer: once we support
|
||||
MSSQL, we need to modify the wording here, such as:
|
||||
The actual database, whether it is in MySQL or
|
||||
MSSQL.</remark>
|
||||
</section>
|
||||
<section xml:id="Flavor">
|
||||
<title>Flavor</title>
|
||||
<para>A flavor is an available hardware configuration for
|
||||
a database instance. Each flavor has a unique
|
||||
combination of memory capacity and priority for CPU
|
||||
time.</para>
|
||||
</section>
|
||||
<section xml:id="Volume">
|
||||
<title>Volume</title>
|
||||
<para>A volume is user-specified storage that contains the
|
||||
MySQL data directory. Volumes are automatically
|
||||
provisioned on shared Internet Small Computer System
|
||||
Interface (iSCSI) storage area networks (SAN) that
|
||||
provide for increased performance, scalability,
|
||||
availability and manageability. Applications with high
|
||||
I/O demands are performance optimized and data is
|
||||
protected through both local and network RAID-10.
|
||||
Additionally, network RAID provides synchronous
|
||||
replication of volumes with automatic failover and
|
||||
load balancing across available storage
|
||||
clusters.</para>
|
||||
</section>
|
||||
</chapter>
|
||||
<chapter xml:id="General_API_Information-d1e633">
|
||||
<title>General API Information</title>
|
||||
<para> The Cloud Databases API is implemented using a ReSTful
|
||||
web service interface. Like other cloud products, the
|
||||
Database Service shares a common token-based
|
||||
authentication system that allows seamless access between
|
||||
products and services. </para>
|
||||
<note>
|
||||
<para> All requests to authenticate against and operate the service are performed using
|
||||
SSL over HTTP (HTTPS) on TCP port 443. </para>
|
||||
</note>
|
||||
<section xml:id="Authentication-d1e647">
|
||||
<title>Authentication</title>
|
||||
<para> Each HTTP request against the Cloud Database
|
||||
service requires the inclusion of specific
|
||||
authentication credentials. A single deployment may
|
||||
support multiple authentication schemes (OAuth, Basic
|
||||
Auth, Token). The authentication scheme used is
|
||||
determined by the provider of the Cloud Database
|
||||
service. Please contact your provider to determine the
|
||||
best way to authenticate against this API.</para>
|
||||
<note>
|
||||
<para>Some authentication schemes may require that the
|
||||
API operate using SSL over HTTP (HTTPS).</para>
|
||||
</note>
|
||||
</section>
|
||||
<section xml:id="DB_service_versions">
|
||||
<title>Cloud Databases Service Versions</title>
|
||||
<para> The Cloud Databases version defines the contract
|
||||
and build information for the API. </para>
|
||||
<section xml:id="Contract_Version-d1e825">
|
||||
<title>Contract Version</title>
|
||||
<para> The contract version denotes the data model and
|
||||
behavior that the API supports. The requested
|
||||
contract version is included in all request URLs.
|
||||
Different contract versions of the API may be
|
||||
available at any given time and are not guaranteed
|
||||
to be compatible with one another.
|
||||
</para>
|
||||
<example>
|
||||
<title>Example Request URL (contract version
|
||||
in <emphasis role="strong"
|
||||
>bold</emphasis>)</title>
|
||||
<programlisting>https://ord.databases.api.rackspacecloud.com/<emphasis role="strong">v1.0</emphasis>/1234</programlisting>
|
||||
</example>
|
||||
<note>
|
||||
<para>This document pertains to contract
|
||||
version 1.0.</para>
|
||||
</note>
|
||||
|
||||
</section>
|
||||
<section xml:id="API_Version_Headers-d1e855">
|
||||
<title>API Version</title>
|
||||
<para>The API List Versions call is available to show
|
||||
the current API version as well as information
|
||||
about all versions of the API. Refer to <xref
|
||||
linkend="API_Versions"/> for details.</para>
|
||||
</section>
|
||||
</section>
|
||||
<?hard-pagebreak?>
|
||||
<section xml:id="datetimeformat">
|
||||
<title>Date/Time Format</title>
|
||||
<para> The Database Service uses an ISO-8601 compliant
|
||||
date format for the display and consumption of
|
||||
date/time values. </para>
|
||||
<para>The system timezone is in UTC. MySQL converts TIMESTAMP values from
|
||||
the current time zone to UTC for storage, and back
|
||||
from UTC to the current time zone for retrieval.
|
||||
This does not occur for other types, such as DATETIME.
|
||||
</para>
|
||||
<example>
|
||||
<title>DB Service Date/Time Format</title>
|
||||
<programlisting>yyyy-MM-dd'T'HH:mm:ss.SSSZ</programlisting>
|
||||
<para>See the table below for a description of the date/time format codes.</para>
|
||||
<para>May 19th, 2011 at 8:07:08 AM, GMT-5 would have the following
|
||||
format:</para>
|
||||
<programlisting>2011-05-19T08:07:08-05:00</programlisting>
|
||||
</example>
|
||||
<table rules="all">
|
||||
<caption>Explanation of Date/Time Format Codes</caption>
|
||||
<thead>
|
||||
<tr>
|
||||
<td>Code</td>
|
||||
<td>Description</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>yyyy</td>
|
||||
<td>Four digit year</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>MM</td>
|
||||
<td>Two digit month</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>dd</td>
|
||||
<td>Two digit day of month</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>T</td>
|
||||
<td>Separator for date/time</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>HH</td>
|
||||
<td>Two digit hour of day (00-23)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>mm</td>
|
||||
<td>Two digit minutes of hour</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ss</td>
|
||||
<td>Two digit seconds of the minute</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>SSS</td>
|
||||
<td>Three digit milliseconds of the second</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Z</td>
|
||||
<td>RFC-822 timezone</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</section>
|
||||
<section xml:id="pagination">
|
||||
<title>Pagination</title>
|
||||
<para>To reduce load on the service, list operations
|
||||
return a maximum of 20 items at a time. This is
|
||||
referred to as <emphasis>pagination</emphasis>. Cloud
|
||||
Databases has separate paging limits for instances,
|
||||
databases, and users, which are currently all set to
|
||||
20. If a request supplies no limit or one that exceeds
|
||||
the configured default limit, the default is used
|
||||
instead.</para>
|
||||
<para> Pagination provides the ability to limit the size
|
||||
of the returned data as well as retrieve a specified
|
||||
subset of a large data set. Pagination has two key
|
||||
concepts: limit and marker. <emphasis>Limit</emphasis>
|
||||
is the restriction on the maximum number of items for
|
||||
that type that can be returned.
|
||||
<emphasis>Marker</emphasis> is the ID of the last
|
||||
item in the previous list returned. The ID is the UUID
|
||||
in the case of instances, and the name in the case of
|
||||
databases and users. For example, a query could
|
||||
request the next 10 instances after the instance
|
||||
"1234" as follows:
|
||||
<code>?limit=10&marker=1234</code>. Items are
|
||||
displayed sorted by ID. </para>
|
||||
<para>Pagination applies only to the calls listed in the
|
||||
following table: </para>
|
||||
<informaltable rules="all">
|
||||
<thead>
|
||||
<tr align="center">
|
||||
<td colspan="1">Verb</td>
|
||||
<td colspan="2">URI</td>
|
||||
<td colspan="3">Description</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td colspan="1">&GET;</td>
|
||||
<td colspan="2">/instances/</td>
|
||||
<td colspan="3">Lists the status and
|
||||
information for all database
|
||||
instances.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">&GET;</td>
|
||||
<td colspan="2">
|
||||
/instances/{instanceId}/databases </td>
|
||||
<td colspan="3">Lists databases for the
|
||||
specified instance.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">&GET;</td>
|
||||
<td colspan="2"> /instances/{instanceId}/users </td>
|
||||
<td colspan="3">Lists the users in the
|
||||
specified database instance.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</informaltable>
|
||||
<para>If the content returned by a call is paginated, the
|
||||
response includes a structured link much like an
|
||||
instance item's links, with the basic structure
|
||||
<code>{"href": "<url>", "rel": "next"}</code>.
|
||||
Any response that is truncated by pagination will have
|
||||
a <emphasis>next</emphasis> link, which points to the
|
||||
next item in the collection. If there are no more
|
||||
items, no <emphasis>next</emphasis> link is
|
||||
returned.</para>
|
||||
<para>See the examples of paged List Instances calls that
|
||||
follow.</para>
|
||||
<remark security="reviewer">Reviewer: Need new examples that show OpenStack
|
||||
host.</remark>
|
||||
<example>
|
||||
<title>List Instances Paged Request: XML</title>
|
||||
<?dbfo keep-together="always"?>
|
||||
<programlisting language="xml">
|
||||
<xi:include href="samples/db-instances-index-pagination-request.xml" parse="text"/>
|
||||
</programlisting>
|
||||
</example>
|
||||
<example>
|
||||
<title>List Instances Paged Request: JSON</title>
|
||||
<?dbfo keep-together="always"?>
|
||||
<programlisting language="json">
|
||||
<xi:include href="samples/db-instances-index-pagination-request.json" parse="text"/>
|
||||
</programlisting>
|
||||
</example>
|
||||
<para>Notice that the paged request examples above set the
|
||||
limit to 2 (<code>?limit=2</code>), so the responses
|
||||
that follow each show 2 instances and return a
|
||||
<emphasis>marker</emphasis> set to the UUID of the
|
||||
last item in the returned list
|
||||
(<code>?marker=4137d6a4-03b7-4b66-b0ef-8c7c35c470d3</code>).
|
||||
Also a link is provided to retrieve the next 2 results
|
||||
(<code>limit=2</code>) in the link element
|
||||
identified by the attribute <code>rel="next"</code>
|
||||
(XML) or <code>"rel":"next"</code> (JSON):</para>
|
||||
<example>
|
||||
<title>List Instances Paged Response: XML</title>
|
||||
<?dbfo keep-together="always"?>
|
||||
<programlisting language="xml">
|
||||
<xi:include href="samples/db-instances-index-pagination-response.xml" parse="text"/>
|
||||
</programlisting>
|
||||
</example>
|
||||
<example>
|
||||
<title>List Instances Paged Response: JSON</title>
|
||||
<?dbfo keep-together="always"?>
|
||||
<programlisting language="json">
|
||||
<xi:include href="samples/db-instances-index-pagination-response.json" parse="text"/>
|
||||
</programlisting>
|
||||
</example>
|
||||
</section>
|
||||
<section xml:id="DB_faults">
|
||||
<title>Faults</title>
|
||||
<para> When an error occurs, the Database Service returns
|
||||
a fault object containing an HTTP error response code
|
||||
that denotes the type of error. In the body of the
|
||||
response, the system will return additional
|
||||
information about the fault. </para>
|
||||
<para>The following table lists possible fault types with their associated error codes
|
||||
and descriptions.</para>
|
||||
<informaltable rules="all">
|
||||
<thead>
|
||||
<tr align="center">
|
||||
<td colspan="2">Fault Type</td>
|
||||
<td colspan="1">Associated Error Code</td>
|
||||
<td colspan="3">Description</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td colspan="2"><code>badRequest</code></td>
|
||||
<td colspan="1">400</td>
|
||||
<td colspan="3">There was one or more errors in the user request.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2"><code>unauthorized</code></td>
|
||||
<td colspan="1">401</td>
|
||||
<td colspan="3">The supplied token is not authorized to access the resources, either it's expired or invalid.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2"><code>forbidden</code></td>
|
||||
<td colspan="1">403</td>
|
||||
<td colspan="3">Access to the requested
|
||||
resource was denied.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2"><code>itemNotFound</code></td>
|
||||
<td colspan="1">404</td>
|
||||
<td colspan="3">The back-end services did not
|
||||
find anything matching the
|
||||
Request-URI.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2"><code>badMethod</code></td>
|
||||
<td colspan="1">405</td>
|
||||
<td colspan="3">The request method is not allowed for this resource.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2"><code>overLimit</code></td>
|
||||
<td colspan="1">413</td>
|
||||
<td colspan="3">Either the number of entities in the request is larger than
|
||||
allowed limits, or the user has exceeded allowable request rate limits.
|
||||
See the <code>details</code> element for more specifics. Contact support
|
||||
if you think you need higher request rate limits.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2"><code>badMediaType</code></td>
|
||||
<td colspan="1">415</td>
|
||||
<td colspan="3">The requested content type is not supported by this service.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2"
|
||||
><code>unprocessableEntity</code></td>
|
||||
<td colspan="1">422</td>
|
||||
<td colspan="3">The requested resource could
|
||||
not be processed on at the moment.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2"
|
||||
><code>instanceFault</code></td>
|
||||
<td colspan="1">500</td>
|
||||
<td colspan="3">This is a generic server error and the message contains the reason for the error. This error could wrap several error messages and is a catch all.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2"
|
||||
><code>notImplemented</code></td>
|
||||
<td colspan="1">501</td>
|
||||
<td colspan="3">The requested method or resource is not implemented.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2"
|
||||
><code>serviceUnavailable</code></td>
|
||||
<td colspan="1">503</td>
|
||||
<td colspan="3">The Database Service is not
|
||||
available.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</informaltable>
|
||||
<para>The following two <code>instanceFault</code>
|
||||
examples show errors when the server has erred or
|
||||
cannot perform the requested operation:</para>
|
||||
|
||||
<example>
|
||||
<title>Example instanceFault Response: XML</title>
|
||||
<?dbfo keep-together="always"?>
|
||||
<programlisting language="xml">
|
||||
<xi:include href="samples/db-faults-instanceFault.xml" parse="text"/>
|
||||
</programlisting>
|
||||
</example>
|
||||
<example>
|
||||
<title>Example Fault Response: JSON</title>
|
||||
<?dbfo keep-together="always"?>
|
||||
<programlisting language="json">
|
||||
<xi:include href="samples/db-faults-instanceFault.json" parse="text"/>
|
||||
</programlisting>
|
||||
</example>
|
||||
<para> The error code (<code>code</code>) is returned in the body of the response for
|
||||
convenience. The <code>message</code> element returns a human-readable message that
|
||||
is appropriate for display to the end user. The <code>details</code> element is
|
||||
optional and may contain information that is useful for tracking down an error, such
|
||||
as a stack trace. The <code>details</code> element may or may not be appropriate for
|
||||
display to an end user, depending on the role and experience of the end user.</para>
|
||||
<para>The fault's root element (for example,
|
||||
<code>instanceFault</code>) may change depending
|
||||
on the type of error. </para>
|
||||
<para><?rax-fo keep-with-next?>The following two <code>badRequest</code> examples
|
||||
show errors when the volume size is invalid:</para>
|
||||
<example>
|
||||
<title>Example badRequest Fault on Volume Size Errors:
|
||||
XML</title>
|
||||
<?dbfo keep-together="always"?>
|
||||
<programlisting language="xml">
|
||||
<xi:include href="samples/db-faults-badRequest.xml" parse="text"/>
|
||||
</programlisting>
|
||||
</example>
|
||||
<example>
|
||||
<title>Example badRequest Fault on Volume Size Errors:
|
||||
JSON</title>
|
||||
<?dbfo keep-together="always"?>
|
||||
<programlisting language="json">
|
||||
<xi:include href="samples/db-faults-badRequest.json" parse="text"/>
|
||||
</programlisting>
|
||||
</example>
|
||||
<para> The next two examples show
|
||||
<code>itemNotFound</code> errors:</para>
|
||||
<example>
|
||||
<title>Example itemNotFound Fault: XML</title>
|
||||
<?dbfo keep-together="always"?>
|
||||
<programlisting language="xml">
|
||||
<xi:include href="samples/db-faults-itemNotFound.xml" parse="text"/>
|
||||
</programlisting>
|
||||
</example>
|
||||
<example>
|
||||
<title>Example itemNotFound Fault: JSON</title>
|
||||
<?dbfo keep-together="always"?>
|
||||
<programlisting language="json">
|
||||
<xi:include href="samples/db-faults-itemNotFound.json" parse="text"/>
|
||||
</programlisting>
|
||||
</example>
|
||||
<section xml:id="synchro_vs_async_faults">
|
||||
<title>Synchronous Versus Asynchronous
|
||||
Faults<?sbr?></title>
|
||||
<para><emphasis>Synchronous</emphasis> faults occur at
|
||||
request time. When a synchronous fault occurs, the
|
||||
fault contains an HTTP error response code, a
|
||||
human readable message, and optional details about
|
||||
the error. The following Database API calls are
|
||||
synchronous and may produce synchronous faults:<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>List Users</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>List Instances</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>List Instance Details by ID</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>List Databases</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Enable Root User</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>List Root-Enabled Status</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>List Flavors</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>List Versions</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>List Version Details</para>
|
||||
</listitem>
|
||||
</itemizedlist></para>
|
||||
<para><emphasis>Asynchronous</emphasis> faults occur
|
||||
in the background while an instance, database, or
|
||||
user is being built or an instance is executing an
|
||||
action. When an asynchronous fault occurs, the
|
||||
system places the instance, database, or user in
|
||||
an ERROR state and embeds the fault in the
|
||||
offending instance, database, or user. When an
|
||||
asynchronous fault occurs, the fault contains an
|
||||
HTTP error response code, a human readable
|
||||
message, and optional details about the error. The
|
||||
following Database API calls are asynchronous and
|
||||
may produce asynchronous faults:<itemizedlist
|
||||
spacing="compact">
|
||||
<listitem>
|
||||
<para>Create Instance</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Delete Instance</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Create Database</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Delete Database</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Create User</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Delete User</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Resize Volume</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Resize Instance</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Restart Instance</para>
|
||||
</listitem>
|
||||
</itemizedlist><note>
|
||||
<para>Note that an asynchronous operation, if
|
||||
it fails, may not give the user an error,
|
||||
and the operation can error out without a
|
||||
failure notification.</para>
|
||||
</note></para>
|
||||
</section>
|
||||
</section>
|
||||
<section xml:id="database_instance_status">
|
||||
<title>Database Instance Status</title>
|
||||
<para><?rax-fo keep-with-next?>When making an API call to create, list, or delete
|
||||
database instance(s), the following database instance
|
||||
status values are possible:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>BUILD – The database instance is being provisioned.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>REBOOT – The database instance is
|
||||
rebooting.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>ACTIVE – The database instance is
|
||||
online and available to take requests.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>BLOCKED – The database instance is
|
||||
unresponsive at the moment.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>RESIZE – The database instance is being
|
||||
resized at the moment.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>SHUTDOWN – The database instance is
|
||||
terminating services. Also, SHUTDOWN is
|
||||
returned if for any reason the MySQL instance
|
||||
is shut down but not the actual server. </para>
|
||||
<para>
|
||||
<note>
|
||||
<para>If MySQL has crashed (causing the
|
||||
SHUTDOWN status), please call support
|
||||
for assistance.</para>
|
||||
</note>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>ERROR – The last operation for the
|
||||
database instance failed due to an
|
||||
error.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
</chapter>
|
||||
|
||||
<chapter xml:id="API_Operations-d1e2264"
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
role="api-reference">
|
||||
<title>API Operations</title>
|
||||
<note>
|
||||
<para>Do not use trailing slashes (/) at the end of calls
|
||||
to API operations, since this may cause the call to
|
||||
fail. For example, do not use &GET; /instances/detail/
|
||||
(with the trailing slash at the end). Rather, use
|
||||
&GET; /instances/detail instead.</para>
|
||||
</note>
|
||||
<?hard-pagebreak?>
|
||||
<section xml:id="API_Versions">
|
||||
<title>API Versions</title>
|
||||
<para>This section describes the versions that are
|
||||
supported for the Cloud Databases API.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../../../xsd/dbaas.wadl#versions">
|
||||
<wadl:method href="getVersions"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../../../xsd/dbaas.wadl#version">
|
||||
<wadl:method href="getVersionInfo" />
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
|
||||
</section>
|
||||
|
||||
<section xml:id="Database_Instances">
|
||||
<title>Database Instances</title>
|
||||
<para>This section describes the operations that are supported for database instances.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../../../xsd/dbaas.wadl#instances" >
|
||||
<wadl:method href="createInstance"/>
|
||||
<wadl:method href="getInstance"/>
|
||||
</wadl:resource>
|
||||
|
||||
<wadl:resource href="../../../xsd/dbaas.wadl#instanceId">
|
||||
<wadl:method href="getInstanceById"/>
|
||||
<wadl:method href="deleteInstance"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../../../xsd/dbaas.wadl#root">
|
||||
<wadl:method href="createRoot"/>
|
||||
<wadl:method href="isRootEnabled"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
|
||||
<section xml:id="Database_Instances_Actions">
|
||||
<title>Database Instance Actions</title>
|
||||
<para>This section describes the actions that are supported for database instances.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../../../xsd/dbaas.wadl#instanceAction" >
|
||||
<wadl:method href="restartInstance"/>
|
||||
<wadl:method href="resizeInstance"/>
|
||||
<wadl:method href="resizeVolume"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
|
||||
<section xml:id="databases">
|
||||
<title>Databases</title>
|
||||
<para>This section describes the operations that are
|
||||
supported for databases.</para>
|
||||
<wadl:resources
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../../../xsd/dbaas.wadl#databases">
|
||||
<wadl:method href="createDatabase"/>
|
||||
<wadl:method href="getDatabases"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../../../xsd/dbaas.wadl#databaseName">
|
||||
<wadl:method href="deleteDatabase"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
|
||||
<section xml:id="user_management">
|
||||
<title>Users</title>
|
||||
<para>This section describes the operations that are
|
||||
supported for managing database users.</para>
|
||||
<para>In this section, "user has access to a database"
|
||||
means that the user has full create, read, update, and
|
||||
delete access to the given database. In other words,
|
||||
on a cloud database instance, a user named USER and a
|
||||
database named DATABASE exist, and within MySQL, a
|
||||
GRANT ALL ON DATABASE.* TO USER has been issued on the
|
||||
instance. </para>
|
||||
<warning>
|
||||
<para>There is a bug in a python library that
|
||||
development is using that may cause incorrect user
|
||||
deletions to occur if a period (.) is used in the
|
||||
user name. In this case, the user name is
|
||||
truncated to remove the portion of the name from
|
||||
the period to the end, leaving only the portion
|
||||
from the beginning up to the period. For example,
|
||||
for a user named "my.userA", the bug would
|
||||
truncate the user name to "my", and if the user
|
||||
"my" exists, that user will be incorrectly
|
||||
deleted. To avoid the problem, do not use periods
|
||||
in user names.</para>
|
||||
</warning>
|
||||
<wadl:resources
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../../../xsd/dbaas.wadl#users">
|
||||
<wadl:method href="createUser"/>
|
||||
<wadl:method href="getUsers"/>
|
||||
<wadl:method href="changePass"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../../../xsd/dbaas.wadl#userId">
|
||||
<wadl:method href="listUser"/>
|
||||
<wadl:method href="deleteUser"/>
|
||||
<wadl:resource
|
||||
href="../../../xsd/dbaas.wadl#database">
|
||||
<wadl:method href="getUserAccess"/>
|
||||
<wadl:method href="grantUserAccess"/>
|
||||
<wadl:resource
|
||||
href="../../../xsd/dbaas.wadl#dbName">
|
||||
<wadl:method href="revokeUserAccess"/>
|
||||
</wadl:resource>
|
||||
</wadl:resource>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
|
||||
<section xml:id="flavors">
|
||||
<title>Flavors</title>
|
||||
<para>This section describes the operations that are
|
||||
supported for flavors.</para>
|
||||
<wadl:resources
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../../../xsd/dbaas.wadl#flavors">
|
||||
<wadl:method href="getFlavors"/>
|
||||
</wadl:resource>
|
||||
|
||||
<wadl:resource href="../../../xsd/dbaas.wadl#flavorId">
|
||||
<wadl:method href="getFlavorById"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
</chapter>
|
||||
<glossary>
|
||||
<title>Glossary</title>
|
||||
<glossentry xml:id="Database-d1e017">
|
||||
<glossterm>database</glossterm>
|
||||
<glossdef>
|
||||
<para>A MySQL database within a database instance.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
<glossentry xml:id="Database-Instance-d1e016">
|
||||
<glossterm>database instance</glossterm>
|
||||
<glossdef>
|
||||
<para>A database instance is an isolated MySQL instance in a single tenant environment on a
|
||||
shared physical host machine. Also referred to as instance.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
<glossentry xml:id="Flavor-d1e018">
|
||||
<glossterm>flavor</glossterm>
|
||||
<glossdef>
|
||||
<para>A flavor is an available hardware configuration for a database instance. Each flavor has a unique combination of memory capacity and priority for CPU time.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
<glossentry xml:id="Volume-d1e019">
|
||||
<glossterm>volume</glossterm>
|
||||
<glossdef>
|
||||
<para>A volume is user-specified storage that contains the MySQL data directory.
|
||||
Volumes are automatically provisioned on shared Internet Small Computer System Interface (iSCSI)
|
||||
storage area networks (SAN) that provide for increased performance, scalability, availability
|
||||
and manageability. Applications with high I/O demands are performance optimized and data is
|
||||
protected through both local and network RAID-10. Additionally, network RAID provides synchronous
|
||||
replication of volumes with automatic failover and load balancing across available storage clusters.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossary>
|
||||
</book>
|
||||
BIN
apidocs/src/resources/images/Choose_CS_Image.png
Normal file
BIN
apidocs/src/resources/images/Choose_CS_Image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 83 KiB |
BIN
apidocs/src/resources/images/Choose_CS_Image_CCP.png
Normal file
BIN
apidocs/src/resources/images/Choose_CS_Image_CCP.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
BIN
apidocs/src/resources/images/Choose_Image_CCP.png
Normal file
BIN
apidocs/src/resources/images/Choose_Image_CCP.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
BIN
apidocs/src/resources/images/Choose_Image_CCP.tiff
Normal file
BIN
apidocs/src/resources/images/Choose_Image_CCP.tiff
Normal file
Binary file not shown.
BIN
apidocs/src/resources/images/Cloud_DB_Infographic-1.png
Normal file
BIN
apidocs/src/resources/images/Cloud_DB_Infographic-1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 65 KiB |
4533
apidocs/src/resources/images/Cloud_DB_Infographic-1.svg
Normal file
4533
apidocs/src/resources/images/Cloud_DB_Infographic-1.svg
Normal file
File diff suppressed because it is too large
Load Diff
|
After Width: | Height: | Size: 369 KiB |
BIN
apidocs/src/resources/images/Create_CS.png
Normal file
BIN
apidocs/src/resources/images/Create_CS.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 31 KiB |
BIN
apidocs/src/resources/images/phpMyAdmin.png
Normal file
BIN
apidocs/src/resources/images/phpMyAdmin.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 252 KiB |
144
apidocs/src/resources/samples/db-auth-20.json
Normal file
144
apidocs/src/resources/samples/db-auth-20.json
Normal file
@@ -0,0 +1,144 @@
|
||||
HTTP/1.1 200 OK
|
||||
Content-Type: application/json; charset=UTF-8
|
||||
Content-Length: 477
|
||||
Date: Thu, 12 Apr 2012 18:45:13 GMT
|
||||
|
||||
{
|
||||
"access": {
|
||||
|
||||
"token": {
|
||||
"expires": "2011-12-08T22:51:02.000-06:00",
|
||||
"id": "vvvvvvvv-wwww-xxxx-yyyy-zzzzzzzzzzzz"
|
||||
},
|
||||
"user": {
|
||||
"id": "123456",
|
||||
"name": "jsmith",
|
||||
"RAX-AUTH:defaultRegion": "DFW",
|
||||
"roles": [
|
||||
{
|
||||
"description": "Admin Role.",
|
||||
"id": "identity:admin",
|
||||
"name": "identity:admin"
|
||||
},
|
||||
{
|
||||
"description": "Default Role.",
|
||||
"id": "identity:default",
|
||||
"name": "identity:default"
|
||||
}
|
||||
]
|
||||
},
|
||||
"serviceCatalog": [
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"publicURL": "https://dfw.databases.api.rackspacecloud.com/v1.0/1100111",
|
||||
"region": "DFW",
|
||||
"tenantId": "1100111"
|
||||
},
|
||||
{
|
||||
"publicURL": "https://ord.databases.api.rackspacecloud.com/v1.0/1100111",
|
||||
"region": "ORD",
|
||||
"tenantId": "1100111"
|
||||
}
|
||||
],
|
||||
"name": "cloudDatabases",
|
||||
"type": "rax:database"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"publicURL": "https://dfw.loadbalancers.api.rackspacecloud.com/v1.0/1100111",
|
||||
"region": "DFW",
|
||||
"tenantId": "1100111"
|
||||
},
|
||||
{
|
||||
"publicURL": "https://ord.loadbalancers.api.rackspacecloud.com/v1.0/1100111",
|
||||
"region": "ORD",
|
||||
"tenantId": "1100111"
|
||||
}
|
||||
],
|
||||
"name": "cloudLoadBalancers",
|
||||
"type": "rax:load-balancer"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"tenantId": "1100111",
|
||||
"region": "DFW",
|
||||
"publicURL": "https://dfw.servers.api.rackspacecloud.com/v2/1100111",
|
||||
"versionId": "2",
|
||||
"versionInfo": "https://dfw.servers.api.rackspacecloud.com/v2/",
|
||||
"versionList": "https://dfw.servers.api.rackspacecloud.com/"
|
||||
},
|
||||
{
|
||||
"tenantId": "1100111",
|
||||
"region": "ORD",
|
||||
"publicURL": "https://ord.servers.api.rackspacecloud.com/v2/1100111",
|
||||
"versionId": "2",
|
||||
"versionInfo": "https://ord.servers.api.rackspacecloud.com/v2/",
|
||||
"versionList": "https://ord.servers.api.rackspacecloud.com/"
|
||||
}
|
||||
],
|
||||
"name": "cloudServersOpenStack",
|
||||
"type": "compute"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"tenantId": "1100111",
|
||||
"publicURL": "https://servers.api.rackspacecloud.com/v1.0/1100111",
|
||||
"versionId": "1.0",
|
||||
"versionInfo": "https://servers.api.rackspacecloud.com/v1.0/",
|
||||
"versionList": "https://servers.api.rackspacecloud.com/"
|
||||
}
|
||||
],
|
||||
"name": "cloudServers",
|
||||
"type": "compute"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"tenantId": "MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee",
|
||||
"publicURL": "https://storage101.dfw1.clouddrive.com/v1/MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee",
|
||||
"internalURL": "https://snet-storage101.dfw1.clouddrive.com/v1/MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee",
|
||||
"region": "DFW"
|
||||
},
|
||||
{
|
||||
"tenantId": "MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee",
|
||||
"publicURL": "https://storage101.ord1.clouddrive.com/v1/MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee",
|
||||
"internalURL": "https://snet-storage101.ord1.clouddrive.com/v1/MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee",
|
||||
"region": "ORD"
|
||||
}
|
||||
],
|
||||
"name": "cloudFiles",
|
||||
"type": "object-store"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"tenantId": "MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee",
|
||||
"publicURL": "https://cdn1.clouddrive.com/v1/MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee",
|
||||
"region": "DFW"
|
||||
},
|
||||
{
|
||||
"tenantId": "MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee",
|
||||
"publicURL": "https://cdn2.clouddrive.com/v1/MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee",
|
||||
"region": "ORD"
|
||||
}
|
||||
],
|
||||
"name": "cloudFilesCDN",
|
||||
"type": "rax:object-cdn"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"tenantId": "1100111",
|
||||
"publicURL": "https://dns.api.rackspacecloud.com/v1.0/1100111"
|
||||
}
|
||||
],
|
||||
"name": "cloudDNS",
|
||||
"type": "rax:dns"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
74
apidocs/src/resources/samples/db-auth-20.xml
Normal file
74
apidocs/src/resources/samples/db-auth-20.xml
Normal file
@@ -0,0 +1,74 @@
|
||||
HTTP/1.1 200 OK
|
||||
Content-Type: application/xml; charset=UTF-8
|
||||
Content-Length: 477
|
||||
Date: Thu, 12 Apr 2012 18:50:20 GMT
|
||||
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
|
||||
<access xmlns:os-ksadm="http://docs.openstack.org/identity/api/ext/OS-KSADM/v1.0"
|
||||
xmlns="http://docs.openstack.org/identity/api/v2.0"
|
||||
xmlns:rax-kskey="http://docs.rackspace.com/identity/api/ext/RAX-KSKEY/v1.0"
|
||||
xmlns:rax-ksqa="http://docs.rackspace.com/identity/api/ext/RAX-KSQA/v1.0"
|
||||
xmlns:common="http://docs.openstack.org/common/api/v1.0"
|
||||
xmlns:ksgrp="http://docs.rackspace.com/identity/api/ext/RAX-KSGRP/v1.0"
|
||||
xmlns:rax-kscatalog="http://docs.openstack.org/identity/api/ext/OS-KSCATALOG/v1.0"
|
||||
xmlns:atom="http://www.w3.org/2005/Atom">
|
||||
<token id="vvvvvvvv-wwww-xxxx-yyyy-zzzzzzzzzzzz" expires="2011-12-08T22:51:02.000-06:00"/>
|
||||
<user id="123456" name="jsmith" rax-auth:defaultRegion="DFW">
|
||||
<roles>
|
||||
<role id="identity:admin" name="identity:admin" description="Admin Role."/>
|
||||
<role id="identity:default" name="identity:default" description="Default Role."/>
|
||||
</roles>
|
||||
</user>
|
||||
<serviceCatalog>
|
||||
<service type="rax:database" name="cloudDatabases">
|
||||
<endpoint region="DFW" tenantId="1100111" publicURL="https://dfw.databases.api.rackspacecloud.com/v1.0/1100111"/>
|
||||
<endpoint region="ORD" tenantId="1100111" publicURL="https://ord.databases.api.rackspacecloud.com/v1.0/1100111"/>
|
||||
</service>
|
||||
<service type="rax:load-balancer" name="cloudLoadBalancers">
|
||||
<endpoint region="DFW" tenantId="1100111" publicURL="https://dfw.loadbalancers.api.rackspacecloud.com/v1.0/1100111"/>
|
||||
<endpoint region="ORD" tenantId="1100111" publicURL="https://ord.loadbalancers.api.rackspacecloud.com/v1.0/1100111"/>
|
||||
</service>
|
||||
<service type="compute" name="cloudServersOpenStack">
|
||||
<endpoint region="DFW" tenantId="1100111"
|
||||
publicURL="https://dfw.servers.api.rackspacecloud.com/v2/1100111">
|
||||
<version id="2" info="https://dfw.servers.api.rackspacecloud.com/v2/"
|
||||
list="https://dfw.servers.api.rackspacecloud.com/" />
|
||||
</endpoint>
|
||||
<endpoint region="ORD" tenantId="1100111"
|
||||
publicURL="https://ord.servers.api.rackspacecloud.com/v2/1100111">
|
||||
<version id="2" info="https://ord.servers.api.rackspacecloud.com/v2/"
|
||||
list="https://ord.servers.api.rackspacecloud.com/" />
|
||||
</endpoint>
|
||||
</service>
|
||||
<service type="compute" name="cloudServers">
|
||||
<endpoint tenantId="1100111"
|
||||
publicURL="https://servers.api.rackspacecloud.com/v1.0/1100111">
|
||||
<version id="1.0"
|
||||
info="https://servers.api.rackspacecloud.com/v1.0/"
|
||||
list="https://servers.api.rackspacecloud.com/"/>
|
||||
</endpoint>
|
||||
</service>
|
||||
<service type="object-store" name="cloudFiles">
|
||||
<endpoint region="DFW"
|
||||
tenantId="MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee"
|
||||
publicURL="https://storage101.dfw1.clouddrive.com/v1/MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee"
|
||||
internalURL="https://snet-storage101.dfw1.clouddrive.com/v1/MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee"/>
|
||||
<endpoint region="ORD"
|
||||
tenantId="MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee"
|
||||
publicURL="https://storage101.ord1.clouddrive.com/v1/MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee"
|
||||
internalURL="https://snet-storage101.ord1.clouddrive.com/v1/MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee"/>
|
||||
</service>
|
||||
<service type="rax:object-cdn" name="cloudFilesCDN">
|
||||
<endpoint region="DFW"
|
||||
tenantId="MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee"
|
||||
publicURL="https://cdn1.clouddrive.com/v1/MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee"/>
|
||||
<endpoint region="ORD"
|
||||
tenantId="MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee"
|
||||
publicURL="https://cdn2.clouddrive.com/v1/MossoCloudFS_aaaaaaaa-bbbb-cccc-dddd-eeeeeeee"/>
|
||||
</service>
|
||||
<service type="rax:dns" name="cloudDNS">
|
||||
<endpoint tenantId="1100111"
|
||||
publicURL="https://dns.api.rackspacecloud.com/v1.0/1100111"/>
|
||||
</service>
|
||||
</serviceCatalog>
|
||||
</access>
|
||||
10
apidocs/src/resources/samples/db-auth-repose-header.json
Normal file
10
apidocs/src/resources/samples/db-auth-repose-header.json
Normal file
@@ -0,0 +1,10 @@
|
||||
HTTP/1.1 200 OK
|
||||
Server: nginx/0.8.55
|
||||
Date: Tue, 26 Feb 2013 16:03:24 GMT
|
||||
Content-Type: application/json
|
||||
Transfer-Encoding: chunked
|
||||
Connection: keep-alive
|
||||
response-source: cloud-auth
|
||||
vary: Accept, Accept-Encoding, X-Auth-Token
|
||||
VIA: 1.0 Repose (Repose/2.3.5)
|
||||
Front-End-Https: on
|
||||
72
apidocs/src/resources/samples/db-auth.json
Normal file
72
apidocs/src/resources/samples/db-auth.json
Normal file
@@ -0,0 +1,72 @@
|
||||
HTTP/1.1 200 OK
|
||||
Content-Type: application/json; charset=UTF-8
|
||||
Content-Length: 477
|
||||
Date: Thu, 12 Apr 2012 18:45:13 GMT
|
||||
|
||||
{
|
||||
"auth": {
|
||||
"serviceCatalog": {
|
||||
"cloudDNS": [
|
||||
{
|
||||
"publicURL": "https://dns.api.rackspacecloud.com/v1.0/1234"
|
||||
}
|
||||
],
|
||||
"cloudDatabases": [
|
||||
{
|
||||
"publicURL": "https://dfw.databases.api.rackspacecloud.com/v1.0/1234",
|
||||
"region": "DFW"
|
||||
},
|
||||
{
|
||||
"publicURL": "https://ord.databases.api.rackspacecloud.com/v1.0/1234",
|
||||
"region": "ORD"
|
||||
}
|
||||
],
|
||||
"cloudFiles": [
|
||||
{
|
||||
"internalURL": "https://snet-storage101.dfw1.clouddrive.com/v1/ MossoCloudFS_aaaa-bbbbb-cccc-ddddd ",
|
||||
"publicURL": "https://storage101.dfw1.clouddrive.com/v1/ MossoCloudFS_aaaa-bbbbb-cccc-ddddd ",
|
||||
"region": "DFW",
|
||||
"v1Default": true
|
||||
}
|
||||
],
|
||||
"cloudFilesCDN": [
|
||||
{
|
||||
"publicURL": "https://cdn1.clouddrive.com/v1/MossoCloudFS_aaaa-bbbbb-cccc-ddddd",
|
||||
"region": "DFW",
|
||||
"v1Default": true
|
||||
}
|
||||
],
|
||||
"cloudLoadBalancers": [
|
||||
{
|
||||
"publicURL": "https://ord.loadbalancers.api.rackspacecloud.com/v1.0/1234",
|
||||
"region": "ORD"
|
||||
},
|
||||
{
|
||||
"publicURL": "https://dfw.loadbalancers.api.rackspacecloud.com/v1.0/1234",
|
||||
"region": "DFW"
|
||||
}
|
||||
],
|
||||
"cloudMonitoring": [
|
||||
{
|
||||
"publicURL": "https://monitoring.api.rackspacecloud.com/v1.0/1234"
|
||||
}
|
||||
],
|
||||
"cloudServers": [
|
||||
{
|
||||
"publicURL": "https://servers.api.rackspacecloud.com/v1.0/1234",
|
||||
"v1Default": true
|
||||
}
|
||||
],
|
||||
"cloudServersOpenStack": [
|
||||
{
|
||||
"publicURL": "https://dfw.servers.api.rackspacecloud.com/v2/1234",
|
||||
"region": "DFW"
|
||||
}
|
||||
]
|
||||
},
|
||||
"token": {
|
||||
"expires": "2012-04-12T13:15:52.000-05:00",
|
||||
"id": "aaaaa-bbbbbb-cccccc-ddddd"
|
||||
}
|
||||
}
|
||||
}
|
||||
50
apidocs/src/resources/samples/db-auth.xml
Normal file
50
apidocs/src/resources/samples/db-auth.xml
Normal file
@@ -0,0 +1,50 @@
|
||||
HTTP/1.1 200 OK
|
||||
Content-Type: application/xml; charset=UTF-8
|
||||
Content-Length: 477
|
||||
Date: Thu, 12 Apr 2012 18:50:20 GMT
|
||||
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
|
||||
<auth xmlns="http://docs.rackspacecloud.com/auth/api/v1.1">
|
||||
<token id="aaaaa-bbbbbb-cccccc-ddddd"
|
||||
expires="2012-04-12T13:15:52.000-05:00" />
|
||||
<serviceCatalog>
|
||||
<service name="cloudDatabases">
|
||||
<endpoint region="ORD" v1Default="false"
|
||||
publicURL="https://ord.databases.api.rackspacecloud.com/v1.0/1234"/>
|
||||
<endpoint region="DFW" v1Default="false"
|
||||
publicURL="https://dfw.databases.api.rackspacecloud.com/v1.0/1234"/>
|
||||
</service>
|
||||
<service name="cloudDNS">
|
||||
<endpoint v1Default="false" publicURL="https://dns.api.rackspacecloud.com/v1.0/1234"/>
|
||||
</service>
|
||||
<service name="cloudServers">
|
||||
<endpoint v1Default="true"
|
||||
publicURL="https://servers.api.rackspacecloud.com/v1.0/1234"/>
|
||||
</service>
|
||||
<service name="cloudLoadBalancers">
|
||||
<endpoint region="DFW" v1Default="false"
|
||||
publicURL="https://dfw.loadbalancers.api.rackspacecloud.com/v1.0/1234"/>
|
||||
<endpoint region="ORD" v1Default="false"
|
||||
publicURL="https://ord.loadbalancers.api.rackspacecloud.com/v1.0/1234"/>
|
||||
</service>
|
||||
<service name="cloudMonitoring">
|
||||
<endpoint v1Default="false"
|
||||
publicURL="https://monitoring.api.rackspacecloud.com/v1.0/1234"/>
|
||||
</service>
|
||||
<service name="cloudServersOpenStack">
|
||||
<endpoint region="DFW" v1Default="false"
|
||||
publicURL="https://dfw.servers.api.rackspacecloud.com/v2/1234"/>
|
||||
</service>
|
||||
<service name="cloudFiles">
|
||||
<endpoint region="DFW" v1Default="true"
|
||||
publicURL="https://storage101.dfw1.clouddrive.com/v1/MossoCloudFS_aaaa-bbbbbb-ccccc-ddddd"
|
||||
internalURL="https://snet-storage101.dfw1.clouddrive.com/v1/MossoCloudFS_aaaa-bbbbbb-ccccc-ddddd"
|
||||
/>
|
||||
</service>
|
||||
<service name="cloudFilesCDN">
|
||||
<endpoint region="DFW" v1Default="true"
|
||||
publicURL="https://cdn1.clouddrive.com/v1/MossoCloudFS_aaaa-bbbbbb-ccccc-ddddd"
|
||||
/>
|
||||
</service>
|
||||
</serviceCatalog>
|
||||
</auth>
|
||||
@@ -0,0 +1,19 @@
|
||||
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"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
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
|
||||
|
||||
<users xmlns="http://docs.openstack.org/database/api/v1.0">
|
||||
<user password="5" name="exampleuser"/>
|
||||
</users>
|
||||
@@ -0,0 +1,5 @@
|
||||
HTTP/1.1 202 Accepted
|
||||
Content-Type: application/json
|
||||
Content-Length: 152
|
||||
Date: Wed, 21 Mar 2012 17:46:46 GMT
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
HTTP/1.1 202 Accepted
|
||||
Content-Type: application/xml
|
||||
Content-Length: 501
|
||||
Date: Wed, 27 Jun 2012 21:56:06 GMT
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
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
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
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
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
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
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
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)
|
||||
|
||||
<rootEnabled xmlns="http://docs.openstack.org/database/api/v1.0">
|
||||
True
|
||||
</rootEnabled>
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
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"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
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>
|
||||
@@ -0,0 +1,22 @@
|
||||
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"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
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
|
||||
|
||||
<databases xmlns="http://docs.openstack.org/database/api/v1.0">
|
||||
<database collate="utf8_general_ci" name="testingdb" character_set="utf8"/>
|
||||
<database name="anotherdb"/>
|
||||
<database name="oneMoreDB"/>
|
||||
</databases>
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
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)
|
||||
@@ -0,0 +1,6 @@
|
||||
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)
|
||||
@@ -0,0 +1,37 @@
|
||||
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
|
||||
}
|
||||
}
|
||||
}
|
||||
22
apidocs/src/resources/samples/db-create-instance-request.xml
Normal file
22
apidocs/src/resources/samples/db-create-instance-request.xml
Normal file
@@ -0,0 +1,22 @@
|
||||
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
|
||||
|
||||
<instance xmlns="http://docs.openstack.org/database/api/v1.0" flavorRef="1" name="xml_rack_instance">
|
||||
<volume size="2"/>
|
||||
<users>
|
||||
<user password="demopassword" name="demouser">
|
||||
<databases>
|
||||
<database name="sampledb"/>
|
||||
</databases>
|
||||
</user>
|
||||
</users>
|
||||
<databases>
|
||||
<database collate="utf8_general_ci" name="sampledb" character_set="utf8"/>
|
||||
<database name="nextround"/>
|
||||
</databases>
|
||||
</instance>
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
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
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
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)
|
||||
|
||||
<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">
|
||||
<links>
|
||||
<link href="https://ord.databases.api.rackspacecloud.com/v1.0/1234/instances/098653ba-218b-47ce-936a-e0b749101f81" rel="self"/>
|
||||
<link href="https://ord.databases.api.rackspacecloud.com/instances/098653ba-218b-47ce-936a-e0b749101f81" 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>
|
||||
|
||||
33
apidocs/src/resources/samples/db-create-users-request.json
Normal file
33
apidocs/src/resources/samples/db-create-users-request.json
Normal file
@@ -0,0 +1,33 @@
|
||||
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"
|
||||
}
|
||||
]
|
||||
}
|
||||
18
apidocs/src/resources/samples/db-create-users-request.xml
Normal file
18
apidocs/src/resources/samples/db-create-users-request.xml
Normal file
@@ -0,0 +1,18 @@
|
||||
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
|
||||
|
||||
<users xmlns="http://docs.openstack.org/database/api/v1.0">
|
||||
<user password="password" name="dbuser1" database="databaseA"/>
|
||||
<user password="password" name="dbuser2">
|
||||
<databases>
|
||||
<database name="databaseB"/>
|
||||
<database name="databaseC"/>
|
||||
</databases>
|
||||
</user>
|
||||
<user password="password" name="dbuser3" database="databaseD"/>
|
||||
</users>
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
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)
|
||||
@@ -0,0 +1,6 @@
|
||||
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)
|
||||
18
apidocs/src/resources/samples/db-credentials-20.json
Normal file
18
apidocs/src/resources/samples/db-credentials-20.json
Normal file
@@ -0,0 +1,18 @@
|
||||
POST /v2.0/tokens HTTP/1.1
|
||||
User-Agent: curl/7.21.0 (x86_64-pc-linux-gnu) libcurl/7.21.0 OpenSSL/0.9.8o zlib/1.2.3.4 libidn/1.15 libssh2/1.2.6
|
||||
Host: identity.api.rackspacecloud.com
|
||||
Accept: application/json
|
||||
Content-Type: application/json
|
||||
Content-Length: 54
|
||||
|
||||
{
|
||||
"auth":
|
||||
{
|
||||
"RAX-KSKEY:apiKeyCredentials":
|
||||
{
|
||||
"username": "jsmith",
|
||||
"apiKey": "aaaaa-bbbbb-ccccc-12345678"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
14
apidocs/src/resources/samples/db-credentials-20.xml
Normal file
14
apidocs/src/resources/samples/db-credentials-20.xml
Normal file
@@ -0,0 +1,14 @@
|
||||
POST /v2.0/tokens HTTP/1.1
|
||||
User-Agent: curl/7.21.0 (x86_64-pc-linux-gnu) libcurl/7.21.0 OpenSSL/0.9.8o zlib/1.2.3.4 libidn/1.15 libssh2/1.2.6
|
||||
Host: identity.api.rackspacecloud.com
|
||||
Accept: application/xml
|
||||
Content-Type: application/xml
|
||||
Content-Length: 88
|
||||
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<auth>
|
||||
<apiKeyCredentials
|
||||
xmlns="http://docs.rackspace.com/identity/api/ext/RAX-KSKEY/v1.0"
|
||||
username="jsmith"
|
||||
apiKey="aaaaa-bbbbb-ccccc-12345678"/>
|
||||
</auth>
|
||||
13
apidocs/src/resources/samples/db-credentials.json
Normal file
13
apidocs/src/resources/samples/db-credentials.json
Normal file
@@ -0,0 +1,13 @@
|
||||
POST /v1.1/auth HTTP/1.1
|
||||
User-Agent: curl/7.21.0 (x86_64-pc-linux-gnu) libcurl/7.21.0 OpenSSL/0.9.8o zlib/1.2.3.4 libidn/1.15 libssh2/1.2.6
|
||||
Host: auth.api.rackspacecloud.com
|
||||
Accept: application/json
|
||||
Content-Type: application/json
|
||||
Content-Length: 54
|
||||
|
||||
{
|
||||
"credentials" : {
|
||||
"username" : "hub_cap",
|
||||
"key" : "a86850deb2742ec3cb41518e26aa2d89"
|
||||
}
|
||||
}
|
||||
11
apidocs/src/resources/samples/db-credentials.xml
Normal file
11
apidocs/src/resources/samples/db-credentials.xml
Normal file
@@ -0,0 +1,11 @@
|
||||
POST /v1.1/auth HTTP/1.1
|
||||
User-Agent: curl/7.21.0 (x86_64-pc-linux-gnu) libcurl/7.21.0 OpenSSL/0.9.8o zlib/1.2.3.4 libidn/1.15 libssh2/1.2.6
|
||||
Host: auth.api.rackspacecloud.com
|
||||
Accept: application/xml
|
||||
Content-Type: application/xml
|
||||
Content-Length: 88
|
||||
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<credentials xmlns="http://docs.rackspacecloud.com/auth/api/v1.1"
|
||||
username="hub_cap"
|
||||
key="a86850deb2742ec3cb41518e26aa2d89"/>
|
||||
@@ -0,0 +1,8 @@
|
||||
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
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
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
|
||||
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
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)
|
||||
@@ -0,0 +1,6 @@
|
||||
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)
|
||||
@@ -0,0 +1,8 @@
|
||||
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
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
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
|
||||
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
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)
|
||||
@@ -0,0 +1,6 @@
|
||||
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)
|
||||
@@ -0,0 +1,8 @@
|
||||
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
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
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
|
||||
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
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)
|
||||
@@ -0,0 +1,6 @@
|
||||
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)
|
||||
@@ -0,0 +1,8 @@
|
||||
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
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
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
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
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"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
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)
|
||||
|
||||
<user name="root" password="12345" xmlns="http://docs.openstack.org/database/api/v1.0"/>
|
||||
|
||||
11
apidocs/src/resources/samples/db-faults-badRequest.json
Normal file
11
apidocs/src/resources/samples/db-faults-badRequest.json
Normal file
@@ -0,0 +1,11 @@
|
||||
HTTP/1.1 400 None
|
||||
Content-Length: 120
|
||||
Content-Type: application/json; charset=UTF-8
|
||||
Date: Tue, 29 Nov 2011 00:33:48 GMT
|
||||
|
||||
{
|
||||
"badRequest": {
|
||||
"code": 400,
|
||||
"message": "Volume 'size' needs to be a positive integer value, -1.0 cannot be accepted."
|
||||
}
|
||||
}
|
||||
10
apidocs/src/resources/samples/db-faults-badRequest.xml
Normal file
10
apidocs/src/resources/samples/db-faults-badRequest.xml
Normal file
@@ -0,0 +1,10 @@
|
||||
HTTP/1.1 400 None
|
||||
Content-Type: application/xml
|
||||
Content-Length: 121
|
||||
Date: Mon, 28 Nov 2011 18:19:37 GMT
|
||||
|
||||
<badRequest code="400" xmlns="http://docs.openstack.org/database/api/v1.0">
|
||||
<message>
|
||||
Volume 'size' needs to be a positive integer value, -1.0 cannot be accepted.
|
||||
</message>
|
||||
</badRequest>
|
||||
11
apidocs/src/resources/samples/db-faults-instanceFault.json
Normal file
11
apidocs/src/resources/samples/db-faults-instanceFault.json
Normal file
@@ -0,0 +1,11 @@
|
||||
HTTP/1.1 500 Internal Server Error
|
||||
Content-Length: 120
|
||||
Content-Type: application/json; charset=UTF-8
|
||||
Date: Tue, 29 Nov 2011 00:33:48 GMT
|
||||
|
||||
{
|
||||
"instanceFault": {
|
||||
"code": 500,
|
||||
"message": "The server has either erred or is incapable of performing the requested operation."
|
||||
}
|
||||
}
|
||||
10
apidocs/src/resources/samples/db-faults-instanceFault.xml
Normal file
10
apidocs/src/resources/samples/db-faults-instanceFault.xml
Normal file
@@ -0,0 +1,10 @@
|
||||
HTTP/1.1 500 Internal Server Error
|
||||
Content-Type: application/xml
|
||||
Content-Length: 121
|
||||
Date: Mon, 28 Nov 2011 18:19:37 GMT
|
||||
|
||||
<instanceFault code="500" xmlns="http://docs.openstack.org/database/api/v1.0">
|
||||
<message>
|
||||
The server has either erred or is incapable of performing the requested operation.
|
||||
</message>
|
||||
</instanceFault>
|
||||
11
apidocs/src/resources/samples/db-faults-itemNotFound.json
Normal file
11
apidocs/src/resources/samples/db-faults-itemNotFound.json
Normal file
@@ -0,0 +1,11 @@
|
||||
HTTP/1.1 404 Not Found
|
||||
Content-Length: 78
|
||||
Content-Type: application/json; charset=UTF-8
|
||||
Date: Tue, 29 Nov 2011 00:35:24 GMT
|
||||
|
||||
{
|
||||
"itemNotFound": {
|
||||
"code": 404,
|
||||
"message": "The resource could not be found."
|
||||
}
|
||||
}
|
||||
10
apidocs/src/resources/samples/db-faults-itemNotFound.xml
Normal file
10
apidocs/src/resources/samples/db-faults-itemNotFound.xml
Normal file
@@ -0,0 +1,10 @@
|
||||
HTTP/1.1 404 Not Found
|
||||
Content-Length: 147
|
||||
Content-Type: application/xml; charset=UTF-8
|
||||
Date: Mon, 28 Nov 2011 19:50:15 GMT
|
||||
|
||||
<itemNotFound code="404" xmlns="http://docs.openstack.org/database/api/v1.0">
|
||||
<message>
|
||||
The resource could not be found.
|
||||
</message>
|
||||
</itemNotFound>
|
||||
@@ -0,0 +1,8 @@
|
||||
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
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
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
|
||||
|
||||
|
||||
24
apidocs/src/resources/samples/db-flavors-by-id-response.json
Normal file
24
apidocs/src/resources/samples/db-flavors-by-id-response.json
Normal file
@@ -0,0 +1,24 @@
|
||||
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
|
||||
}
|
||||
}
|
||||
14
apidocs/src/resources/samples/db-flavors-by-id-response.xml
Normal file
14
apidocs/src/resources/samples/db-flavors-by-id-response.xml
Normal file
@@ -0,0 +1,14 @@
|
||||
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)
|
||||
|
||||
<flavor id="1" name="512MB Instance" 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"/>
|
||||
</links>
|
||||
</flavor>
|
||||
|
||||
8
apidocs/src/resources/samples/db-flavors-request.json
Normal file
8
apidocs/src/resources/samples/db-flavors-request.json
Normal file
@@ -0,0 +1,8 @@
|
||||
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
|
||||
|
||||
|
||||
8
apidocs/src/resources/samples/db-flavors-request.xml
Normal file
8
apidocs/src/resources/samples/db-flavors-request.xml
Normal file
@@ -0,0 +1,8 @@
|
||||
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
|
||||
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
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
|
||||
}
|
||||
]
|
||||
}
|
||||
34
apidocs/src/resources/samples/db-flavors-response-no8_16.xml
Normal file
34
apidocs/src/resources/samples/db-flavors-response-no8_16.xml
Normal file
@@ -0,0 +1,34 @@
|
||||
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)
|
||||
|
||||
<flavors xmlns="http://docs.openstack.org/database/api/v1.0">
|
||||
<flavor id="1" name="512MB Instance" 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="2" name="1GB Instance" 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="3" name="2GB Instance" 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="4" name="4GB Instance" 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>
|
||||
</flavors>
|
||||
|
||||
101
apidocs/src/resources/samples/db-flavors-response.json
Normal file
101
apidocs/src/resources/samples/db-flavors-response.json
Normal file
@@ -0,0 +1,101 @@
|
||||
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
|
||||
}
|
||||
]
|
||||
}
|
||||
46
apidocs/src/resources/samples/db-flavors-response.xml
Normal file
46
apidocs/src/resources/samples/db-flavors-response.xml
Normal file
@@ -0,0 +1,46 @@
|
||||
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)
|
||||
|
||||
<flavors xmlns="http://docs.openstack.org/database/api/v1.0">
|
||||
<flavor id="1" name="512MB Instance" 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="2" name="1GB Instance" 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="3" name="2GB Instance" 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="4" name="4GB Instance" 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="5" name="8GB Instance" 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"/>
|
||||
</links>
|
||||
</flavor>
|
||||
<flavor id="6" name="16GB Instance" 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>
|
||||
</flavors>
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
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"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
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
|
||||
|
||||
<databases xmlns="http://docs.openstack.org/database/api/v1.0">
|
||||
<database name="extradb"/>
|
||||
</databases>
|
||||
@@ -0,0 +1,4 @@
|
||||
HTTP/1.1 202 Accepted
|
||||
Content-Type: application/json
|
||||
Content-Length: 0
|
||||
Date: Wed, 27 Jun 2012 23:11:19 GMT
|
||||
@@ -0,0 +1,4 @@
|
||||
HTTP/1.1 202 Accepted
|
||||
Content-Type: application/xml
|
||||
Content-Length: 0
|
||||
Date: Wed, 27 Jun 2012 23:11:19 GMT
|
||||
@@ -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"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -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>
|
||||
|
||||
10
apidocs/src/resources/samples/db-guest-update-request.json
Normal file
10
apidocs/src/resources/samples/db-guest-update-request.json
Normal file
@@ -0,0 +1,10 @@
|
||||
POST /v1.0/1234/mgmt/instances/3b16f448-4387-44f5-b464-45111dd7a934/action HTTP/1.1
|
||||
User-Agent: python-example-client
|
||||
Host: ord.databases.api.rackspacecloud.com
|
||||
X-Auth-Token: 570ef429-78eb-43ec-ad69-de9456cd88c9
|
||||
Accept: application/json
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"update": {}
|
||||
}
|
||||
10
apidocs/src/resources/samples/db-guest-update-request.xml
Normal file
10
apidocs/src/resources/samples/db-guest-update-request.xml
Normal file
@@ -0,0 +1,10 @@
|
||||
POST /v1.0/1234/mgmt/instances/f3a9e303-1542-4663-9dca-bfdcd7abe095/action HTTP/1.1
|
||||
User-Agent: python-example-client
|
||||
Host: ord.databases.api.rackspacecloud.com
|
||||
X-Auth-Token: 570ef429-78eb-43ec-ad69-de9456cd88c9
|
||||
Accept: application/xml
|
||||
Content-Type: application/xml
|
||||
|
||||
<?xml version="1.0" ?>
|
||||
<update xmlns="http://docs.openstack.org/database/api/v1.0"/>
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
HTTP/1.1 202 Accepted
|
||||
Content-Type: text/plain; charset=UTF-8
|
||||
Content-Length: 58
|
||||
Date: Mon, 05 Mar 2012 23:48:46 GMT
|
||||
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
HTTP/1.1 202 Accepted
|
||||
Content-Type: text/plain; charset=UTF-8
|
||||
Content-Length: 58
|
||||
Date: Mon, 05 Mar 2012 23:48:47 GMT
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
POST /v1.0/1234/mgmt/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
|
||||
|
||||
{
|
||||
"reboot": {}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
POST /v1.0/1234/mgmt/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
|
||||
|
||||
<reboot xmlns="http://docs.openstack.org/database/api/v1.0"/>
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
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)
|
||||
@@ -0,0 +1,6 @@
|
||||
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)
|
||||
@@ -0,0 +1,12 @@
|
||||
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": {
|
||||
"flavorRef": 3
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
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
|
||||
|
||||
<resize xmlns="http://docs.openstack.org/database/api/v1.0" flavorRef="3"/>
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
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)
|
||||
@@ -0,0 +1,6 @@
|
||||
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)
|
||||
@@ -0,0 +1,12 @@
|
||||
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"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,12 @@
|
||||
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
|
||||
|
||||
<?xml version="1.0" ?>
|
||||
<resize xmlns="http://docs.openstack.org/database/api/v1.0">
|
||||
<flavorRef>https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/2</flavorRef>
|
||||
</resize>
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
HTTP/1.1 202 Accepted
|
||||
Content-Type: text/plain; charset=UTF-8
|
||||
Content-Length: 58
|
||||
Date: Mon, 06 Feb 2012 21:28:10 GMT
|
||||
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
HTTP/1.1 202 Accepted
|
||||
Content-Type: text/plain; charset=UTF-8
|
||||
Content-Length: 58
|
||||
Date: Mon, 06 Feb 2012 21:28:11 GMT
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
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
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
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
|
||||
|
||||
<resize xmlns="http://docs.openstack.org/database/api/v1.0">
|
||||
<volume size="4"/>
|
||||
</resize>
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user