Post message#

POST /v1/{project_id}/queues/{queue_name}/messages

This operation posts the specified message or messages.

You can submit up to 10 messages in a single request, but you must always encapsulate the messages in a collection container (an array in JSON, even for a single message - without the JSON array, you receive the "Invalid request body" message). The resulting value of the Location header or response body might be used to retrieve the created messages for further processing.

The client specifies only the body and TTL for the message. The server inserts metadata, such as ID and age.

The response body contains a list of resource paths that correspond to each message submitted in the request, in the order of the messages. If a server-side error occurs during the processing of the submitted messages, a partial list is returned, the partial parameter is set to true, and the client tries to post the remaining messages again. If the server cannot enqueue any messages, the server returns a 503 Service Unavailable error message.

The body parameter specifies an arbitrary document that constitutes the body of the message being sent.

The following rules apply for the maximum size:

• The maximum size of posted messages is the maximum size of the entire request document (rather than the sum of the individual message body field values as it was in earlier releases). On error, the client will now be notified of how much it exceeded the limit.
• The size is limited to 256 KB, including whitespace.

The document must be valid JSON. (Cloud Queues validates it.)

The ttl parameter specifies how long the server waits before marking the message as expired and removing it from the queue. The value of ttl must be between 60 and 1209600 seconds (14 days). Note that the server might not actually delete the message until its age has reached up to (ttl + 60) seconds, to allow for flexibility in storage implementations.

The following table shows the possible response codes for this operation:

POST /v1/queues/demoqueue/messages HTTP/1.1
Host: ord.queues.api.rackspacecloud.com
Content-type: application/json
Client-ID: e58668fc-26eb-11e3-8270-5b3128d43830
X-Auth-Token: 0f6e9f63600142f0a970911583522217
Accept: application/json
X-Project-Id: 806067

[
   {
      "ttl":300,
      "body":{
         "event":"BackupStarted"
      }
   },
   {
      "ttl":60,
      "body":{
         "play":"hockey"
      }
   }
]

HTTP/1.1 201 Created
Content-Length: 149
Content-Type: application/json; charset=utf-8
Location: /v1/queues/demoqueue/messages?ids=51db6f78c508f17ddc924357,51db6f78c508f17ddc924358

{
   "partial":false,
   "resources":[
      "/v1/queues/demoqueue/messages/51db6f78c508f17ddc924357",
      "/v1/queues/demoqueue/messages/51db6f78c508f17ddc924358"
   ]
}

Get messages#

GET /v1/{project_id}/queues/{queue_name}/messages

This operation gets the message or messages in the specified queue.

Message IDs and markers are opaque strings. Clients should make no assumptions about their format or length. Furthermore, clients should assume that there is no relationship between markers and message IDs (that is, one cannot be derived from the other). This allows for a wide variety of storage driver implementations.

Results are ordered by age, oldest message first.

A request to list messages when the queue is not found or when messages are not found returns 204, instead of 200, because there was no information to send back. Messages with malformed IDs or messages that are not found by ID are ignored.

The following table shows the possible response codes for this operation:

GET /v1/queues/demoqueue/messages?echo=true HTTP/1.1
Host: ord.queues.api.rackspacecloud.com
Content-type: application/json
Client-ID: e58668fc-26eb-11e3-8270-5b3128d43830
X-Auth-Token: 0f6e9f63600142f0a970911583522217
Accept: application/json
X-Project-Id: 806067

HTTP/1.1 204 No Content

HTTP/1.1 200 OK
Content-Length: 602
Content-Type: application/json; charset=utf-8
Content-Location: /v1/queues/demoqueue/messages?echo=true

{
   "messages":[
      {
         "body":{
            "event":"BackupStarted"
         },
         "age":198,
         "href":"/v1/queues/demoqueue/messages/51db6ecac508f17ddc9242ad",
         "ttl":300
      },
      {
         "body":{
            "event":"BackupStarted"
         },
         "age":97,
         "href":"/v1/queues/demoqueue/messages/51db6f2f821e727dc24df623",
         "ttl":300
      },
      {
         "body":{
            "event":"BackupStarted"
         },
         "age":24,
         "href":"/v1/queues/demoqueue/messages/51db6f78c508f17ddc924357",
         "ttl":300
      },
      {
         "body":{
            "play":"hockey"
         },
         "age":24,
         "href":"/v1/queues/demoqueue/messages/51db6f78c508f17ddc924358",
         "ttl":60
      }
   ],
   "links":[
      {
         "href":"/v1/queues/demoqueue/messages?marker=8&echo=true",
         "rel":"next"
      }
   ]
}

Get messages by ID#

GET /v1/{project_id}/queues/{queue_name}/messages

This operation provides a more efficient way to query multiple messages compared to using a series of individual GET s. Note that the list of IDs cannot exceed 20. If a malformed ID or a nonexistent message ID is provided, it is ignored, and the remaining messages are returned.

