Fix whitespace
Fix whitespace as noticed by checkniceness check. Change-Id: Ib09bff7ac6e3c74d1cecc7be470fcb72e1ee8641
This commit is contained in:
Andreas Jaeger
parent
3d5bdb45ec
commit
ca5236ca39
@ -8,8 +8,8 @@
|
||||
<fileSet>
|
||||
<directory>${project.basedir}/target/docbkx/webhelp</directory>
|
||||
<includes>
|
||||
<include>**.war</include>
|
||||
<include>**.war</include>
|
||||
</includes>
|
||||
</fileSet>
|
||||
</fileSets>
|
||||
</assembly>
|
||||
</assembly>
|
||||
|
||||
@ -10,7 +10,7 @@
|
||||
<!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/">
|
||||
@ -36,10 +36,10 @@
|
||||
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"
|
||||
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
|
||||
@ -73,9 +73,9 @@
|
||||
<para>This document is intended for software developers
|
||||
interested in developing applications using the
|
||||
OpenStack Cloud Databases Application Programming
|
||||
Interface (<abbrev>API</abbrev>). </para>
|
||||
Interface (<abbrev>API</abbrev>).</para>
|
||||
</abstract>
|
||||
|
||||
|
||||
<revhistory>
|
||||
<revision>
|
||||
<date>2013-05-02</date>
|
||||
@ -87,9 +87,9 @@
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</revdescription>
|
||||
</revision>
|
||||
</revision>
|
||||
</revhistory>
|
||||
|
||||
|
||||
<cover>
|
||||
<para>this is a placeholder for the front cover</para>
|
||||
</cover>
|
||||
@ -100,7 +100,7 @@
|
||||
<raxm:displayname>API Developer Guide</raxm:displayname>
|
||||
<raxm:product version="v1.0">cdb</raxm:product>
|
||||
<raxm:priority>20</raxm:priority>
|
||||
</raxm:metadata>
|
||||
</raxm:metadata>
|
||||
</info>
|
||||
<chapter xml:id="overview">
|
||||
<title>Overview</title>
|
||||
@ -134,11 +134,11 @@
|
||||
<?hard-pagebreak?>
|
||||
<section xml:id="Intended_Audience-d1e122">
|
||||
<title>Intended Audience</title>
|
||||
<para> This Guide is intended to assist software
|
||||
<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>
|
||||
with:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>ReSTful web services</para>
|
||||
@ -165,23 +165,23 @@
|
||||
<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>
|
||||
>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>
|
||||
>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>
|
||||
>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>
|
||||
<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
|
||||
@ -224,18 +224,18 @@
|
||||
</chapter>
|
||||
<chapter xml:id="General_API_Information-d1e633">
|
||||
<title>General API Information</title>
|
||||
<para> The Cloud Databases API is implemented using a ReSTful
|
||||
<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>
|
||||
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>
|
||||
<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
|
||||
<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
|
||||
@ -250,16 +250,16 @@
|
||||
</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>
|
||||
<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
|
||||
<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.
|
||||
to be compatible with one another.
|
||||
</para>
|
||||
<example>
|
||||
<title>Example Request URL (contract version
|
||||
@ -271,7 +271,7 @@
|
||||
<para>This document pertains to contract
|
||||
version 1.0.</para>
|
||||
</note>
|
||||
|
||||
|
||||
</section>
|
||||
<section xml:id="API_Version_Headers-d1e855">
|
||||
<title>API Version</title>
|
||||
@ -284,9 +284,9 @@
|
||||
<?hard-pagebreak?>
|
||||
<section xml:id="datetimeformat">
|
||||
<title>Date/Time Format</title>
|
||||
<para> The Database Service uses an ISO-8601 compliant
|
||||
<para>The Database Service uses an ISO-8601 compliant
|
||||
date format for the display and consumption of
|
||||
date/time values. </para>
|
||||
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.
|
||||
@ -347,7 +347,7 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
</section>
|
||||
<section xml:id="pagination">
|
||||
<title>Pagination</title>
|
||||
@ -359,7 +359,7 @@
|
||||
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
|
||||
<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>
|
||||
@ -372,9 +372,9 @@
|
||||
request the next 10 instances after the instance
|
||||
"1234" as follows:
|
||||
<code>?limit=10&marker=1234</code>. Items are
|
||||
displayed sorted by ID. </para>
|
||||
displayed sorted by ID.</para>
|
||||
<para>Pagination applies only to the calls listed in the
|
||||
following table: </para>
|
||||
following table:</para>
|
||||
<informaltable rules="all">
|
||||
<thead>
|
||||
<tr align="center">
|
||||
@ -394,13 +394,13 @@
|
||||
<tr>
|
||||
<td colspan="1">&GET;</td>
|
||||
<td colspan="2">
|
||||
/instances/{instanceId}/databases </td>
|
||||
/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="2"> /instances/{instanceId}/users</td>
|
||||
<td colspan="3">Lists the users in the
|
||||
specified database instance.</td>
|
||||
</tr>
|
||||
@ -460,11 +460,11 @@
|
||||
</section>
|
||||
<section xml:id="DB_faults">
|
||||
<title>Faults</title>
|
||||
<para> When an error occurs, the Database Service returns
|
||||
<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>
|
||||
information about the fault.</para>
|
||||
<para>The following table lists possible fault types with their associated error codes
|
||||
and descriptions.</para>
|
||||
<informaltable rules="all">
|
||||
@ -548,7 +548,7 @@
|
||||
<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"?>
|
||||
@ -563,7 +563,7 @@
|
||||
<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
|
||||
<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
|
||||
@ -571,7 +571,7 @@
|
||||
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>
|
||||
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>
|
||||
@ -590,7 +590,7 @@
|
||||
<xi:include href="samples/db-faults-badRequest.json" parse="text"/>
|
||||
</programlisting>
|
||||
</example>
|
||||
<para> The next two examples show
|
||||
<para>The next two examples show
|
||||
<code>itemNotFound</code> errors:</para>
|
||||
<example>
|
||||
<title>Example itemNotFound Fault: XML</title>
|
||||
@ -706,7 +706,7 @@
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>ACTIVE – The database instance is
|
||||
online and available to take requests.</para>
|
||||
online and available to take requests.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>BLOCKED – The database instance is
|
||||
@ -720,7 +720,7 @@
|
||||
<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>
|
||||
is shut down but not the actual server.</para>
|
||||
<para>
|
||||
<note>
|
||||
<para>If MySQL has crashed (causing the
|
||||
@ -732,13 +732,13 @@
|
||||
<listitem>
|
||||
<para>ERROR – The last operation for the
|
||||
database instance failed due to an
|
||||
error.</para>
|
||||
</listitem>
|
||||
error.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
</chapter>
|
||||
|
||||
<chapter xml:id="API_Operations-d1e2264"
|
||||
|
||||
<chapter xml:id="API_Operations-d1e2264"
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
role="api-reference">
|
||||
<title>API Operations</title>
|
||||
@ -762,9 +762,9 @@
|
||||
<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>
|
||||
@ -776,13 +776,13 @@
|
||||
|
||||
<wadl:resource href="../../../xsd/dbaas.wadl#instanceId">
|
||||
<wadl:method href="getInstanceById"/>
|
||||
<wadl:method href="deleteInstance"/>
|
||||
<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>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
|
||||
<section xml:id="Database_Instances_Actions">
|
||||
@ -811,8 +811,8 @@
|
||||
<wadl:method href="deleteDatabase"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
|
||||
</section>
|
||||
|
||||
<section xml:id="user_management">
|
||||
<title>Users</title>
|
||||
<para>This section describes the operations that are
|
||||
@ -823,7 +823,7 @@
|
||||
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>
|
||||
instance.</para>
|
||||
<warning>
|
||||
<para>There is a bug in a python library that
|
||||
development is using that may cause incorrect user
|
||||
@ -860,7 +860,7 @@
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
|
||||
|
||||
<section xml:id="flavors">
|
||||
<title>Flavors</title>
|
||||
<para>This section describes the operations that are
|
||||
@ -901,11 +901,11 @@
|
||||
<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
|
||||
<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>
|
||||
|
||||
@ -61,14 +61,14 @@ Date: Thu, 12 Apr 2012 18:50:20 GMT
|
||||
<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"/>
|
||||
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"/>
|
||||
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>
|
||||
</access>
|
||||
|
||||
@ -6,9 +6,9 @@ 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>
|
||||
<apiKeyCredentials
|
||||
xmlns="http://docs.rackspace.com/identity/api/ext/RAX-KSKEY/v1.0"
|
||||
username="jsmith"
|
||||
apiKey="aaaaa-bbbbb-ccccc-12345678"/>
|
||||
</auth>
|
||||
|
||||
@ -19,4 +19,3 @@ Date: Thu, 05 Apr 2012 16:17:29 GMT
|
||||
</links>
|
||||
</flavor>
|
||||
</instance>
|
||||
|
||||
|
||||
@ -7,6 +7,5 @@ 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>
|
||||
<flavorRef>https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/2</flavorRef>
|
||||
</resize>
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ Content-Length: 218
|
||||
Date: Wed, 25 Jan 2012 21:53:04 GMT
|
||||
|
||||
<version id="v1.0" status="CURRENT" updated="2012-01-01T00:00:00Z" xmlns="http://docs.openstack.org/database/api/v1.0">
|
||||
<links>
|
||||
<link href="https://ord.databases.api.rackspacecloud.com/v1.0/" rel="self"/>
|
||||
</links>
|
||||
<links>
|
||||
<link href="https://ord.databases.api.rackspacecloud.com/v1.0/" rel="self"/>
|
||||
</links>
|
||||
</version>
|
||||
|
||||
@ -31,7 +31,7 @@
|
||||
<resource id="instances" path="instances">
|
||||
<method href="#createInstance" />
|
||||
<method href="#getInstance" />
|
||||
|
||||
|
||||
<resource id="instanceId" path="{instanceId}">
|
||||
<param name="instanceId" style="template"
|
||||
type="xsd:string" >
|
||||
@ -72,7 +72,7 @@
|
||||
<doc>The name for the specified database.</doc></param>
|
||||
<method href="#revokeUserAccess" />
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
<resource id="root" path="root">
|
||||
@ -83,7 +83,7 @@
|
||||
</resource>
|
||||
<resource id="flavors" path="flavors">
|
||||
<method href="#getFlavors" />
|
||||
|
||||
|
||||
<resource id="flavorId" path="{flavorId}">
|
||||
<param name="flavorId" style="template" type="xsd:string" >
|
||||
<doc>The flavor ID for the specified flavor.</doc></param>
|
||||
@ -100,7 +100,7 @@
|
||||
<wadl:doc xml:lang="EN" title="List Version Details" xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Returns detailed information about the specified version of the API.
|
||||
</para>
|
||||
</para>
|
||||
<para>This operation returns detailed information about the specified version of the API.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -192,8 +192,8 @@
|
||||
<caption>Required and Optional Attributes for Create Instance</caption>
|
||||
<thead>
|
||||
<tr>
|
||||
<td colspan="1">Applies To </td>
|
||||
<td colspan="1">Name </td>
|
||||
<td colspan="1">Applies To</td>
|
||||
<td colspan="1">Name</td>
|
||||
<td colspan="3">Description</td>
|
||||
<td colspan="1">Required</td>
|
||||
</tr>
|
||||
@ -202,7 +202,7 @@
|
||||
<tr>
|
||||
<td colspan="1" rowspan="3">Instance</td>
|
||||
<td colspan="1">flavorRef</td>
|
||||
<td colspan="3"><para>Reference (href) to a flavor as specified in the response from the List Flavors API call.
|
||||
<td colspan="3"><para>Reference (href) to a flavor as specified in the response from the List Flavors API call.
|
||||
This is the actual URI as specified by the href field in the link. Refer to the List Flavors response examples that follow for an example of the flavorRef.</para>
|
||||
<note><para>Rather than the flavor URI, you can also pass the flavor id (integer) as the value for flavorRef.</para></note>
|
||||
<para>Refer to <xref linkend="GET_getFlavors__version___accountId__flavors_"/> for details.</para></td>
|
||||
@ -338,7 +338,7 @@
|
||||
<representation mediaType="application/xml">
|
||||
<doc>
|
||||
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List All Database Instances Detail requests:</para>
|
||||
|
||||
|
||||
<xsdxt:code href="../apidocs/src/resources/samples/db-instances-index-request.xml"/>
|
||||
</doc>
|
||||
</representation>
|
||||
@ -352,7 +352,7 @@
|
||||
<representation mediaType="application/xml" >
|
||||
<doc>
|
||||
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List All Database Instances responses:</para>
|
||||
|
||||
|
||||
<xsdxt:code href="../apidocs/src/resources/samples/db-instances-index-response.xml"/>
|
||||
</doc>
|
||||
</representation>
|
||||
@ -374,7 +374,7 @@
|
||||
<para>This operation lists the volume size in gigabytes (GB) and the approximate GB used.</para>
|
||||
<note><para>After instance creation, the <code>used</code> size of your volume will be
|
||||
greater than 0. This is expected and due to the automatic creation of
|
||||
non-empty transaction logs for mysql optimization. The <code>used</code> attribute is <emphasis>not</emphasis> returned
|
||||
non-empty transaction logs for mysql optimization. The <code>used</code> attribute is <emphasis>not</emphasis> returned
|
||||
in the response when the status for the instance is BUILD, REBOOT, RESIZE, or ERROR.</para> </note>
|
||||
<para>Refer to <xref linkend="database_instance_status"/> for a list of possible database instance statuses that may be returned.</para>
|
||||
<para>The list operations return a DNS-resolvable hostname associated with the database instance instead of an IP address. Since the hostname always resolves to the correct IP address of the database instance, this relieves the user from the task of maintaining the mapping. Note that although the IP address may likely change on resizing, migrating, and so forth, the hostname always resolves to the correct database instance.</para>
|
||||
@ -390,7 +390,7 @@
|
||||
<doc>
|
||||
<xsdxt:code href="../apidocs/src/resources/samples/db-instance-status-detail-request.xml"/>
|
||||
</doc>
|
||||
</representation>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/xml"
|
||||
@ -541,7 +541,7 @@
|
||||
<caption>Required and Optional Attributes for Create Database</caption>
|
||||
<thead>
|
||||
<tr>
|
||||
<td colspan="1">Name </td>
|
||||
<td colspan="1">Name</td>
|
||||
<td colspan="3">Description</td>
|
||||
<td colspan="1">Required</td>
|
||||
</tr>
|
||||
@ -568,7 +568,7 @@
|
||||
<para>See the MySQL documentation for information about supported character sets and collations at <link
|
||||
xlink:href="http://dev.mysql.com/doc/refman/5.1/en/charset-mysql.html"
|
||||
>http://dev.mysql.com/doc/refman/5.1/en/charset-mysql.html</link>.</para>
|
||||
|
||||
|
||||
|
||||
<note><para>The following database names are reserved and cannot be used for creating databases: lost+found, information_schema, and mysql.</para></note>
|
||||
<para>Refer to the following tables for information about characters that are valid/invalid for creating database names.</para>
|
||||
@ -673,7 +673,7 @@
|
||||
<doc>
|
||||
<xsdxt:code href="../apidocs/src/resources/samples/db-create-databases-response.json"/>
|
||||
</doc>
|
||||
</representation>
|
||||
</representation>
|
||||
</response>
|
||||
&commonFaults;
|
||||
&getFaults;
|
||||
@ -684,7 +684,7 @@
|
||||
<wadl:doc xml:lang="EN" title="List Databases for Instance" xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Lists databases for the specified instance.</para>
|
||||
<para>This operation lists the databases for the specified instance.</para>
|
||||
<note><para>This operation returns only the user-defined databases, not the system databases. The system databases (mysql,
|
||||
<note><para>This operation returns only the user-defined databases, not the system databases. The system databases (mysql,
|
||||
information_schema, lost+found) can only be viewed by a database administrator.</para></note>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -699,7 +699,7 @@
|
||||
<xsdxt:code href="../apidocs/src/resources/samples/db-list-databases-request.json"/>
|
||||
</doc>
|
||||
</representation>
|
||||
|
||||
|
||||
<representation mediaType="application/xml">
|
||||
<doc title="List Databases for Instance Paged Request: XML">
|
||||
<para xmlns="http://docbook.org/ns/docbook">The following examples show the <emphasis>paginated</emphasis> List Databases for Instance requests:</para>
|
||||
@ -726,7 +726,7 @@
|
||||
<xsdxt:code href="../apidocs/src/resources/samples/db-list-databases-response.json"/>
|
||||
</doc>
|
||||
</representation>
|
||||
|
||||
|
||||
<representation mediaType="application/xml"
|
||||
element="dbaas:Databases" >
|
||||
<doc title="List Databases for Instance Paged Response: XML">
|
||||
@ -789,14 +789,14 @@
|
||||
<para>If the corresponding request cannot be fulfilled due to insufficient or invalid data, an HTTP 400 "Bad Request" error response is returned with information regarding the nature of the failure. Failures in the validation process are non-recoverable and require the caller to correct the cause of the failure and POST the request again.</para>
|
||||
|
||||
<para>The following table lists the required attributes for Create User. Refer to the request examples for the required xml/json format:</para>
|
||||
|
||||
|
||||
<table rules="all" width="500">
|
||||
<caption>Required Attributes for Create User</caption>
|
||||
|
||||
|
||||
<thead>
|
||||
<tr>
|
||||
<td colspan="1">Applies To</td>
|
||||
<td colspan="1">Name </td>
|
||||
<td colspan="1">Name</td>
|
||||
<td colspan="2">Description</td>
|
||||
<td colspan="1">Required</td>
|
||||
</tr>
|
||||
@ -822,7 +822,7 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<note><title>Notes</title><itemizedlist>
|
||||
<listitem>
|
||||
<para>A user is granted all privileges on the specified databases.</para>
|
||||
@ -953,8 +953,8 @@
|
||||
<method name="GET" id="getUsers">
|
||||
<wadl:doc xml:lang="EN" title="List Users in Database Instance" xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Lists the users in the specified database instance.</para>
|
||||
<para>This operation lists the users in the specified database instance, along with the associated databases for that user. </para>
|
||||
<note><para>This operation does not return the system users (database administrators that administer the health of the database).
|
||||
<para>This operation lists the users in the specified database instance, along with the associated databases for that user.</para>
|
||||
<note><para>This operation does not return the system users (database administrators that administer the health of the database).
|
||||
Also, this operation returns the "root" user only if "root" user has been enabled.</para></note>
|
||||
|
||||
<para>The following notes apply to MySQL users:</para>
|
||||
@ -984,7 +984,7 @@
|
||||
<xsdxt:code href="../apidocs/src/resources/samples/db-list-users-request.json"/>
|
||||
</doc>
|
||||
</representation>
|
||||
|
||||
|
||||
<representation mediaType="application/xml">
|
||||
<doc title="List Users in Database Instance Paged Request: XML">
|
||||
<para xmlns="http://docbook.org/ns/docbook">The following examples show the <emphasis>paginated</emphasis> List Users in Database Instance requests:</para>
|
||||
@ -1012,7 +1012,7 @@
|
||||
<xsdxt:code href="../apidocs/src/resources/samples/db-list-users-response.json"/>
|
||||
</doc>
|
||||
</representation>
|
||||
|
||||
|
||||
<representation mediaType="application/xml"
|
||||
element="dbaas:Users" >
|
||||
<doc title="List Users in Database Instance Paged Response: XML">
|
||||
@ -1026,7 +1026,7 @@
|
||||
<xsdxt:code href="../apidocs/src/resources/samples/db-list-users-pagination-response.json"/>
|
||||
</doc>
|
||||
</representation>
|
||||
|
||||
|
||||
</response>
|
||||
&commonFaults;
|
||||
&getFaults;
|
||||
@ -1035,9 +1035,9 @@
|
||||
<method name="PUT" id="changePass">
|
||||
<wadl:doc xml:lang="EN" title="Change User(s) Password" xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Changes the MySQL password of one or more users.</para>
|
||||
<para>This operation changes the MySQL password of one or more users. </para>
|
||||
<note><para>For information about choosing a valid password, please refer to
|
||||
<xref linkend="POST_createUser__version___accountId__instances__instanceId__users_"/> for details.</para></note>
|
||||
<para>This operation changes the MySQL password of one or more users.</para>
|
||||
<note><para>For information about choosing a valid password, please refer to
|
||||
<xref linkend="POST_createUser__version___accountId__instances__instanceId__users_"/> for details.</para></note>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml" element="dbaas:Users">
|
||||
@ -1077,10 +1077,10 @@
|
||||
<wadl:doc xml:lang="EN" title="Delete User" xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Deletes the user identified by {name} for the specified database instance.</para>
|
||||
<para>This operation deletes the specified user for the specified database instance.</para>
|
||||
<warning><para>There is a bug in a python library that development is using that may cause incorrect user deletions to occur
|
||||
if a period (.) is used in the user name. In this case, the user name is truncated to remove the portion of the
|
||||
name from the period to the end, leaving only the portion from the beginning up to the period. For example, for a
|
||||
user named "my.userA", the bug would truncate the user name to "my", and if the user "my" exists, that user will
|
||||
<warning><para>There is a bug in a python library that development is using that may cause incorrect user deletions to occur
|
||||
if a period (.) is used in the user name. In this case, the user name is truncated to remove the portion of the
|
||||
name from the period to the end, leaving only the portion from the beginning up to the period. For example, for a
|
||||
user named "my.userA", the bug would truncate the user name to "my", and if the user "my" exists, that user will
|
||||
be incorrectly deleted. To avoid the problem, do not use periods in user names.</para></warning>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -1112,7 +1112,7 @@
|
||||
&commonFaults;
|
||||
&getFaults;
|
||||
</method>
|
||||
|
||||
|
||||
<method name="GET" id="listUser">
|
||||
<wadl:doc xml:lang="EN" title="List User" xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Lists the specified user's name and a list of databases that the user can access.</para>
|
||||
@ -1147,12 +1147,12 @@
|
||||
&commonFaults;
|
||||
&getFaults;
|
||||
</method>
|
||||
|
||||
|
||||
<method name="GET" id="getUserAccess">
|
||||
<wadl:doc xml:lang="EN" title="List User Access" xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows a list of all databases a user has access to.</para>
|
||||
<para>This operation shows a list of all databases a user has access to.</para>
|
||||
|
||||
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml">
|
||||
@ -1183,14 +1183,14 @@
|
||||
&commonFaults;
|
||||
&getFaults;
|
||||
</method>
|
||||
|
||||
|
||||
<method name="PUT" id="grantUserAccess">
|
||||
<wadl:doc xml:lang="EN" title="Grant User Access" xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Grant access for the specified user to one or more databases for the specified instance.</para>
|
||||
<para>This operation grants access for the specified user to one or more databases for the specified instance.
|
||||
The user is granted ALL privileges on the database. Refer to the information at the beginning of <xref linkend="user_management"/>
|
||||
<para>This operation grants access for the specified user to one or more databases for the specified instance.
|
||||
The user is granted ALL privileges on the database. Refer to the information at the beginning of <xref linkend="user_management"/>
|
||||
for more details on access.</para>
|
||||
|
||||
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml" element="dbaas:Database">
|
||||
@ -1221,12 +1221,12 @@
|
||||
&commonFaults;
|
||||
&getFaults;
|
||||
</method>
|
||||
|
||||
|
||||
<method name="DELETE" id="revokeUserAccess">
|
||||
<wadl:doc xml:lang="EN" title="Revoke User Access" xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Remove access to the specified database for the specified user.</para>
|
||||
<para>This operation removes access to the specified database for the specified user.</para>
|
||||
|
||||
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml">
|
||||
@ -1263,10 +1263,10 @@
|
||||
<wadl:doc xml:lang="EN" title="Enable Root User" xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Enables the root user for the specified database instance and returns the root password.</para>
|
||||
<para>This operation enables login from any host for the root user and provides the user with a generated root password.</para>
|
||||
<note><para>Changes you make as a root user may cause detrimental effects to the database instance and unpredictable behavior for API operations.
|
||||
When you enable the root user, you accept the possibility that we will not be able to support your database instance.
|
||||
While enabling root does not prevent us from a “best effort” approach to helping you if something goes wrong with your instance,
|
||||
we cannot ensure that we will be able to assist you if you change core MySQL settings. These changes can be (but are not limited to)
|
||||
<note><para>Changes you make as a root user may cause detrimental effects to the database instance and unpredictable behavior for API operations.
|
||||
When you enable the root user, you accept the possibility that we will not be able to support your database instance.
|
||||
While enabling root does not prevent us from a “best effort” approach to helping you if something goes wrong with your instance,
|
||||
we cannot ensure that we will be able to assist you if you change core MySQL settings. These changes can be (but are not limited to)
|
||||
turning off binlogs, removing users that we use to access your instance, and so forth.</para></note>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -1345,7 +1345,7 @@
|
||||
<para role="shortdesc">Lists information for all available <glossterm baseform="flavor">flavors</glossterm>.</para>
|
||||
<para>This operation lists information for all available flavors.</para>
|
||||
<para>This resource is identical to the flavors found in the OpenStack Nova API, but without the disk property.</para>
|
||||
|
||||
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml">
|
||||
@ -1380,14 +1380,14 @@
|
||||
&getFaults;
|
||||
</method>
|
||||
|
||||
|
||||
|
||||
|
||||
<method name="GET" id="getFlavorById">
|
||||
<wadl:doc xml:lang="EN" title="List Flavor By ID" xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Lists all flavor information about the specified flavor ID.</para>
|
||||
<para>This operation lists all information for the specified flavor ID with details of the RAM.</para>
|
||||
<para>This resource is identical to the flavors found in the OpenStack Nova API, but without the disk property.</para>
|
||||
<note><para>The flavorId parameter should be an integer. If a floating point value is used for the flavorId parameter,
|
||||
<note><para>The flavorId parameter should be an integer. If a floating point value is used for the flavorId parameter,
|
||||
the decimal portion is truncated and the integer portion is used as the value of the flavorId.</para></note>
|
||||
<remark security="reviewer">Reviewer / Writer: need to confirm that this behavior is not changed in subsequent releases, and if it is prevented, remove the Note above.</remark>
|
||||
</wadl:doc>
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<?xml-stylesheet type="text/xsl" href="../xslts/xslt/schema.xslt"?>
|
||||
|
||||
<schema elementFormDefault="qualified"
|
||||
<schema elementFormDefault="qualified"
|
||||
attributeFormDefault="unqualified"
|
||||
targetNamespace="http://docs.openstack.org/database/api/v1.0"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:dbaas="http://docs.openstack.org/database/api/v1.0"
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0">
|
||||
|
||||
@ -95,7 +95,7 @@
|
||||
</xsd:documentation>
|
||||
</annotation>
|
||||
</element>
|
||||
|
||||
|
||||
<!--Complex Types-->
|
||||
<complexType name="Users">
|
||||
<sequence>
|
||||
@ -107,8 +107,8 @@
|
||||
</annotation>
|
||||
</element>
|
||||
</sequence>
|
||||
</complexType>
|
||||
|
||||
</complexType>
|
||||
|
||||
<complexType name="User">
|
||||
<sequence>
|
||||
<element name="databases" type="dbaas:Database" minOccurs="0" maxOccurs="unbounded">
|
||||
@ -311,7 +311,7 @@
|
||||
</annotation>
|
||||
</attribute>
|
||||
</complexType>
|
||||
|
||||
|
||||
<xsd:complexType name="Links">
|
||||
<xsd:sequence>
|
||||
<xsd:element name="link" type="dbaas:Link" minOccurs="0" maxOccurs="unbounded">
|
||||
@ -447,7 +447,7 @@
|
||||
</enumeration>
|
||||
</restriction>
|
||||
</simpleType>
|
||||
|
||||
|
||||
<simpleType name="UserStatusType">
|
||||
<annotation>
|
||||
<xsd:documentation xml:lang="EN" xmlns="http://www.w3.org/1999/xhtml">
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user