Telemetry API v2 (CURRENT)

Manages alarms, meters, samples, resources, and capabilities through a set of services:

  • Aodh. An alarm service.

  • Ceilometer . A data collection service.

  • Gnocchi. A time-series database and resource indexing service.

If Gnocchi is enabled, meters, samples, and resources API operations return the 410 response code.

Alarms

Lists, creates, gets details for, updates, and deletes alarms.

GET
/v2/alarms
List alarms

Lists alarms, based on a query.

 
Normal response codes
200
Request parameters
Parameter Style Type Description
q (Optional) query xsd:list

Filters the response by one or more arguments.

For example: ?q.field=Foo&q.value=my_text.

Response parameters
Parameter Style Type Description
alarm_id plain csapi:UUID

The UUID of the alarm.

description plain xsd:string

Describes the alarm.

enabled plain xsd:boolean

If true, evaluation and actioning is enabled for the alarm.

name plain xsd:string

The name of the alarm.

project_id plain csapi:UUID

The UUID of the project.

repeat_actions plain xsd:boolean

If set to true, the alarm notifications are repeated. Otherwise, this value is false.

state plain xsd:string

The state of the alarm.

state_timestamp plain xsd:dateTime

The date and time of the alarm state.

timestamp plain xsd:dateTime

The date and time of the alarm.

user_id plain csapi:UUID

The UUID of the user.

type plain xsd:string

The type of the alarm, which is either threshold or combination.

threshold_rule plain xsd:string

The rules for the threshold alarm type.

combination_rule plain xsd:string

The rules for the combination alarm type.

alarm_actions plain xsd:list

The list of actions that the alarm performs.

insufficient_data_actions plain xsd:list

The list of actions that the alarm performs when the alarm state is insufficient_data.

ok_actions plain xsd:list

The list of actions that the alarm performs when the alarm state is ok.

[
    {
        "alarm_actions": [
            "http://site:8000/alarm"
        ],
        "alarm_id": null,
        "combination_rule": null,
        "description": "An alarm",
        "enabled": true,
        "insufficient_data_actions": [
            "http://site:8000/nodata"
        ],
        "name": "SwiftObjectAlarm",
        "ok_actions": [
            "http://site:8000/ok"
        ],
        "project_id": "c96c887c216949acbdfbd8b494863567",
        "repeat_actions": false,
        "state": "ok",
        "state_timestamp": "2013-11-21T12:33:08.486228",
        "threshold_rule": null,
        "timestamp": "2013-11-21T12:33:08.486221",
        "type": "threshold",
        "user_id": "c96c887c216949acbdfbd8b494863567"
    }
]
<?xml version="1.0" encoding="UTF-8"?>
<values>
    <value>
        <alarm_actions>
            <item>http://site:8000/alarm</item>
        </alarm_actions>
        <alarm_id nil="true" />
        <combination_rule nil="true" />
        <description>An alarm</description>
        <enabled>true</enabled>
        <insufficient_data_actions>
            <item>http://site:8000/nodata</item>
        </insufficient_data_actions>
        <name>SwiftObjectAlarm</name>
        <ok_actions>
            <item>http://site:8000/ok</item>
        </ok_actions>
        <project_id>c96c887c216949acbdfbd8b494863567</project_id>
        <repeat_actions>false</repeat_actions>
        <state>ok</state>
        <state_timestamp>2013-11-21T12:33:08.486228</state_timestamp>
        <threshold_rule nil="true" />
        <timestamp>2013-11-21T12:33:08.486221</timestamp>
        <type>threshold</type>
        <user_id>c96c887c216949acbdfbd8b494863567</user_id>
    </value>
</values>
POST
/v2/alarms
Create alarm

Creates an alarm.

 
Normal response codes
200
Request parameters
Parameter Style Type Description
data (Optional) query Alarm

An alarm within the request body.

Response parameters
Parameter Style Type Description
alarm_id plain csapi:UUID

The UUID of the alarm.

description plain xsd:string

Describes the alarm.

enabled plain xsd:boolean

If true, evaluation and actioning is enabled for the alarm.

name plain xsd:string

The name of the alarm.

project_id plain csapi:UUID

The UUID of the project.

repeat_actions plain xsd:boolean

If set to true, the alarm notifications are repeated. Otherwise, this value is false.

state plain xsd:string

The state of the alarm.

state_timestamp plain xsd:dateTime

The date and time of the alarm state.

timestamp plain xsd:dateTime

The date and time of the alarm.

user_id plain csapi:UUID

The UUID of the user.

type plain xsd:string

The type of the alarm, which is either threshold or combination.

threshold_rule plain xsd:string

The rules for the threshold alarm type.

combination_rule plain xsd:string

The rules for the combination alarm type.

alarm_actions plain xsd:list

The list of actions that the alarm performs.

insufficient_data_actions plain xsd:list

The list of actions that the alarm performs when the alarm state is insufficient_data.

ok_actions plain xsd:list

The list of actions that the alarm performs when the alarm state is ok.

{
    "alarm_actions": [
        "http://site:8000/alarm"
    ],
    "alarm_id": null,
    "combination_rule": null,
    "description": "An alarm",
    "enabled": true,
    "insufficient_data_actions": [
        "http://site:8000/nodata"
    ],
    "name": "SwiftObjectAlarm",
    "ok_actions": [
        "http://site:8000/ok"
    ],
    "project_id": "c96c887c216949acbdfbd8b494863567",
    "repeat_actions": false,
    "state": "ok",
    "state_timestamp": "2013-11-21T12:33:08.486228",
    "threshold_rule": null,
    "timestamp": "2013-11-21T12:33:08.486221",
    "type": "threshold",
    "user_id": "c96c887c216949acbdfbd8b494863567"
}
<?xml version="1.0" encoding="UTF-8"?>
<value>
    <alarm_actions>
        <item>http://site:8000/alarm</item>
    </alarm_actions>
    <alarm_id nil="true" />
    <combination_rule nil="true" />
    <description>An alarm</description>
    <enabled>true</enabled>
    <insufficient_data_actions>
        <item>http://site:8000/nodata</item>
    </insufficient_data_actions>
    <name>SwiftObjectAlarm</name>
    <ok_actions>
        <item>http://site:8000/ok</item>
    </ok_actions>
    <project_id>c96c887c216949acbdfbd8b494863567</project_id>
    <repeat_actions>false</repeat_actions>
    <state>ok</state>
    <state_timestamp>2013-11-21T12:33:08.486228</state_timestamp>
    <threshold_rule nil="true" />
    <timestamp>2013-11-21T12:33:08.486221</timestamp>
    <type>threshold</type>
    <user_id>c96c887c216949acbdfbd8b494863567</user_id>
</value>
GET
/v2/alarms/​{alarm_id}​
Show alarm details

Shows details for an alarm, by alarm ID.

 
Normal response codes
200
Request parameters
Parameter Style Type Description
alarm_id URI csapi:UUID

