diff options
| author | tuathail <ciaran.otuathail@hp.com> | 2015-04-13 14:20:22 +0100 |
|---|---|---|
| committer | tuathail <ciaran.otuathail@hp.com> | 2015-04-13 14:33:41 +0100 |
| commit | adf460a4f94c87a754ab0df557f8784f8f584ff9 (patch) | |
| tree | 74044951e85e2f304b16c2dfddf4901c9b8ba4f2 | |
| parent | 600657ebdcef5014dbcd14d12c2cb8100efe976b (diff) | |
| download | python-ceilometerclient-adf460a4f94c87a754ab0df557f8784f8f584ff9.tar.gz | |
Updates examples to reference new sample format
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
| -rw-r--r-- | doc/source/api.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/source/api.rst b/doc/source/api.rst index cad39b0..36c7c51 100644 --- a/doc/source/api.rst +++ b/doc/source/api.rst @@ -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 |