Unlike the get messages operation, a client's own messages are always returned in this operation. If you use the ids parameter, the echo parameter is not used and is ignored if it is specified.

The message body parameters are defined as follows:

• href is an opaque relative URI that the client can use to uniquely identify a message resource and interact with it.
• ttl is the TTL that was set on the message when it was posted. The message expires after (ttl - age) seconds.
• age is the number of seconds relative to the server's clock.
• body is the arbitrary document that was submitted with the original request to post the message.

The following table shows the possible response codes for this operation:

GET /v1/queues/demoqueue/messages?ids=51db6f78c508f17ddc924357,51db6ecac508f17ddc9242ad HTTP/1.1
Host: ord.queues.api.rackspacecloud.com
Content-type: application/json
X-Auth-Token: 0f6e9f63600142f0a970911583522217
Client-ID: e58668fc-26eb-11e3-8270-5b3128d43830
Accept: application/json
X-Project-Id: 806067

HTTP/1.1 200 OK
Content-Location: /v1/queues/fizbat/messages?ids=50b68a50d6f5b8c8a7c62b01,f5b8c8a7c62b0150b68a50d6

[
   {
      "href":"/v1/queues/fizbit/messages/50b68a50d6f5b8c8a7c62b01",
      "ttl":800,
      "age":32,
      "body":{
         "cmd":"EncodeVideo",
         "jobid":58229
      }
   },
   {
      "href":"/v1/queues/fizbit/messages/f5b8c8a7c62b0150b68a50d6",
      "ttl":800,
      "age":790,
      "body":{
         "cmd":"EncodeAudio",
         "jobid":58201
      }
   }
]

Bulk-delete messages by ID#

DELETE /v1/{project_id}/queues/{queue_name}/messages

This operation immediately deletes the specified messages. If any of the message IDs are malformed or non-existent, they are ignored. The remaining valid messages IDs are deleted.

The following table shows the possible response codes for this operation:

DELETE /v1/queues/demoqueue/messages?ids=50b68a50d6f5b8c8a7c62b01,50b68a50d6f5b8c8a7c62b02 HTTP/1.1
Host: ord.queues.api.rackspacecloud.com
Content-type: application/json
X-Auth-Token: 0f6e9f63600142f0a970911583522217
Client-ID: e58668fc-26eb-11e3-8270-5b3128d43830
Accept: application/json
X-Project-Id: 806067

HTTP/1.1 204 No Content

Show message details#

GET /v1/{project_id}/queues/{queue_name}/messages/{messageId}

This operation shows details for the specified message from the specified queue.

If either the message ID is malformed or nonexistent, no message is returned.

Message body parameters are defined as follows:

• href is an opaque relative URI that the client can use to uniquely identify a message resource and interact with it.
• ttl is the TTL that was set on the message when it was posted. The message expires after (ttl - age) seconds.
• age is the number of seconds relative to the server's clock.
• body is the arbitrary document that was submitted with the original request to post the message.

The following table shows the possible response codes for this operation:

GET /v1/queues/demoqueue/messages/51db6ecac508f17ddc9242ad HTTP/1.1
Host: ord.queues.api.rackspacecloud.com
Content-type: application/json
X-Auth-Token: 0f6e9f63600142f0a970911583522217
Client-ID: e58668fc-26eb-11e3-8270-5b3128d43830
Accept: application/json
X-Project-Id: 806067

HTTP/1.1 200 OK
Content-Length: 126
Content-Type: application/json; charset=utf-8
Content-Location: /v1/queues/demoqueue/messages/51db6ecac508f17ddc9242ad

{
   "body":{
      "event":"BackupStarted"
   },
   "age":240,
   "href":"/v1/queues/demoqueue/messages/51db6ecac508f17ddc9242ad",
   "ttl":300
}

Delete message#

DELETE /v1/{project_id}/queues/{queue_name}/messages/{messageId}

This operation immediately deletes the specified message.

The claim_id parameter specifies that the message is deleted only if it has the specified claim ID and that claim has not expired. This specification is useful for ensuring only one worker processes any given message. When a worker's claim expires before it can delete a message that it has processed, the worker must roll back any actions it took based on that message because another worker can now claim and process the same message.

If you do not specify claim_id, but the message is claimed, the operation fails. You can only delete claimed messages by providing an appropriate claim_id.

The following table shows the possible response codes for this operation:

DELETE /v1/queues/demoqueue/messages/51db6f78c508f17ddc924358 HTTP/1.1
Host: ord.queues.api.rackspacecloud.com
Content-type: application/json
X-Auth-Token: 0f6e9f63600142f0a970911583522217
Client-ID: e58668fc-26eb-11e3-8270-5b3128d43830
Accept: application/json
X-Project-Id: 806067

HTTP/1.1 204 No Content