The UUID of the alarm.

Response parameters
Parameter Style Type Description
alarm_id plain csapi:UUID

The UUID of the alarm.

description plain xsd:string

Describes the alarm.

enabled plain xsd:boolean

If true, evaluation and actioning is enabled for the alarm.

name plain xsd:string

The name of the alarm.

project_id plain csapi:UUID

The UUID of the project.

repeat_actions plain xsd:boolean

If set to true, the alarm notifications are repeated. Otherwise, this value is false.

state plain xsd:string

The state of the alarm.

state_timestamp plain xsd:dateTime

The date and time of the alarm state.

timestamp plain xsd:dateTime

The date and time of the alarm.

user_id plain csapi:UUID

The UUID of the user.

type plain xsd:string

The type of the alarm, which is either threshold or combination.

threshold_rule plain xsd:string

The rules for the threshold alarm type.

combination_rule plain xsd:string

The rules for the combination alarm type.

alarm_actions plain xsd:list

The list of actions that the alarm performs.

insufficient_data_actions plain xsd:list

The list of actions that the alarm performs when the alarm state is insufficient_data.

ok_actions plain xsd:list

The list of actions that the alarm performs when the alarm state is ok.

{
    "alarm_actions": [
        "http://site:8000/alarm"
    ],
    "alarm_id": null,
    "combination_rule": null,
    "description": "An alarm",
    "enabled": true,
    "insufficient_data_actions": [
        "http://site:8000/nodata"
    ],
    "name": "SwiftObjectAlarm",
    "ok_actions": [
        "http://site:8000/ok"
    ],
    "project_id": "c96c887c216949acbdfbd8b494863567",
    "repeat_actions": false,
    "state": "ok",
    "state_timestamp": "2013-11-21T12:33:08.486228",
    "threshold_rule": null,
    "timestamp": "2013-11-21T12:33:08.486221",
    "type": "threshold",
    "user_id": "c96c887c216949acbdfbd8b494863567"
}
<?xml version="1.0" encoding="UTF-8"?>
<value>
    <alarm_actions>
        <item>http://site:8000/alarm</item>
    </alarm_actions>
    <alarm_id nil="true" />
    <combination_rule nil="true" />
    <description>An alarm</description>
    <enabled>true</enabled>
    <insufficient_data_actions>
        <item>http://site:8000/nodata</item>
    </insufficient_data_actions>
    <name>SwiftObjectAlarm</name>
    <ok_actions>
        <item>http://site:8000/ok</item>
    </ok_actions>
    <project_id>c96c887c216949acbdfbd8b494863567</project_id>
    <repeat_actions>false</repeat_actions>
    <state>ok</state>
    <state_timestamp>2013-11-21T12:33:08.486228</state_timestamp>
    <threshold_rule nil="true" />
    <timestamp>2013-11-21T12:33:08.486221</timestamp>
    <type>threshold</type>
    <user_id>c96c887c216949acbdfbd8b494863567</user_id>
</value>

This operation does not accept a request body.

PUT
/v2/alarms/​{alarm_id}​
Update alarm

Updates an alarm.

 
Normal response codes
200
Request parameters
Parameter Style Type Description
alarm_id URI csapi:UUID

The UUID of the alarm.

data (Optional) query Alarm

An alarm within the request body.

Response parameters
Parameter Style Type Description
alarm_id plain csapi:UUID

The UUID of the alarm.

description plain xsd:string

Describes the alarm.

enabled plain xsd:boolean

If true, evaluation and actioning is enabled for the alarm.

name plain xsd:string

The name of the alarm.

project_id plain csapi:UUID

The UUID of the project.

repeat_actions plain xsd:boolean

If set to true, the alarm notifications are repeated. Otherwise, this value is false.

state plain xsd:string

The state of the alarm.

state_timestamp plain xsd:dateTime

The date and time of the alarm state.

timestamp plain xsd:dateTime

The date and time of the alarm.

user_id plain csapi:UUID

The UUID of the user.

type plain xsd:string

The type of the alarm, which is either threshold or combination.

threshold_rule plain xsd:string

The rules for the threshold alarm type.

combination_rule plain xsd:string

The rules for the combination alarm type.

alarm_actions plain xsd:list

The list of actions that the alarm performs.

insufficient_data_actions plain xsd:list

The list of actions that the alarm performs when the alarm state is insufficient_data.

ok_actions plain xsd:list

The list of actions that the alarm performs when the alarm state is ok.

{
    "alarm_actions": [
        "http://site:8000/alarm"
    ],
    "alarm_id": null,
    "combination_rule": null,
    "description": "An alarm",
    "enabled": true,
    "insufficient_data_actions": [
        "http://site:8000/nodata"
    ],
    "name": "SwiftObjectAlarm",
    "ok_actions": [
        "http://site:8000/ok"
    ],
    "project_id": "c96c887c216949acbdfbd8b494863567",
    "repeat_actions": false,
    "state": "ok",
    "state_timestamp": "2013-11-21T12:33:08.486228",
    "threshold_rule": null,
    "timestamp": "2013-11-21T12:33:08.486221",
    "type": "threshold",
    "user_id": "c96c887c216949acbdfbd8b494863567"
}
<?xml version="1.0" encoding="UTF-8"?>
<value>
    <alarm_actions>
        <item>http://site:8000/alarm</item>
    </alarm_actions>
    <alarm_id nil="true" />
    <combination_rule nil="true" />
    <description>An alarm</description>
    <enabled>true</enabled>
    <insufficient_data_actions>
        <item>http://site:8000/nodata</item>
    </insufficient_data_actions>
    <name>SwiftObjectAlarm</name>
    <ok_actions>
        <item>http://site:8000/ok</item>
    </ok_actions>
    <project_id>c96c887c216949acbdfbd8b494863567</project_id>
    <repeat_actions>false</repeat_actions>
    <state>ok</state>
    <state_timestamp>2013-11-21T12:33:08.486228</state_timestamp>
    <threshold_rule nil="true" />
    <timestamp>2013-11-21T12:33:08.486221</timestamp>
    <type>threshold</type>
    <user_id>c96c887c216949acbdfbd8b494863567</user_id>
</value>
DELETE
/v2/alarms/​{alarm_id}​
Delete alarm

Deletes an alarm, by alarm ID.

 
Normal response codes
204
Request parameters
Parameter Style Type Description
alarm_id URI csapi:UUID

The UUID of the alarm.

This operation does not accept a request body and does not return a response body.

PUT
/v2/alarms/​{alarm_id}​/state
Update alarm state

Sets the state of an alarm.

 
Normal response codes
200
Request parameters
Parameter Style Type Description
alarm_id URI csapi:UUID

The UUID of the alarm.

state query xsd:string

The alarm state. A valid value is ok, alarm, or insufficient data.

This operation does not return a response body.

GET
/v2/alarms/​{alarm_id}​/state
Show alarm state

