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: