openstack/aodh
Code Issues Proposed changes

Add note on aggregate duplication to API docco

Browse Source 
Provide some additional clarity on allowable duplication
in the selectable aggregates passed to a statistics query.

Change-Id: If534e0667aa08fd531bbf31032e7648f7b80890c
This commit is contained in:
Eoghan Glynn
2014-03-28 16:36:29 +00:00
parent 1f0acff1c5
commit 0595402c25
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/webapi/v2.rst
View File

@@ -48,8 +48,13 @@ standard set by specifying an aggregate function in the statistics query::
GET /v2/meters/<meter_name>/statistics?aggregate.func=<name>&aggregate.param=<value>
(where aggregate.param is optional). See the :ref:`functional-examples`
section for more detail.
(where aggregate.param is optional).
Duplicate aggregate function and parameter pairs are silently discarded from the statistics query. Partial duplicates, in the sense of the same function but differing parameters, for example::
GET /v2/meters/<meter_name>/statistics?aggregate.func=cardinality&aggregate.param=resource_id&aggregate.func=cardinality&aggregate.param=project_id
are, on the other hand, both allowed by the API and supported by the storage drivers. See the :ref:`functional-examples` section for more detail.
.. note:: Currently only *cardinality* needs aggregate.param to be specified.