Shows the state for an alarm, by alarm ID.

 
Normal response codes
200
Request parameters
Parameter Style Type Description
alarm_id URI csapi:UUID

The UUID of the alarm.

This operation does not return a response body.

GET
/v2/alarms/​{alarm_id}​/history
Show alarm history

Assembles and shows the history for an alarm, by alarm ID.

 
Normal response codes
200
Request parameters
Parameter Style Type Description
alarm_id URI csapi:UUID

The UUID of the alarm.

q (Optional) query xsd:list

Filters the response by one or more arguments.

For example: ?q.field=Foo&q.value=my_text.

This operation does not return a response body.

Meters

Lists all meters, adds samples to meters, and lists samples for meters. For list operations, if you do not explicitly set the limit query parameter, a default limit is applied. The default limit is the default_api_return_limit configuration option value.

Also, computes and lists statistics for samples in a time range. You can use the aggregate query parameter in the statistics URI to explicitly select the stddev, cardinality, or any other standard function. For example:

GET /v2/meters/METER_NAME/statistics?aggregate.func=NAME&aggregate.param=VALUE

The aggregate.param parameter value is optional for all functions except the cardinality function.

The API silently ignores any duplicate aggregate function and parameter pairs.

The API accepts and storage drivers support duplicate functions with different parameter values. In this example, the cardinality function is accepted twice with two different parameter values:

GET /v2/meters/METER_NAME/statistics?aggregate.func=cardinality&aggregate.param=resource_id
        &aggregate.func=cardinality&aggregate.param=project_id

Examples:

Use the stddev function to request the standard deviation of CPU utilization:

GET /v2/meters/cpu_util/statistics?aggregate.func=stddev

The response looks like this:

[
    {
        "aggregate": {
            "stddev": 0.6858829
        },
        "duration_start": "2014-01-30T11:13:23",
        "duration_end": "2014-01-31T16:07:13",
        "duration": 104030,
        "period": 0,
        "period_start": "2014-01-30T11:13:23",
        "period_end": "2014-01-31T16:07:13",
        "groupby": null,
        "unit": "%"
    }
]

Use the cardinality function with the project ID to return the number of distinct tenants with images:

GET /v2/meters/image/statistics?aggregate.func=cardinality&aggregate.param=project_id

The following, more complex, example determines:

  • The number of distinct instances (cardinality)

  • The total number of instance samples (count) for a tenant in 15-minute intervals (period and groupby options)

GET /v2/meters/instance/statistics?aggregate.func=cardinality&aggregate.param=resource_id
        &aggregate.func=count&groupby=project_id&period=900

The response looks like this:

[
    {
        "count": 19,
        "aggregate": {
            "count": 19,
            "cardinality/resource_id": 3
        },
        "duration": 328.47803,
        "duration_start": "2014-01-31T10:00:41.823919",
        "duration_end": "2014-01-31T10:06:10.301948",
        "period": 900,
        "period_start": "2014-01-31T10:00:00",
        "period_end": "2014-01-31T10:15:00",
        "groupby": {
            "project_id": "061a5c91811e4044b7dc86c6136c4f99"
        },
        "unit": "instance"
    },
    {
        "count": 22,
        "aggregate": {
            "count": 22,
            "cardinality/resource_id": 4
        },
        "duration": 808.00385,
        "duration_start": "2014-01-31T10:15:15",
        "duration_end": "2014-01-31T10:28:43.003840",
        "period": 900,
        "period_start": "2014-01-31T10:15:00",
        "period_end": "2014-01-31T10:30:00",
        "groupby": {
            "project_id": "061a5c91811e4044b7dc86c6136c4f99"
        },
        "unit": "instance"
    },
    {
        "count": 2,
        "aggregate": {
            "count": 2,
            "cardinality/resource_id": 2
        },
        "duration": 0,
        "duration_start": "2014-01-31T10:35:15",
        "duration_end": "2014-01-31T10:35:15",
        "period": 900,
        "period_start": "2014-01-31T10:30:00",
        "period_end": "2014-01-31T10:45:00",
        "groupby": {
            "project_id": "061a5c91811e4044b7dc86c6136c4f99"
        },
        "unit": "instance"
    }
]
GET
/v2/meters
List meters

Lists meters, based on the data recorded so far.

 
Normal response codes
200
Request parameters
Parameter Style Type Description
q (Optional) query xsd:list

Filters the response by one or more arguments.

For example: ?q.field=Foo&q.value=my_text.

limit (Optional) query xsd:int

Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.

Response parameters
Parameter Style Type Description
meter_id plain csapi:UUID

The UUID of the meter.

name plain xsd:string

The meter name.

project_id plain csapi:UUID

The UUID of the project or tenant that owns the resource.

resource_id plain csapi:UUID

The UUID of the resource for which the measurements are taken.

source plain xsd:string

The name of the source from which the meter came.

type plain xsd:string

The meter type.

The type value is gauge, delta, or cumulative.

unit plain xsd:string

The unit of measure.

user_id plain csapi:UUID

The UUID of the user who either created or last updated the resource.

[
    {
        "meter_id": "YmQ5NDMxYzEtOGQ2OS00YWQzLTgwM2EtOGQ0YTZiODlmZDM2K2luc3RhbmNl",
        "name": "instance",
        "project_id": "35b17138-b364-4e6a-a131-8f3099c5be68",
        "resource_id": "bd9431c1-8d69-4ad3-803a-8d4a6b89fd36",
        "source": "openstack",
        "type": "gauge",
        "unit": "instance",
        "user_id": "efd87807-12d2-4b38-9c70-5f5c2ac427ff"
    }
]
<?xml version="1.0" encoding="UTF-8"?>
<values>
   <value>
      <name>instance</name>
      <type>gauge</type>
      <unit>instance</unit>
      <resource_id>bd9431c1-8d69-4ad3-803a-8d4a6b89fd36</resource_id>
      <project_id>35b17138-b364-4e6a-a131-8f3099c5be68</project_id>
      <user_id>efd87807-12d2-4b38-9c70-5f5c2ac427ff</user_id>
      <source>openstack</source>
      <meter_id>YmQ5NDMxYzEtOGQ2OS00YWQzLTgwM2EtOGQ0YTZiODlmZDM2K2luc3RhbmNl</meter_id>
   </value>
</values>
POST
/v2/meters/​{meter_name}​
Add samples to meter

Adds samples to a meter, by meter name.

 

If you attempt to add a sample that is not supported, this call returns the 409 response code.

Normal response codes
200
Error response codes
conflict (409)
Request parameters
Parameter Style Type Description
meter_name URI xsd:string

The name of the meter.

direct (Optional) query xsd:string

Indicates whether the samples are POSTed directly to storage. Set ?direct=True to POST the samples directly to storage.

samples (Optional) query xsd:list

A list of samples.

id plain csapi:UUID

The UUID of the sample.

metadata plain xsd:dict

An arbitrary set of one or more metadata key and value pairs that are associated with the sample.

meter plain xsd:string

The meter name.

project_id plain csapi:UUID

The UUID of the project or tenant that owns the resource.

recorded_at plain xsd:dateTime

The date and time when the sample was recorded.

resource_id plain csapi:UUID

The UUID of the resource for which the measurements are taken.

source plain xsd:string

The name of the source that identifies where the sample comes from.

timestamp plain xsd:dateTime

The date and time in UTC format when the measurement was made.

type plain xsd:string

The meter type.

unit plain xsd:string

The unit of measure for the volume value.

user_id plain csapi:UUID

The UUID of the user who either created or last updated the resource.

volume plain xsd:float

The actual measured value.

Response parameters
Parameter Style Type Description
id plain csapi:UUID

The UUID of the sample.

metadata plain xsd:dict

An arbitrary set of one or more metadata key and value pairs that are associated with the sample.

meter plain xsd:string

The meter name.

project_id plain csapi:UUID

The UUID of the project or tenant that owns the resource.

recorded_at plain xsd:dateTime

The date and time when the sample was recorded.

resource_id plain csapi:UUID

The UUID of the resource for which the measurements are taken.

source plain xsd:string

The name of the source that identifies where the sample comes from.

timestamp plain xsd:dateTime

The date and time in UTC format when the measurement was made.

type plain xsd:string

The meter type.

unit plain xsd:string

The unit of measure for the volume value.

user_id plain csapi:UUID

The UUID of the user who either created or last updated the resource.

volume plain xsd:float

The actual measured value.

{
    "id": "8db08c68-bc70-11e4-a8c4-fa163e1d1a9b",
    "metadata": {
        "name1": "value1",
        "name2": "value2"
    },
    "meter": "instance",
    "project_id": "35b17138-b364-4e6a-a131-8f3099c5be68",
    "recorded_at": "2015-02-24T22:00:32.747930",
    "resource_id": "bd9431c1-8d69-4ad3-803a-8d4a6b89fd36",
    "source": "openstack",
    "timestamp": "2015-02-24T22:00:32.747930",
    "type": "gauge",
    "unit": "instance",
    "user_id": "efd87807-12d2-4b38-9c70-5f5c2ac427ff",
    "volume": 1.0
}
<value>
  <id>8db08c68-bc70-11e4-a8c4-fa163e1d1a9b</id>
  <meter>instance</meter>
  <type>gauge</type>
  <unit>instance</unit>
  <volume>1.0</volume>
  <user_id>efd87807-12d2-4b38-9c70-5f5c2ac427ff</user_id>
  <project_id>35b17138-b364-4e6a-a131-8f3099c5be68</project_id>
  <resource_id>bd9431c1-8d69-4ad3-803a-8d4a6b89fd36</resource_id>
  <source>openstack</source>
  <timestamp>2015-02-24T22:00:32.747930</timestamp>
  <recorded_at>2015-02-24T22:00:32.747930</recorded_at>
  <metadata>
    <item>
      <key>name2</key>
      <value>value2</value>
    </item>
    <item>
      <key>name1</key>
      <value>value1</value>
    </item>
  </metadata>
</value>
{
    "id": "9b23b398-6139-11e5-97e9-bc764e045bf6",
    "metadata": {
        "name1": "value1",
        "name2": "value2"
    },
    "meter": "instance",
    "project_id": "35b17138-b364-4e6a-a131-8f3099c5be68",
    "recorded_at": "2015-09-22T14:52:54.850725",
    "resource_id": "bd9431c1-8d69-4ad3-803a-8d4a6b89fd36",
    "source": "openstack",
    "timestamp": "2015-09-22T14:52:54.850718",
    "type": "gauge",
    "unit": "instance",
    "user_id": "efd87807-12d2-4b38-9c70-5f5c2ac427ff",
    "volume": 1
}
<?xml version="1.0" encoding="UTF-8"?>
<value>
   <id>9b23b398-6139-11e5-97e9-bc764e045bf6</id>
   <meter>instance</meter>
   <type>gauge</type>
   <unit>instance</unit>
   <volume>1.0</volume>
   <user_id>efd87807-12d2-4b38-9c70-5f5c2ac427ff</user_id>
   <project_id>35b17138-b364-4e6a-a131-8f3099c5be68</project_id>
   <resource_id>bd9431c1-8d69-4ad3-803a-8d4a6b89fd36</resource_id>
   <source>openstack</source>
   <timestamp>2015-09-22T14:52:54.850718</timestamp>
   <recorded_at>2015-09-22T14:52:54.850725</recorded_at>
   <metadata>
      <item>
         <key>name2</key>
         <value>value2</value>
      </item>
      <item>
         <key>name1</key>
         <value>value1</value>
      </item>
   </metadata>
</value>
GET
/v2/meters/​{meter_name}​
List samples for meter

Lists samples for a meter, by meter name.

 
Normal response codes
200
Request parameters
Parameter Style Type Description
meter_name URI xsd:string

The name of the meter.

q (Optional) query xsd:list

Filters the response by one or more arguments.

For example: ?q.field=Foo&q.value=my_text.

limit (Optional) query xsd:int

Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.

Response parameters
Parameter Style Type Description
id plain csapi:UUID

The UUID of the sample.

metadata plain xsd:dict

An arbitrary set of one or more metadata key and value pairs that are associated with the sample.

meter plain xsd:string

The meter name.

project_id plain csapi:UUID

The UUID of the project or tenant that owns the resource.

recorded_at plain xsd:dateTime

The date and time when the sample was recorded.

resource_id plain csapi:UUID

The UUID of the resource for which the measurements are taken.

source plain xsd:string

The name of the source that identifies where the sample comes from.

timestamp plain xsd:dateTime

The date and time in UTC format when the measurement was made.

type plain xsd:string

The meter type.

unit plain xsd:string

The unit of measure for the volume value.

user_id plain csapi:UUID

The UUID of the user who either created or last updated the resource.

volume plain xsd:float

The actual measured value.

[
    {
        "id": "9b23b398-6139-11e5-97e9-bc764e045bf6",
        "metadata": {
            "name1": "value1",
            "name2": "value2"
        },
        "meter": "instance",
        "project_id": "35b17138-b364-4e6a-a131-8f3099c5be68",
        "recorded_at": "2015-09-22T14:52:54.850725",
        "resource_id": "bd9431c1-8d69-4ad3-803a-8d4a6b89fd36",
        "source": "openstack",
        "timestamp": "2015-09-22T14:52:54.850718",
        "type": "gauge",
        "unit": "instance",
        "user_id": "efd87807-12d2-4b38-9c70-5f5c2ac427ff",
        "volume": 1
    }
]
<?xml version="1.0" encoding="UTF-8"?>
<values>
   <value>
      <id>9b23b398-6139-11e5-97e9-bc764e045bf6</id>
      <meter>instance</meter>
      <type>gauge</type>
      <unit>instance</unit>
      <volume>1.0</volume>
      <user_id>efd87807-12d2-4b38-9c70-5f5c2ac427ff</user_id>
      <project_id>35b17138-b364-4e6a-a131-8f3099c5be68</project_id>
      <resource_id>bd9431c1-8d69-4ad3-803a-8d4a6b89fd36</resource_id>
      <source>openstack</source>
      <timestamp>2015-09-22T14:52:54.850718</timestamp>
      <recorded_at>2015-09-22T14:52:54.850725</recorded_at>
      <metadata>
         <item>
            <key>name2</key>
            <value>value2</value>
         </item>
         <item>
            <key>name1</key>
            <value>value1</value>
         </item>
      </metadata>
   </value>
