Jump to: navigation, search

Difference between revisions of "Zaqar/specs/api/v1/marconi-config"

(Marconi API Limits)
(Description)
Line 19: Line 19:
  
 
This variable controls:
 
This variable controls:
* The max integral value of the URI parameter "limit" a client can use a [[Marconi/specs/api/v1#List_Queues]] request URI, thus, the maxinum number of queues a client can expect in a response's JSON array.  The default value is 20, which means, a request like the following:
+
* The max integral value of the URI parameter "limit" a client can use in a [[Marconi/specs/api/v1#List_Queues]] request URI, thus, the maxinum number of queues a client can expect in the response's JSON array.  The default value is 20, which means, a request like the following:
  
 
   GET /v1/queues?limit=30
 
   GET /v1/queues?limit=30
 +
 +
will result in '''400 Bad Request''' response.
 +
 +
<tt>message_paging_uplimit</tt>
 +
 +
This variable controls the following API endpoints:
 +
* The maxinum number of messages a client can send in a [[Marconi/specs/api/v1#Post_Message(s)]] request's JSON array.  The default value is 20, which means, a request like the following:
 +
 +
 
 +
  POST /v1/queues/noein/messages HTTP/1.1
 +
  Host: marconi.example.com
 +
 
 +
  ...
 +
 
 +
  [
 +
    { "ttl": 300, "body": "msg1" },
 +
    { "ttl": 300, "body": "msg2" },
 +
    ...
 +
 
 +
    { "ttl": 300, "body": "msg21" }
 +
  ]
 +
 +
will result in '''400 Bad Request''' response.
 +
 +
* The max integral value of the URI parameter "limit" in a [[Marconi/specs/api/v1#List_Messages]] request URI, thus the maxinum number of messages a client can expect in the "messages" section of the response's JSON object.  The default value is 20, which means, a request like the following:
 +
 +
 +
  GET /v1/queues/noein/messages?limit=21
  
 
will result in '''400 Bad Request''' response.
 
will result in '''400 Bad Request''' response.

Revision as of 14:25, 14 August 2013

Marconi API Limits

Config Options & Default Values:

The following limits can be changed in marconi.conf, under the [limits:transport] section.

  • queue_paging_uplimit – 20
  • message_paging_uplimit – 20
  • message_ttl_max – 1209600 (seconds, 14 days)
  • claim_ttl_max – 43200 (seconds, 12 hours)
  • claim_grace_max – 43200 (seconds, 12 hours)
  • metadata_size_uplimit – 65536 (bytes, 64 KiB)
  • message_size_uplimit – 262144 (bytes, 256 KiB)
Description

queue_paging_uplimit

This variable controls:

  • The max integral value of the URI parameter "limit" a client can use in a Marconi/specs/api/v1#List_Queues request URI, thus, the maxinum number of queues a client can expect in the response's JSON array. The default value is 20, which means, a request like the following:
 GET /v1/queues?limit=30

will result in 400 Bad Request response.

message_paging_uplimit

This variable controls the following API endpoints:

  • The maxinum number of messages a client can send in a Marconi/specs/api/v1#Post_Message(s) request's JSON array. The default value is 20, which means, a request like the following:


 POST /v1/queues/noein/messages HTTP/1.1
 Host: marconi.example.com
 
 ...
 
 [
   { "ttl": 300, "body": "msg1" },
   { "ttl": 300, "body": "msg2" },
   ...
 
   { "ttl": 300, "body": "msg21" }
 ]

will result in 400 Bad Request response.

  • The max integral value of the URI parameter "limit" in a Marconi/specs/api/v1#List_Messages request URI, thus the maxinum number of messages a client can expect in the "messages" section of the response's JSON object. The default value is 20, which means, a request like the following:


 GET /v1/queues/noein/messages?limit=21

will result in 400 Bad Request response.