69da9cd231
Documentation is modeled after python-novaclient docs. (http://docs.openstack.org/developer/python-novaclient/) Built preview for reviewers: https://nsaje.fedorapeople.org/python-ceilometerclient/ Change-Id: I61e9d6593e4a1aea5cf018081416d4be3a9372ac
49 lines
1.1 KiB
ReStructuredText
49 lines
1.1 KiB
ReStructuredText
The :mod:`ceilometerclient` Python API
|
|
======================================
|
|
|
|
.. module:: ceilometerclient
|
|
:synopsis: A client for the OpenStack Ceilometer API.
|
|
|
|
.. currentmodule:: ceilometerclient
|
|
|
|
Usage
|
|
-----
|
|
|
|
First create a client instance with your credentials::
|
|
|
|
>>> import ceilometerclient.client
|
|
>>> cclient = ceilometerclient.client.get_client(VERSION, username=USERNAME, password=PASSWORD, tenant_name=PROJECT_NAME, auth_url=AUTH_URL)
|
|
|
|
Here ``VERSION`` can be: ``1`` and ``2``.
|
|
|
|
Then call methods on its managers::
|
|
|
|
>>> cclient.meters.list()
|
|
[<Meter ...>, ...]
|
|
|
|
>>> cclient.samples.list()
|
|
[<Sample ...>, ...]
|
|
|
|
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)
|
|
[<Sample ...>, ...]
|
|
|
|
__ http://docs.openstack.org/developer/ceilometer/webapi/v2.html#Query
|
|
|
|
Reference
|
|
---------
|
|
|
|
For more information, see the reference:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
ref/index
|
|
ref/v1/index
|
|
ref/v2/index
|