</values>
GET
/v2/meters/​{meter_name}​/statistics
Show meter statistics

Computes and lists statistics for samples in a time range.

 
Normal response codes
200
Request parameters
Parameter Style Type Description
meter_name URI xsd:string

The name of the meter.

q (Optional) query xsd:list

Filters the response by one or more arguments.

For example: ?q.field=Foo&q.value=my_text.

groupby (Optional) query xsd:dict

Fields for group by aggregation.

period (Optional) query xsd:int

The period, in seconds, for which you want statistics.

aggregate (Optional) query xsd:dict

A list of selectable aggregation functions to apply.

For example:

GET /v2/meters/METER_NAME/statistics?aggregate.func=cardinality&aggregate.param=resource_id&aggregate.func=cardinality&aggregate.param=project_id
limit (Optional) query xsd:int

Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.

Response parameters
Parameter Style Type Description
aggregate (Optional) plain xsd:dict

If you set the aggregate query parameter in the URI, a set of one or more selectable aggregate values as a dictionary of key (string) and value (float) pairs.

For example, the stddev function returns output like this:

[
    {
        "aggregate": {
            "stddev": 0.6858829
        },
        "duration_start": "2014-01-30T11:13:23",
        "duration_end": "2014-01-31T16:07:13",
        "duration": 104030,
        "period": 0,
        "period_start": "2014-01-30T11:13:23",
        "period_end": "2014-01-31T16:07:13",
        "groupby": null,
        "unit": "%"
    }
]
avg plain xsd:float

The average of all volume values in the data.

count plain xsd:int

The number of samples seen.

duration plain xsd:float

The number of seconds between the oldest and newest date and time stamp.

duration_end plain xsd:dateTime

The date and time in UTC format of the query end time.

duration_start plain xsd:dateTime

The date and time in UTC format of the query start time.

groupby (Optional) plain xsd:dict

If you set the groupby query parameter in the URI to request statistics, a dictionary of field names for group.

For example:

[
    {
        "count": 19,
        "aggregate": {
            "count": 19,
            "cardinality/resource_id": 3
        },
        "duration": 328.47803,
        "duration_start": "2014-01-31T10:00:41.823919",
        "duration_end": "2014-01-31T10:06:10.301948",
        "period": 900,
        "period_start": "2014-01-31T10:00:00",
        "period_end": "2014-01-31T10:15:00",
        "groupby": {
            "project_id": "061a5c91811e4044b7dc86c6136c4f99"
        },
        "unit": "instance"
    },
    {
        "count": 22,
        "aggregate": {
            "count": 22,
            "cardinality/resource_id": 4
        },
        "duration": 808.00385,
        "duration_start": "2014-01-31T10:15:15",
        "duration_end": "2014-01-31T10:28:43.003840",
        "period": 900,
        "period_start": "2014-01-31T10:15:00",
        "period_end": "2014-01-31T10:30:00",
        "groupby": {
            "project_id": "061a5c91811e4044b7dc86c6136c4f99"
        },
        "unit": "instance"
    },
    {
        "count": 2,
        "aggregate": {
            "count": 2,
            "cardinality/resource_id": 2
        },
        "duration": 0,
        "duration_start": "2014-01-31T10:35:15",
        "duration_end": "2014-01-31T10:35:15",
        "period": 900,
        "period_start": "2014-01-31T10:30:00",
        "period_end": "2014-01-31T10:45:00",
        "groupby": {
            "project_id": "061a5c91811e4044b7dc86c6136c4f99"
        },
        "unit": "instance"
    }
]
max plain xsd:float

The maximum volume seen in the data.

min plain xsd:float

The minimum volume seen in the data.

period plain xsd:int

The number of seconds between the period start and end date and time stamps.

period_end plain xsd:dateTime

The period end date and time in UTC format.

period_start plain xsd:dateTime

The period start date and time in UTC format.

sum plain xsd:float

The total of all of the volume values seen in the data.

unit plain xsd:string

The unit type of the data set.

[
    {
        "avg": 4.5,
        "count": 10,
        "duration": 300,
        "duration_end": "2013-01-04T16:47:00",
        "duration_start": "2013-01-04T16:42:00",
        "max": 9,
        "min": 1,
        "period": 7200,
        "period_end": "2013-01-04T18:00:00",
        "period_start": "2013-01-04T16:00:00",
        "sum": 45,
        "unit": "GiB"
    }
]
<?xml version="1.0" encoding="UTF-8"?>
<values>
  <value>
    <avg>4.5</avg>
    <count>10</count>
    <duration>300.0</duration>
    <duration_end>2013-01-04T16:47:00</duration_end>
    <duration_start>2013-01-04T16:42:00</duration_start>
    <max>9.0</max>
    <min>1.0</min>
    <period>7200</period>
    <period_end>2013-01-04T18:00:00</period_end>
    <period_start>2013-01-04T16:00:00</period_start>
    <sum>45.0</sum>
    <unit>GiB</unit>
  </value>
</values>

Samples

Lists all samples and gets information for a sample.

For list operations, if you do not explicitly set the limit query parameter, a default limit is applied. The default limit is the default_api_return_limit configuration option value.

GET
/v2/samples
List samples

Lists all known samples, based on the data recorded so far.

 
Normal response codes
200
Request parameters
Parameter Style Type Description
q (Optional) query xsd:list

Filters the response by one or more arguments.

For example: ?q.field=Foo&q.value=my_text.

limit (Optional) query xsd:int

Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.

Response parameters
Parameter Style Type Description
id plain csapi:UUID

The UUID of the sample.

metadata plain xsd:dict

An arbitrary set of one or more metadata key and value pairs that are associated with the sample.

meter plain xsd:string

The meter name.

project_id plain csapi:UUID

The UUID of the project or tenant that owns the resource.

recorded_at plain xsd:dateTime

The date and time when the sample was recorded.

resource_id plain csapi:UUID

The UUID of the resource for which the measurements are taken.

source plain xsd:string

The name of the source that identifies where the sample comes from.

timestamp plain xsd:dateTime

The date and time in UTC format when the measurement was made.

type plain xsd:string

The meter type.

unit plain xsd:string

The unit of measure for the volume value.

user_id plain csapi:UUID

The UUID of the user who either created or last updated the resource.

