openstack/python-ceilometerclient
Code Issues Proposed changes

Updates examples to reference new sample format

Browse Source 
The list function for the new Sample Manager no longer takes a
meter_name parameter. It must be submitted as part of the query.
The changes reflect the new format.

Change-Id: I2c9346ce605b3f576a761f6162a5dcf49e4686ee
Closes-Bug:1443383
This commit is contained in:
tuathail
2015-04-13 14:20:22 +01:00
parent 600657ebdc
commit adf460a4f9
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/api.rst
View File

@@ -21,7 +21,7 @@ Then call methods on its managers::
>>> cclient.meters.list()
[<Meter ...>, ...]
>>> cclient.samples.list()
>>> cclient.new_samples.list()
[<Sample ...>, ...]
V2 client tips
@@ -29,8 +29,8 @@ V2 client tips
Use queries to narrow your search (more info at `Ceilometer V2 API reference`__)::
>>> query = [dict(field='resource_id', op='eq', value='5a301761-f78b-46e2-8900-8b4f6fe6675a')]
>>> ceilometer.samples.list(meter_name='cpu_util', limit=10, q=query)
>>> query = [dict(field='resource_id', op='eq', value='5a301761-f78b-46e2-8900-8b4f6fe6675a'), dict(field='meter',op='eq',value='cpu_util')]
>>> cclient.new_samples.list(q=query, limit=10)
[<Sample ...>, ...]
__ http://docs.openstack.org/developer/ceilometer/webapi/v2.html#Query