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

Revision as of 14:03, 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 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:

 GET /v1/queues?limit=30

will result in 400 Bad Request response.

@@ Line 3: / Line 3: @@
 ===== Config Options & Default Values: =====
-'''NOTE:''' The default limits can be changed in <tt>marconi.conf</tt>
+The following limits can be changed in <tt>marconi.conf</tt>, under the
+<tt>[limits:transport]</tt> section.
-# queue_paging_uplimit – 20
+* queue_paging_uplimit – 20
-# message_paging_uplimit – 20
+* message_paging_uplimit – 20
-# message_ttl_max – 1209600 (seconds, 14 days)
+* message_ttl_max – 1209600 (seconds, 14 days)
-# claim_ttl_max – 43200 (seconds, 12 hours)
+* claim_ttl_max – 43200 (seconds, 12 hours)
-# claim_grace_max – 43200 (seconds, 12 hours)
+* claim_grace_max – 43200 (seconds, 12 hours)
-# metadata_size_uplimit – 65536 (bytes, 64 KiB)
+* metadata_size_uplimit – 65536 (bytes, 64 KiB)
-# message_size_uplimit – 262144 (bytes, 256 KiB)
+* message_size_uplimit – 262144 (bytes, 256 KiB)
-===== Predefined API Limits: =====
+===== Description =====
-'''NOTE:''' These values are not changeable.
+<tt>queue_paging_uplimit</tt>
-# message_ttl_min – 60 (seconds)
+This variable controls:
-# claim_ttl_min – 60 (seconds)
+* 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:
-# claim_grace_min – 60 (seconds)
+  GET /v1/queues?limit=30
+will result in '''400 Bad Request''' response.