volume plain xsd:float

The actual measured value.

[
    {
        "id": "9b23b398-6139-11e5-97e9-bc764e045bf6",
        "metadata": {
            "name1": "value1",
            "name2": "value2"
        },
        "meter": "instance",
        "project_id": "35b17138-b364-4e6a-a131-8f3099c5be68",
        "recorded_at": "2015-09-22T14:52:54.850725",
        "resource_id": "bd9431c1-8d69-4ad3-803a-8d4a6b89fd36",
        "source": "openstack",
        "timestamp": "2015-09-22T14:52:54.850718",
        "type": "gauge",
        "unit": "instance",
        "user_id": "efd87807-12d2-4b38-9c70-5f5c2ac427ff",
        "volume": 1
    }
]
<?xml version="1.0" encoding="UTF-8"?>
<values>
   <value>
      <id>9b23b398-6139-11e5-97e9-bc764e045bf6</id>
      <meter>instance</meter>
      <type>gauge</type>
      <unit>instance</unit>
      <volume>1.0</volume>
      <user_id>efd87807-12d2-4b38-9c70-5f5c2ac427ff</user_id>
      <project_id>35b17138-b364-4e6a-a131-8f3099c5be68</project_id>
      <resource_id>bd9431c1-8d69-4ad3-803a-8d4a6b89fd36</resource_id>
      <source>openstack</source>
      <timestamp>2015-09-22T14:52:54.850718</timestamp>
      <recorded_at>2015-09-22T14:52:54.850725</recorded_at>
      <metadata>
         <item>
            <key>name2</key>
            <value>value2</value>
         </item>
         <item>
            <key>name1</key>
            <value>value1</value>
         </item>
      </metadata>
   </value>
</values>
GET
/v2/samples/​{sample_id}​
Show sample details

Shows details for a sample, by sample ID.

 
Normal response codes
200
Request parameters
Parameter Style Type Description
sample_id URI csapi:UUID

The UUID of the sample.

Response parameters
Parameter Style Type Description
id plain csapi:UUID

The UUID of the sample.

metadata plain xsd:dict

An arbitrary set of one or more metadata key and value pairs that are associated with the sample.

meter plain xsd:string

The meter name.

project_id plain csapi:UUID

The UUID of the project or tenant that owns the resource.

recorded_at plain xsd:dateTime

The date and time when the sample was recorded.

resource_id plain csapi:UUID

The UUID of the resource for which the measurements are taken.

source plain xsd:string

The name of the source that identifies where the sample comes from.

timestamp plain xsd:dateTime

The date and time in UTC format when the measurement was made.

type plain xsd:string

The meter type.

unit plain xsd:string

The unit of measure for the volume value.

user_id plain csapi:UUID

The UUID of the user who either created or last updated the resource.

volume plain xsd:float

The actual measured value.

{
    "id": "9b23b398-6139-11e5-97e9-bc764e045bf6",
    "metadata": {
        "name1": "value1",
        "name2": "value2"
    },
    "meter": "instance",
    "project_id": "35b17138-b364-4e6a-a131-8f3099c5be68",
    "recorded_at": "2015-09-22T14:52:54.850725",
    "resource_id": "bd9431c1-8d69-4ad3-803a-8d4a6b89fd36",
    "source": "openstack",
    "timestamp": "2015-09-22T14:52:54.850718",
    "type": "gauge",
    "unit": "instance",
    "user_id": "efd87807-12d2-4b38-9c70-5f5c2ac427ff",
    "volume": 1
}
<?xml version="1.0" encoding="UTF-8"?>
<value>
   <id>9b23b398-6139-11e5-97e9-bc764e045bf6</id>
   <meter>instance</meter>
   <type>gauge</type>
   <unit>instance</unit>
   <volume>1.0</volume>
   <user_id>efd87807-12d2-4b38-9c70-5f5c2ac427ff</user_id>
   <project_id>35b17138-b364-4e6a-a131-8f3099c5be68</project_id>
   <resource_id>bd9431c1-8d69-4ad3-803a-8d4a6b89fd36</resource_id>
   <source>openstack</source>
   <timestamp>2015-09-22T14:52:54.850718</timestamp>
   <recorded_at>2015-09-22T14:52:54.850725</recorded_at>
   <metadata>
      <item>
         <key>name2</key>
         <value>value2</value>
      </item>
      <item>
         <key>name1</key>
         <value>value1</value>
      </item>
   </metadata>
</value>

This operation does not accept a request body.

Resources

Lists all and gets information for resources.

GET
/v2/resources
List resources

Lists definitions for all resources.

 
Normal response codes
200
Request parameters
Parameter Style Type Description
q (Optional) query xsd:list

Filters the response by one or more arguments.

For example: ?q.field=Foo&q.value=my_text.

meter_links (Optional) query xsd:int

Set ?meter_links=1 to return a self link and related meter links.

Response parameters
Parameter Style Type Description
links plain xsd:list

A list that contains a self link and associated meter links.

metadata plain xsd:dict

A set of one or more arbitrary metadata key and value pairs that are associated with the resource.

project_id plain csapi:UUID

The UUID of the owning project or tenant.

resource_id plain csapi:UUID

The UUID of the resource.

source plain xsd:string

The name of the source from which the resource came.

user_id plain csapi:UUID

The UUID of the user who either created or last updated the resource.

[
    {
        "links": [
            {
                "href": "http://localhost:8777/v2/resources/bd9431c1-8d69-4ad3-803a-8d4a6b89fd36",
                "rel": "self"
            },
            {
                "href": "http://localhost:8777/v2/meters/volume?q.field=resource_id&q.value=bd9431c1-8d69-4ad3-803a-8d4a6b89fd36",
                "rel": "volume"
            }
        ],
        "metadata": {
            "name1": "value1",
            "name2": "value2"
        },
        "project_id": "35b17138-b364-4e6a-a131-8f3099c5be68",
        "resource_id": "bd9431c1-8d69-4ad3-803a-8d4a6b89fd36",
        "source": "openstack",
        "user_id": "efd87807-12d2-4b38-9c70-5f5c2ac427ff"
    }
]
<?xml version="1.0" encoding="UTF-8"?>
<values>
   <value>
      <resource_id>bd9431c1-8d69-4ad3-803a-8d4a6b89fd36</resource_id>
      <project_id>35b17138-b364-4e6a-a131-8f3099c5be68</project_id>
      <user_id>efd87807-12d2-4b38-9c70-5f5c2ac427ff</user_id>
      <metadata>
         <item>
            <key>name2</key>
            <value>value2</value>
         </item>
         <item>
            <key>name1</key>
            <value>value1</value>
         </item>
      </metadata>
      <links>
         <item>
            <href>http://localhost:8777/v2/resources/bd9431c1-8d69-4ad3-803a-8d4a6b89fd36</href>
            <rel>self</rel>
         </item>
         <item>
            <href>http://localhost:8777/v2/meters/volume?q.field=resource_id&amp;q.value=bd9431c1-8d69-4ad3-803a-8d4a6b89fd36</href>
            <rel>volume</rel>
         </item>
      </links>
      <source>openstack</source>
   </value>
