X-Auth-Token
HTTP
+ header. Customers obtain this token by first using the
+ Rackspace Cloud Authentication Service and supplying a
+ valid username and API access key. username
and
+ apiKey
. When you authenticate
+ successfully, the response to your authentication
+ request will include a catalog of the services to
+ which you have subscribed rather than the sample
+ values shown here.expires
attribute denotes the time
+ after which the token will automatically become
+ invalid. A token may be manually revoked before
+ the time identified by the expires
+ attribute; expires
predicts a token's
+ maximum possible lifespan but does not guarantee
+ that it will reach that lifespan. Clients are
+ encouraged to cache a token until it expires. jsmith
is the
+ administrative user for the account,
+ holding the fully-privileged
+ identity:admin
role.
+ Other users might hold other roles with
+ different privileges. Roles need not be
+ associated with actual job functions such
+ as Administrator, Operator, Developer,
+ Tester, or Trainer. type="compute"
,
+ identifying them as compute services even though the word "compute" does not appear in their names.
+ type="compute"
identifies all the
+ available compute services, one of which is named
+ cloudServers and one of which is named
+ cloudServersOpenStack. New compute service names may be added
+ in future releases; whatever the compute services are
+ named, you can always
+ recognize them by parsing for
+ type="compute"
in the authentication
+ response's service catalog. type="compute"
identifies
+ compute services such as cloudServers and
+ cloudServersOpenStack. Some developers have
+ found the service type attribute to be useful
+ in parsing the service catalog. For additional
+ information on Auth 2.0 (also known as the
+ Cloud Identity Service), refer to the
+ Region | +Endpoint | +|||||
Chicago (ORD) | +https://ord.databases.api.rackspacecloud.com/v1.0/ |
+ |||||
Dallas/Ft. Worth (DFW) | +https://dfw.databases.api.rackspacecloud.com/v1.0/ |
+ |||||
London (LON) | +
+ https://lon.databases.api.rackspacecloud.com/v1.0/ |
+
publicURL
field returned
+ by the authentication response. For example, in publicURL
field for
+ cloudServers
+ ("https://servers.api.rackspacecloud.com/v1.0/Content-Type
header
+ and is Accept
header or by adding an
+ .xml
or .json
extension
+ to the request URI. Note that it is possible for a
+ response to be serialized using a format different
+ from the request. If no response format is specified,
+ JSON is the default. If conflicting formats are
+ specified using both an Accept
header and
+ a query extension, the query extension takes
+ precedence.Format | +Accept Header | +Query Extension | +Default | +
JSON | +application/json | +.json | +Yes | +
XML | +application/xml | +.xml | +No | +
ATOM | +application/atom+xml | +.atom | +No | +
Attribute | +Description | +|||
jobId | +An identifier for the specific request. | +|||
callbackUrl | +Resource locator for querying the status of the request. | +
Accept-Encoding
header on the request from the client and indicated
+ by the Content-Encoding
header in the server response. Unless the
+ header is explicitly set, encoding defaults to disabled. Header Type | +Name | +Value | +
HTTP/1.1 Request | +Accept-Encoding |
+ gzip | +
HTTP/1.1 Response | +Content-Encoding |
+ gzip | +
Verb | +URI | +RegEx | +Default | +||
&GET; changes-since | +*/instances/* | +^/vd+.d+/instances.* | +3/minute | +||
&POST; | +*/instances/* | +^/vd+.d+/instances.* | +10/minute | +||
&POST; instances | +*/instances/* | +^/vd+.d+/instances.* | +50/day | +||
&PUT; | +*/instances/* | +^/vd+.d+/instances.* | +10/minute | +||
&DELETE; | +*/instances/* | +^/vd+.d+/instances.* | +100/minute | +
Retry-After
header to
+ notify the client when it can attempt to try
+ again. Name | +Description | +Limit | +||
Instances | +Maximum number of instances allowed + for your account | +5 | +||
Volume Size | +Maximum volume size per + instance in gigabytes (GB) for your + account | +50 | +
Code | +Description | +
yyyy | +Four digit year | +
MM | +Two digit month | +
dd | +Two digit day of month | +
T | +Separator for date/time | +
HH | +Two digit hour of day (00-23) | +
mm | +Two digit minutes of hour | +
ss | +Two digit seconds of the minute | +
SSS | +Three digit milliseconds of the second | +
Z | +RFC-822 timezone | +
?limit=10&marker=1234
. Items are
+ displayed sorted by ID. {"href": "<url>", "rel": "next"}
.
+ Any response that is truncated by pagination will have
+ a ?limit=2
), so the responses
+ that follow each show 2 instances and return a
+ ?marker=4137d6a4-03b7-4b66-b0ef-8c7c35c470d3
).
+ Also a link is provided to retrieve the next 2 results
+ (limit=2
) in the link element
+ identified by the attribute rel="next"
+ (XML) or "rel":"next"
(JSON):badRequest
unauthorized
forbidden
itemNotFound
badMethod
overLimit
details
element for more specifics. Contact support
+ if you think you need higher request rate limits.badMediaType
unprocessableEntity
instanceFault
notImplemented
serviceUnavailable
instanceFault
+ examples show errors when the server has erred or
+ cannot perform the requested operation:code
) is returned in the body of the response for
+ convenience. The message
element returns a human-readable message that
+ is appropriate for display to the end user. The details
element is
+ optional and may contain information that is useful for tracking down an error, such
+ as a stack trace. The details
element may or may not be appropriate for
+ display to an end user, depending on the role and experience of the end user.instanceFault
) may change depending
+ on the type of error. badRequest
examples
+ show errors when the volume size is invalid:itemNotFound
errors:your_username
your_api_key
X-Auth-Token
header. https://identity.api.rackspacecloud.com/v2.0/tokens
,
+ as shown in the following Authenticate Request examples.
+ Note that the v2.0
component in the URL
+ indicates that you are using version 2.0 of the Cloud Auth
+ API.'https://lon.identity.api.rackspacecloud.com/v2.0/tokens'
+ instead.id
is returned
+ along with an expires
attribute that
+ specifies when the token expires. id
attribute in the
+ Authenticate Response specifies the
+ authentication token. Tokens are valid for a
+ finite duration.expires
attribute denotes
+ the time after which the token will
+ automatically become invalid. A token may be
+ manually revoked before the time identified by
+ the expires attribute; expires
+ predicts a token's maximum possible lifespan
+ but does not guarantee that it will reach that
+ lifespan. Clients are encouraged to cache a
+ token until it expires.publicURL
endpoints for
+ cloudDatabases
(for example
+ https://ord.databases.api.rackspacecloud.com/v1.0/1100111
)
+ are also returned in the response. publicURL
field. In this example,
+ you can see that the account number is 1100111. You need
+ to specify your account number on most of the Cloud
+ Databases API calls, wherever you see the field Region | +Endpoint | +|||||
Chicago (ORD) | +https://ord.databases.api.rackspacecloud.com/v1.0/ |
+ |||||
Dallas/Ft. Worth (DFW) | +https://dfw.databases.api.rackspacecloud.com/v1.0/ |
+ |||||
London (LON) | +
+ https://lon.databases.api.rackspacecloud.com/v1.0/ |
+
https://ord.databases.api.rackspacecloud.com/v1.0/your_acct_id/
),
+ as you can see in the cURL List Flavors Details Request
+ examples in /flavors
) to find the available
+ configurations for your database instance, and then decide
+ which size you need.name
that there are multiple flavors
+ available, including medium
(with 1 virtual
+ CPU and 2 gigabytes of memory) and tiny
(with
+ 1 virtual CPU and 0.5 gigabytes of memory). self
link
+ contains a bookmark
link provides a
+ permanent link to a flavor resource that is appropriate
+ for long term storage and works across API
+ versions.myrackinstance
, with the following: sampledb
with:utf8
character
+ setutf8_general_ci
+ collationsimplestUser
with
+ password password
flavorRef
) to the tiny flavor (id 1)
+ that was returned by the List Flavors Details call:
+ "https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1"
.
+ This is the self
link that is the versioned
+ link to the flavor resource. Refer to the response
+ examples in flavorRef
property for the examples with
+ your actual account id:
+ "https://ord.databases.api.rackspacecloud.com/v1.0/
/flavors/1"
.
+ Rather than the flavor URI shown in the previous sentence,
+ you can also pass the flavor id (integer) as the value for
+ flavorRef. For example, the flavor id for the flavor URI
+ shown above is "1". id="d379ba5c-9a1f-4aa9-9a17-afe237d04c65"
)
+ on subsequent API calls that require it, for example List
+ Databases for Instance.sampledb
was
+ successfully created. Next you will list the users.simplestUser
was
+ successfully created.hostname
returned and the request
+ examples for the user name and password you
+ specified./etc/phpmyadmin/config-db.php
+ config file to point to your database
+ instance:publicURL
field returned
+ by the authentication response. In the following
+ example, you can see from the publicURL
+ field for cloudServers
+ (publicURL="https://servers.api.rackspacecloud.com/v1.0/322781")
+ that the account number is 322781.Content-Type
header
+ and is Accept
header or by adding an
+ .xml
or .json
extension
+ to the request URI. Note that it is possible for a
+ response to be serialized using a format different
+ from the request. If no response format is specified,
+ JSON is the default. If conflicting formats are
+ specified using both an Accept
header and
+ a query extension, the query extension takes
+ precedence.Format | +Accept Header | +Query Extension | +Default | +
JSON | +application/json | +.json | +Yes | +
XML | +application/xml | +.xml | +No | +
ATOM | +application/atom+xml | +.atom | +No | +
Attribute | +Description | +|||
jobId | +An identifier for the specific request. | +|||
callbackUrl | +Resource locator for querying the status of the request. | +
Accept-Encoding
header on the request from the client and indicated
+ by the Content-Encoding
header in the server response. Unless the
+ header is explicitly set, encoding defaults to disabled. Header Type | +Name | +Value | +
HTTP/1.1 Request | +Accept-Encoding |
+ gzip | +
HTTP/1.1 Response | +Content-Encoding |
+ gzip | +
Verb | +URI | +RegEx | +Default | +||
&GET; changes-since | +*/instances/* | +^/vd+.d+/instances.* | +3/minute | +||
&POST; | +*/instances/* | +^/vd+.d+/instances.* | +10/minute | +||
&POST; instances | +*/instances/* | +^/vd+.d+/instances.* | +50/day | +||
&PUT; | +*/instances/* | +^/vd+.d+/instances.* | +10/minute | +||
&DELETE; | +*/instances/* | +^/vd+.d+/instances.* | +100/minute | +
Retry-After
header to
+ notify the client when it can attempt to try
+ again. Name | +Description | +Limit | +||
Instances | +Maximum number of instances allowed + for your account | +5 | +||
Volume Size | +Maximum volume size per + instance in gigabytes (GB) for your + account | +25 | +
Code | +Description | +
yyyy | +Four digit year | +
MM | +Two digit month | +
dd | +Two digit day of month | +
T | +Separator for date/time | +
HH | +Two digit hour of day (00-23) | +
mm | +Two digit minutes of hour | +
ss | +Two digit seconds of the minute | +
SSS | +Three digit milliseconds of the second | +
Z | +RFC-822 timezone | +
limit
and offset
respectively, and both apply only to
+ &GET; calls. If unspecified, they default to limit=100
and
+ offset=0
. See the examples that follow.totalEntries
attribute
+ representing the total number of entries there are for this item type. If the
+ number of items requested in the &GET; call is less then the total number of
+ items for this type, then there will be pagination links previous
+ and/or next
, specifying how to get to the previous and/or next set
+ of records. previous
and/or next
link elements are
+ displayed only if there are items available in the corresponding link. See
+ the following examples for details.totalEntries=112
and that a link has been provided to retrieve
+ the next 3 results (limit=3
) in the link element identified by the
+ attribute rel="next"
(XML) or "rel":"next"
(JSON). offset=3
):totalEntries=112
and two links have been provided to:limit=3
) via the link
+ element identified by the attribute rel="next"
(XML) or
+ "rel":"next"
(JSON)rel="previous"
(XML) or
+ "rel":"previous"
(JSON) badRequest
unauthorized
forbidden
itemNotFound
badMethod
overLimit
details
element for more specifics. Contact support
+ if you think you need higher request rate limits.badMediaType
unprocessableEntity
instanceFault
notImplemented
serviceUnavailable
instanceFault
+ examples show errors when the server has erred or
+ cannot perform the requested operation:code
) is returned in the body of the response for
+ convenience. The message
element returns a human-readable message that
+ is appropriate for display to the end user. The details
element is
+ optional and may contain information that is useful for tracking down an error, such
+ as a stack trace. The details
element may or may not be appropriate for
+ display to an end user, depending on the role and experience of the end user.instanceFault
) may change depending
+ on the type of error. badRequest
examples
+ show errors when the volume size is invalid:itemNotFound
errors:updated
+ attribute to the response from the List Versions
+ API call.max_allowed_packet
default to 16
+ MB.open_files_limit
based on flavor
+ size.Applies To | +Name | +Description | +Required | +||
Instance | +flavorRef | +Yes | +|||
(volume) size | +Specifies the volume size in gigabytes (GB). The value specified must be between 1 and 50. | +Yes | +|||
name | +Name of the instance to create. The length of the name is limited to 255 characters and any characters are permitted. | +No | +|||
Database | +name | +Specifies |
+ No | +||
character_set | +Set of symbols and encodings. The default character set is utf8 . |
+ No | +|||
collate | +Set of rules for comparing characters in a character set. The default value for collate is utf8_general_ci . |
+ No | +|||
User | +name | +Specifies user name for the database on instance creation. Refer to |
+ No | +||
password | +Specifies password for those users on instance creation. Refer to |
+ No | +|||
(database) name | +Specifies names of databases that those users can access on instance creation. Refer to |
+ No | +
self
link contains a bookmark
+ link provides a permanent link to a resource that is appropriate for long term storage.REBUILDING
or BUILDING
.used
size of your volume will be
+ greater than 0. This is expected and due to the automatic creation of
+ non-empty transaction logs for mysql optimization. The used
attribute is name
of the database is a required attribute.collate
and character_set
.Name | +Description | +Required | +||
name | +Specifies the database name for creating the database. Refer to the request examples for the required xml/json format. | +Yes | +||
character_set | +Set of symbols and encodings. The default character set is utf8 . |
+ No | +||
collate | +Set of rules for comparing characters in a character set. The default value for collate is utf8_general_ci . |
+ No | +
Character | +
Letters (upper and lower cases allowed) | +
Numbers | +
'@', '?', '#', and spaces are allowed, but |
+
'_' is allowed anywhere in the database name | +
Character | +
Single quotes | +
Double quotes | +
Back quotes | +
Semicolons | +
Commas | +
Backslashes | +
Forwardslashes | +
Restriction | +Value | +
Database-name maximum length | +64 | +
Applies To | +Name | +Description | +Required | +|
User | +name | +Name of the user for the + database. | +Yes | +|
password | +User password for database + access. | +Yes | +||
(database) name | +No | +
Character | +
Letters (upper and lower cases allowed) | +
Numbers | +
'@', '?', '#', and spaces are allowed, but |
+
"_" is allowed anywhere in the database name, user name, and password | +
Character | +
Single quotes | +
Double quotes | +
Back quotes | +
Semicolons | +
Commas | +
Backslashes | +
Forwardslashes | +
Spaces at the front or end of the user name or password | +
Restriction | +Value | +
Database name maximum length | +64 | +
User name maximum length | +16 | +
Password maximum length | +unlimited (no restrictions) | +
+ This is the main index XML Schema document + for DBaaS API Schema Types Version 1.0. +
+A MySQL User.
+A MySQL User.
+A Database Instance.
+Database Instances.
+Settings such as memory used to create a database instance.
+A list of flavors.
+A Database.
+List of Databases.
+Restart the Database
+Resize an Instance
+A list of database user names.
+A list of databases.
+The name for the user.
+The password for the user.
+The status of the user.
+A list of database instances.
+A list of optional databases.
+A list of optional users.
+The links for the type of instance.
+The volume attached to the instance.
+A unique database instance id.
+Date/Time the instance was created.
+Date/Time the instance was last updated.
+The name for the instance.
+The flavor reference of the instance.
+The status of the instance.
+The hostname attached to the instance.
+Whether or not root is enabled for the instance.
+The type of link.
+The URL.
+The type of link.
+A list of flavors.
+A list of links.
+A unique flavor id.
+The name for the instance.
+The RAM in megabytes.
+A list of links.
+A list of databases.
+The Database character set.
+The name for the instance.
+The Collation type of the database.
+Whether or not root is enabled for the given instance.
+Size of the volume in GBs.
+Used space on the attached volume in GBs.
+A unique flavor id.
+The volume attached to the instance.
+New flavorRef to size the instance.
+The instance status.
+Healthy status.
+Down status.
+unavailable status.
+The mysql user status.
+Enabled status.
++ A human readable message that is appropriate for display + to the end user. +
++ The optional <details> element may contain useful + information for tracking down errors (e.g a stack + trace). This information may or may not be appropriate + for display to an end user. +
++ The HTTP status code associated with the current fault. +
++ An optional dateTime denoting when an operation should + be retried. +
+true
, deleted instances are listed. If false
, deleted instances are not listed.
+ deleted
query parameter to list only the deleted or not deleted instances.Name | +Description | +||
version | +The version of the guest installed on the instance. | +||
fdSize | +Number of file descriptor slots currently allocated. | +||
vmSize | +Virtual memory size. | +||
vmPeak | +Peak virtual memory size. | +||
vmRss | +Resident set size. | +||
vmHwm | +Peak resident set size ("high water mark"). | +||
threads | +Number of threads in process containing this thread. | +
Name | +Description | +||
mem_total | +Total memory an instance sees. | +||
num_cpus | +Number of CPUs an instance sees. | +
This schema defines entity contains entities related to the dbaas Management API.
+Information about a Host.
+List of Hosts.
+Information about storage devices.
+Information about Account.
+Details of a configuration item
+List of Configs.
+Details of a configuration item
+Diagnostic details of a guest.
+Reboot an Instance
+A list of Host names.
+Timestamp of the first time MySQL root was enabled for the instance.
+ID of the first user to enable MySQL root for the instance.
+A list of database instances, with additional management information.
+A single database instance, with some additional management information.
+A list of database index instances, with some additional management information.
+A list of database instances on the Host.
+The name of the Host.
+The percent of the used RAM on the Host.
+The total amount of RAM on the Host.
+The used amount of RAM on the Host.
+A storage device on the Host.
+The id of the storage device.
+The name of the storage device.
+The type of the storage device.
+The available size of the storage device.
+The total size of the storage device.
+The name of the account.
+List of hosts that the Account has instances running on.
+A configuration entry
+The configuration entry key
+The value of the configuration entry
+The description of the configuration entry
+The instance id of that is checked by the call.
+The date timestamp that a user enabled root on the instance.
+The user that enabled root on the instance.
+The version of the guest installed on the instance.
+Number of file descriptor slots currently allocated.
+Virtual memory size.
+Peak virtual memory size.
+Resident set size.
+Peak resident set size ("high water mark").
+Number of threads in process containing this thread.
+