</values>
GET
/v2/resources/​{resource_id}​
Show resource details

Shows details for a resource, by resource ID.

 
Normal response codes
200
Request parameters
Parameter Style Type Description
resource_id URI csapi:UUID

The UUID of the resource.

Response parameters
Parameter Style Type Description
links plain xsd:list

A list that contains a self link and associated meter links.

metadata plain xsd:dict

A set of one or more arbitrary metadata key and value pairs that are associated with the resource.

project_id plain csapi:UUID

The UUID of the owning project or tenant.

resource_id plain csapi:UUID

The UUID of the resource.

source plain xsd:string

The name of the source from which the resource came.

user_id plain csapi:UUID

The UUID of the user who either created or last updated the resource.

{
    "links": [
        {
            "href": "http://localhost:8777/v2/resources/bd9431c1-8d69-4ad3-803a-8d4a6b89fd36",
            "rel": "self"
        },
        {
            "href": "http://localhost:8777/v2/meters/volume?q.field=resource_id&q.value=bd9431c1-8d69-4ad3-803a-8d4a6b89fd36",
            "rel": "volume"
        }
    ],
    "metadata": {
        "name1": "value1",
        "name2": "value2"
    },
    "project_id": "35b17138-b364-4e6a-a131-8f3099c5be68",
    "resource_id": "bd9431c1-8d69-4ad3-803a-8d4a6b89fd36",
    "source": "openstack",
    "user_id": "efd87807-12d2-4b38-9c70-5f5c2ac427ff"
}
<?xml version="1.0" encoding="UTF-8"?>
<value>
   <resource_id>bd9431c1-8d69-4ad3-803a-8d4a6b89fd36</resource_id>
   <project_id>35b17138-b364-4e6a-a131-8f3099c5be68</project_id>
   <user_id>efd87807-12d2-4b38-9c70-5f5c2ac427ff</user_id>
   <metadata>
      <item>
         <key>name2</key>
         <value>value2</value>
      </item>
      <item>
         <key>name1</key>
         <value>value1</value>
      </item>
   </metadata>
   <links>
      <item>
         <href>http://localhost:8777/v2/resources/bd9431c1-8d69-4ad3-803a-8d4a6b89fd36</href>
         <rel>self</rel>
      </item>
      <item>
         <href>http://localhost:8777/v2/meters/volume?q.field=resource_id&amp;q.value=bd9431c1-8d69-4ad3-803a-8d4a6b89fd36</href>
         <rel>volume</rel>
      </item>
   </links>
   <source>openstack</source>
</value>

This operation does not accept a request body.

Capabilities

Gets information for API and storage capabilities.

The Telemetry service enables you to store samples, events, and alarm definitions in supported database back ends. The capabilities resource enables you to list the capabilities that a database supports.

The capabilities resource returns a flattened dictionary of capability properties, each with an associated boolean value. A value of true indicates that the corresponding capability is available in the back end.

You can optionally configure separate database back ends for samples, events, and alarms definitions. The capabilities response shows a value of true to indicate that the definitions database for samples, events, or alarms is ready to use in a production environment.

GET
/v2/capabilities
List capabilities

A representation of the API and storage capabilities. Usually, the storage driver imposes constraints.

 
Normal response codes
200
Response parameters
Parameter Style Type Description
api plain xsd:dict

A set of key and value pairs that contain the API capabilities for the configured storage driver.

alarms:history:query:complex plain xsd:boolean

If true, the complex query capability for alarm history is available for the configured database back end.

alarms:history:query:simple plain xsd:boolean

If true, the simple query capability for alarm history is available for the configured database back end.

alarms:query:complex plain xsd:boolean

If true, the complex query capability for alarm definitions is available for the configured database back end.

alarms:query:simple plain xsd:boolean

If true, the simple query capability for alarm definitions is available for the configured database back end.

events:query:simple plain xsd:boolean

If true, the simple query capability for events is available for the configured database back end.

meters:query:complex plain xsd:boolean

If true, the complex query capability for meters is available for the configured database back end.

meters:query:metadata plain xsd:boolean

If true, the simple query capability for the metadata of meters is available for the configured database back end.

meters:query:simple plain xsd:boolean

If true, the simple query capability for meters is available for the configured database back end.

resources:query:complex plain xsd:boolean

If true, the complex query capability for resources is available for the configured database back end.

resources:query:metadata plain xsd:boolean

If true, the simple query capability for the metadata of resources is available for the configured database back end.

resources:query:simple plain xsd:boolean

If true, the simple query capability for resources is available for the configured database back end.

samples:query:complex plain xsd:boolean

If true, the complex query capability for samples is available for the configured database back end.

samples:query:metadata plain xsd:boolean

If true, the simple query capability for the metadata of samples is available for the configured database back end.

samples:query:simple plain xsd:boolean

If true, the simple query capability for samples is available for the configured database back end.

statistics:aggregation:selectable:avg plain xsd:boolean

If true, the avg capability is available for the configured database back end. Use the avg capability to get average values for samples.

statistics:aggregation:selectable:cardinality plain xsd:boolean

If true, the cardinality capability is available for the configured database back end. Use the cardinality capability to get cardinality for samples.

statistics:aggregation:selectable:count plain xsd:boolean

If true, the count capability is available for the configured database back end. Use the count capability to calculate the number of samples for a query.

statistics:aggregation:selectable:max plain xsd:boolean

If true, the max capability is available for the configured database back end. . Use the max capability to calculate the maximum value for a query.

statistics:aggregation:selectable:min plain xsd:boolean

If true, the min capability is available for the configured database back end. Use the min capability to calculate the minimum value for a query.

statistics:aggregation:selectable:quartile plain xsd:boolean

If true, the quartile capability is available for the configured database back end. Use the quartile capability to calculate the quartile of sample volumes for a query.

statistics:aggregation:selectable:stddev plain xsd:boolean

If true, the stddev capability is available for the configured database back end. Use the stddev capability to calculate the standard deviation of sample volumes for a query.

statistics:aggregation:selectable:sum plain xsd:boolean

If true, the sum capability is available for the configured database back end. Use the sum capability to calculate the sum of sample volumes for a query.

statistics:aggregation:standard plain xsd:boolean

If true, the standard set of aggregation capability is available for the configured database back end.

statistics:groupby plain xsd:boolean

If true, the groupby capability is available for calculating statistics for the configured database back end.

statistics:query:complex plain xsd:boolean

If true, the complex query capability for statistics is available for the configured database back end.

statistics:query:metadata plain xsd:boolean

If true, the simple query capability for the sample metadata that is used to calculate statistics is available for the configured database back end.

statistics:query:simple plain xsd:boolean

If true, the simple query capability for statistics is available for the configured database back end.

alarm_storage plain xsd:dict

Defines the capabilities for the storage that stores persisting alarm definitions. A value of true indicates that the capability is available.

event_storage plain xsd:dict

If true, the capabilities for the storage that stores persisting events is available.

storage plain xsd:dict

If true, the capabilities for the storage that stores persisting samples is available.

storage:production_ready plain xsd:boolean

If true, the database back end is ready to use in a production environment.

{
    "alarm_storage": {
        "storage:production_ready": true
    },
    "api": {
        "alarms:history:query:complex": true,
        "alarms:history:query:simple": true,
        "alarms:query:complex": true,
        "alarms:query:simple": true,
        "events:query:simple": true,
        "meters:query:complex": false,
        "meters:query:metadata": true,
        "meters:query:simple": true,
        "resources:query:complex": false,
        "resources:query:metadata": true,
        "resources:query:simple": true,
        "samples:query:complex": true,
        "samples:query:metadata": true,
        "samples:query:simple": true,
        "statistics:aggregation:selectable:avg": true,
        "statistics:aggregation:selectable:cardinality": true,
        "statistics:aggregation:selectable:count": true,
        "statistics:aggregation:selectable:max": true,
        "statistics:aggregation:selectable:min": true,
        "statistics:aggregation:selectable:quartile": false,
        "statistics:aggregation:selectable:stddev": true,
        "statistics:aggregation:selectable:sum": true,
        "statistics:aggregation:standard": true,
        "statistics:groupby": true,
        "statistics:query:complex": false,
        "statistics:query:metadata": true,
        "statistics:query:simple": true
    },
    "event_storage": {
        "storage:production_ready": true
    },
    "storage": {
        "storage:production_ready": true
    }
}
<?xml version="1.0" encoding="UTF-8"?>
<value>
   <api>
      <item>
         <key>statistics:query:complex</key>
         <value>false</value>
      </item>
      <item>
         <key>alarms:history:query:simple</key>
         <value>true</value>
      </item>
      <item>
         <key>meters:query:metadata</key>
         <value>true</value>
      </item>
      <item>
         <key>alarms:query:simple</key>
         <value>true</value>
      </item>
      <item>
         <key>resources:query:simple</key>
         <value>true</value>
      </item>
      <item>
         <key>statistics:aggregation:selectable:quartile</key>
         <value>false</value>
      </item>
      <item>
         <key>statistics:query:simple</key>
         <value>true</value>
      </item>
      <item>
         <key>statistics:aggregation:selectable:count</key>
         <value>true</value>
      </item>
      <item>
         <key>statistics:aggregation:selectable:min</key>
         <value>true</value>
      </item>
      <item>
         <key>statistics:aggregation:selectable:sum</key>
         <value>true</value>
      </item>
      <item>
         <key>alarms:query:complex</key>
         <value>true</value>
      </item>
      <item>
         <key>meters:query:complex</key>
         <value>false</value>
      </item>
      <item>
         <key>statistics:groupby</key>
         <value>true</value>
      </item>
      <item>
         <key>alarms:history:query:complex</key>
         <value>true</value>
      </item>
      <item>
         <key>meters:query:simple</key>
         <value>true</value>
      </item>
      <item>
         <key>samples:query:metadata</key>
         <value>true</value>
      </item>
      <item>
         <key>statistics:query:metadata</key>
         <value>true</value>
      </item>
      <item>
         <key>samples:query:simple</key>
         <value>true</value>
      </item>
      <item>
         <key>resources:query:metadata</key>
         <value>true</value>
      </item>
      <item>
         <key>statistics:aggregation:selectable:max</key>
         <value>true</value>
      </item>
      <item>
         <key>samples:query:complex</key>
         <value>true</value>
      </item>
      <item>
         <key>statistics:aggregation:standard</key>
         <value>true</value>
      </item>
      <item>
         <key>events:query:simple</key>
         <value>true</value>
      </item>
      <item>
         <key>statistics:aggregation:selectable:stddev</key>
         <value>true</value>
      </item>
      <item>
         <key>statistics:aggregation:selectable:avg</key>
         <value>true</value>
      </item>
      <item>
         <key>statistics:aggregation:selectable:cardinality</key>
         <value>true</value>
      </item>
      <item>
         <key>resources:query:complex</key>
         <value>false</value>
      </item>
   </api>
   <storage>
      <item>
         <key>storage:production_ready</key>
         <value>true</value>
      </item>
   </storage>
   <alarm_storage>
      <item>
         <key>storage:production_ready</key>
         <value>true</value>
      </item>
   </alarm_storage>
   <event_storage>
      <item>
         <key>storage:production_ready</key>
         <value>true</value>
      </item>
   </event_storage>
</value>

Events

Lists all events and shows details for an event.

GET
/v2/events
List events

Lists all events.

 
Normal response codes
200
Request parameters
Parameter Style Type Description
q (Optional) query xsd:list

Filters the response by one or more event arguments.

For example:

GET /v2/events?q.field=Foo&q.value=my_text
limit (Optional) query xsd:int

Limits the maximum number of samples that the response returns.

For example:

GET /v2/events?limit=1000
Response parameters
Parameter Style Type Description
event_type plain xsd:string

The dotted string that represents the event.

message_id plain csapi:UUID

The UUID of the message.

generated plain xsd:dateTime

The date and time when the event occurred.

traits plain xsd:list

A list of objects. Each object contains key and value pairs that describe the event.

raw plain xsd:dict

A dictionary object that stores event messages for future evaluation.

[
    {
        "raw": {},
        "traits": [
            {
                "type": "string",
                "name": "action",
                "value": "read"
            },
            {
                "type": "string",
                "name": "eventTime",
                "value": "2015-10-28T20:26:58.545477+0000"
            }
        ],
        "generated": "2015-10-28T20:26:58.546933",
        "message_id": "bae43de6-e9fa-44ad-8c15-40a852584444",
        "event_type": "http.request"
    }
]
GET
/v2/events/​{message_id}​
Show event details

Shows details for an event.

 
Normal response codes
200
Request parameters
Parameter Style Type Description
message_id URI csapi:UUID

The UUID of the message.

Response parameters
Parameter Style Type Description
event_type plain xsd:string

The dotted string that represents the event.

message_id plain csapi:UUID

The UUID of the message.

generated plain xsd:dateTime

The date and time when the event occurred.

traits plain xsd:list

A list of objects. Each object contains key and value pairs that describe the event.

raw plain xsd:dict

A dictionary object that stores event messages for future evaluation.

{
    "raw": {},
    "traits": [
        {
            "type": "string",
            "name": "action",
            "value": "read"
        },
        {
            "type": "string",
            "name": "eventTime",
            "value": "2015-10-28T20:26:58.545477+0000"
        }
    ],
    "generated": "2015-10-28T20:26:58.546933",
    "message_id": "bae43de6-e9fa-44ad-8c15-40a852584444",
    "event_type": "http.request"
}