Telemetry API v2 (CURRENT)

Manages Telemetry operations.

Alarms

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

GET
/v2/alarms
List alarms

Lists alarms, based on the specified query.

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

Filter rules for the alarms to be returned. 

[
    {
        "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.

 
{
    "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

Shows information for a specified alarm, by alarm ID.

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

The UUID of the alarm.

 
{
    "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 a specified alarm.

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

The UUID of the alarm.
data (Optional) query Alarm

An alarm within the request body.

 
{
    "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 a specified alarm, by alarm ID.

 
Normal response codes
204
Request parameters
Parameter Style Type Description
alarm_id URI xsd:string

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 a specified alarm.

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

The UUID of the alarm.
state (Optional) query xsd:dict

An alarm state within the request body. 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 a specified alarm, by alarm ID.

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

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 a specified alarm, by alarm ID.

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

The UUID of the alarm.
q (Optional) query xsd:list

Filter rules for the changes to be described.

This operation does not return a response body.

Meters

Gets information for meters.

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

Filter rules for the meters to be returned. 

[
    {
        "meter_id": "YmQ5NDMxYzEtOGQ2OS00YWQzLTgwM2EtOGQ0YTZiODlmZDM2K2luc3RhbmNl\n",
        "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>
    <meter_id>YmQ5NDMxYzEtOGQ2OS00YWQzLTgwM2EtOGQ0YTZiODlmZDM2K2luc3RhbmNl
  </meter_id>
    <name>instance</name>
    <project_id>35b17138-b364-4e6a-a131-8f3099c5be68</project_id>
    <resource_id>bd9431c1-8d69-4ad3-803a-8d4a6b89fd36</resource_id>
    <source>openstack</source>
    <type>gauge</type>
    <unit>instance</unit>
    <user_id>efd87807-12d2-4b38-9c70-5f5c2ac427ff</user_id>
  </value>
</values>
GET
/v2/meters/​{meter_name}​
List samples for meter

Lists samples for a specified 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

Filter rules for the data to be returned.

limit (Optional) query xsd:int

Requests a specified page size of returned items from the query. Returns a number of items up to the specified 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.

marker (Optional) query xsd:string

Specifies the ID of the last-seen item. 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. 

[
    {
        "counter_name": "instance",
        "counter_type": "gauge",
        "counter_unit": "instance",
        "counter_volume": 1.0,
        "message_id": "5460acce-4fd6-480d-ab18-9735ec7b1996",
        "project_id": "35b17138-b364-4e6a-a131-8f3099c5be68",
        "resource_id": "bd9431c1-8d69-4ad3-803a-8d4a6b89fd36",
        "resource_metadata": {
            "name1": "value1",
            "name2": "value2"
        },
        "source": "openstack",
        "timestamp": "2013-11-21T12:33:08.323533",
        "user_id": "efd87807-12d2-4b38-9c70-5f5c2ac427ff"
    }
]
<?xml version="1.0" encoding="UTF-8"?>
<values>
  <value>
    <counter_name>instance</counter_name>
    <counter_type>gauge</counter_type>
    <counter_unit>instance</counter_unit>
    <counter_volume>1.0</counter_volume>
    <message_id>5460acce-4fd6-480d-ab18-9735ec7b1996</message_id>
    <project_id>35b17138-b364-4e6a-a131-8f3099c5be68</project_id>
    <resource_id>bd9431c1-8d69-4ad3-803a-8d4a6b89fd36</resource_id>
    <resource_metadata>
      <item>
        <key>name2</key>
        <value>value2</value>
      </item>
      <item>
        <key>name1</key>
        <value>value1</value>
      </item>
    </resource_metadata>
    <source>openstack</source>
    <timestamp>2013-11-21T12:33:08.323533</timestamp>
    <user_id>efd87807-12d2-4b38-9c70-5f5c2ac427ff</user_id>
  </value>
</values>
POST
/v2/meters/​{meter_name}​
Create meter

Adds a list of samples to the specified meter, by meter name.

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

The name of the meter.
samples (Optional) query xsd:list

A list of samples within the request body. 

[
    {
        "counter_name": "instance",
        "counter_type": "gauge",
        "counter_unit": "instance",
        "counter_volume": 1.0,
        "message_id": "5460acce-4fd6-480d-ab18-9735ec7b1996",
        "project_id": "35b17138-b364-4e6a-a131-8f3099c5be68",
        "resource_id": "bd9431c1-8d69-4ad3-803a-8d4a6b89fd36",
        "resource_metadata": {
            "name1": "value1",
            "name2": "value2"
        },
        "source": "openstack",
        "timestamp": "2013-11-21T12:33:08.323533",
        "user_id": "efd87807-12d2-4b38-9c70-5f5c2ac427ff"
    }
]
<?xml version="1.0" encoding="UTF-8"?>
<values>
  <value>
    <counter_name>instance</counter_name>
    <counter_type>gauge</counter_type>
    <counter_unit>instance</counter_unit>
    <counter_volume>1.0</counter_volume>
    <message_id>5460acce-4fd6-480d-ab18-9735ec7b1996</message_id>
    <project_id>35b17138-b364-4e6a-a131-8f3099c5be68</project_id>
    <resource_id>bd9431c1-8d69-4ad3-803a-8d4a6b89fd36</resource_id>
    <resource_metadata>
      <item>
        <key>name2</key>
        <value>value2</value>
      </item>
      <item>
        <key>name1</key>
        <value>value1</value>
      </item>
    </resource_metadata>
    <source>openstack</source>
    <timestamp>2013-11-21T12:33:08.323533</timestamp>
    <user_id>efd87807-12d2-4b38-9c70-5f5c2ac427ff</user_id>
  </value>
</values>
GET
/v2/meters/​{meter_name}​/statistics
Show meter statistics

Computes and lists statistics for samples in a specified 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

Filter rules for the data to be returned.

groupby (Optional) query xsd:list

Fields for group by aggregation
period (Optional) query xsd:int

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

[
    {
        "avg": 4.5,
        "count": 10,
        "duration": 300.0,
        "duration_end": "2013-01-04T16:47:00",
        "duration_start": "2013-01-04T16:42:00",
        "max": 9.0,
        "min": 1.0,
        "period": 7200,
        "period_end": "2013-01-04T18:00:00",
        "period_start": "2013-01-04T16:00:00",
        "sum": 45.0,
        "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

Gets samples.

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

Filter rules for the samples to be returned. 

[
    {
        "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
    }
]

<values>
  <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>
</values>
GET
/v2/samples/​{sample_id}​
Show sample

Shows information for a specified sample, by sample ID.

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

The UUID of the sample.

 
{
    "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>

This operation does not accept a request body.

Resources

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

Filter rules for the resources to be returned. 

[
    {
        "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",
        "timestamp": "2013-11-21T12:33:08.189843",
        "user_id": "efd87807-12d2-4b38-9c70-5f5c2ac427ff"
    }
]
<?xml version="1.0" encoding="UTF-8"?>
<values>
  <value>
    <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>
    <metadata>
      <item>
        <key>name2</key>
        <value>value2</value>
      </item>
      <item>
        <key>name1</key>
        <value>value1</value>
      </item>
    </metadata>
    <project_id>35b17138-b364-4e6a-a131-8f3099c5be68</project_id>
    <resource_id>bd9431c1-8d69-4ad3-803a-8d4a6b89fd36</resource_id>
    <source>openstack</source>
    <timestamp>2013-11-21T12:33:08.189843</timestamp>
    <user_id>efd87807-12d2-4b38-9c70-5f5c2ac427ff</user_id>
  </value>
</values>
GET
/v2/resources/​{resource_id}​
Show resource information

Shows information for a specified resource, by resource ID.

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

The UUID of 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",
    "timestamp": "2013-11-21T12:33:08.189843",
    "user_id": "efd87807-12d2-4b38-9c70-5f5c2ac427ff"
}
<?xml version="1.0" encoding="UTF-8"?>
<value>
  <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>
  <metadata>
    <item>
      <key>name2</key>
      <value>value2</value>
    </item>
    <item>
      <key>name1</key>
      <value>value1</value>
    </item>
  </metadata>
  <project_id>35b17138-b364-4e6a-a131-8f3099c5be68</project_id>
  <resource_id>bd9431c1-8d69-4ad3-803a-8d4a6b89fd36</resource_id>
  <source>openstack</source>
  <timestamp>2013-11-21T12:33:08.189843</timestamp>
  <user_id>efd87807-12d2-4b38-9c70-5f5c2ac427ff</user_id>
</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.

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

GET
/v2/capabilities
List capabilities

A representation of the API and storage capabilities. Usually constrained by restrictions imposed by the storage driver.

 
Normal response codes
200
Response parameters
Parameter Style Type Description
api plain array

An array of API capabilities for the configured storage driver.

alarms:history:query:complex plain boolean

Indicates whether the complex query capability for alarm history is available for the configured database back end. A value of true indicates that the capability is available.

alarms:history:query:simple plain boolean

Indicates whether the simple query capability for alarm history is available for the configured database back end. A value of true indicates that the capability is available.

alarms:query:complex plain boolean

Indicates whether the complex query capability for alarm definitions is available for the configured database back end. A value of true indicates that the capability is available.

alarms:query:simple plain boolean

Indicates whether the simple query capability for alarm definitions is available for the configured database back end. A value of true indicates that the capability is available.

events:query:simple plain boolean

Indicates whether the simple query capability for events is available for the configured database back end. A value of true indicates that the capability is available.

meters:pagination plain boolean

Indicates whether pagination for meters is available for the configured database back end. A value of true indicates that the capability is available.

meters:query:complex plain boolean

Indicates whether the complex query capability for meters is available for the configured database back end. A value of true indicates that the capability is available.

meters:query:metadata plain boolean

Indicates whether the simple query capability for the metadata of meters is available for the configured database back end. A value of true indicates that the capability is available.

meters:query:simple plain boolean

Indicates whether the simple query capability for meters is available for the configured database back end. A value of true indicates that the capability is available.

resources:pagination plain boolean

Indicates whether pagination for resources is available for the configured database back end. A value of true indicates that the capability is available.

resources:query:complex plain boolean

Indicates whether the complex query capability for resources is available for the configured database back end. A value of true indicates that the capability is available.

resources:query:metadata plain boolean

Indicates whether the simple query capability for the metadata of resources is available for the configured database back end. A value of true indicates that the capability is available.

resources:query:simple plain boolean

Indicates whether the simple query capability for resources is available for the configured database back end. A value of true indicates that the capability is available.

samples:pagination plain boolean

Indicates whether pagination for samples is available for the configured database back end. A value of true indicates that the capability is available.

samples:query:complex plain boolean

Indicates whether the complex query capability for samples is available for the configured database back end. A value of true indicates that the capability is available.

samples:query:metadata plain boolean

Indicates whether the simple query capability for the metadata of samples is available for the configured database back end. A value of true indicates that the capability is available.

samples:query:simple plain boolean

Indicates whether the simple query capability for samples is available for the configured database back end. A value of true indicates that the capability is available.

statistics:aggregation:selectable:avg plain boolean

Indicates whether the avg capability is available for the configured database back end. A value of true indicates that the capability is available. Use the avg capability to get average values for samples.

statistics:aggregation:selectable:cardinality plain boolean

Indicates whether the cardinality capability is available for the configured database back end. A value of true indicates that the capability is available. Use the cardinality capability to get cardinality for samples.

statistics:aggregation:selectable:count plain boolean

Indicates whether the count capability is available for the configured database back end. A value of true indicates that the capability is available. Use the count capability to calculate the number of samples for a specified query.

statistics:aggregation:selectable:max plain boolean

Indicates whether the max capability is available for the configured database back end. A value of true indicates that the capability is available. Use the max capability to calculate the maximum value for a specified query.

statistics:aggregation:selectable:min plain boolean

Indicates whether the min capability is available for the configured database back end. A value of true indicates that the capability is available. Use the min capability to calculate the minimum value for a specified query.

statistics:aggregation:selectable:quartile plain boolean

Indicates whether the quartile capability is available for the configured database back end. A value of true indicates that the capability is available. Use the quartile capability to calculate the quartile of sample volumes for a specified query.

statistics:aggregation:selectable:stddev plain boolean

Indicates whether the stddev capability is available for the configured database back end. A value of true indicates that the capability is available. Use the stddev capability to calculate the standard deviation of sample volumes for a specified query.

statistics:aggregation:selectable:sum plain boolean

Indicates whether the sum capability is available for the configured database back end. A value of true indicates that the capability is available. Use the sum capability to calculate the sum of sample volumes for a specified query.

statistics:aggregation:standard plain boolean

Indicates whether the standard set of aggregation capability is available for the configured database back end. A value of true indicates that the capability is available.

statistics:groupby plain boolean

Indicates whether the groupby capabilityality is available for calculating statistics for the configured database back end. A value of true indicates that the capability is available.

statistics:pagination plain boolean

Indicates whether pagination for statistics is available for the configured database back end. A value of true indicates that the capability is available.

statistics:query:complex plain boolean

Indicates whether the complex query capability for statistics is available for the configured database back end. A value of true indicates that the capability is available.

statistics:query:metadata plain boolean

Indicates whether the simple query capability for the metadata of samples used for calculating statistics is available for the configured database back end. A value of true indicates that the capability is available.

statistics:query:simple plain boolean

Indicates whether the simple query capability for statistics is available for the configured database back end. A value of true indicates that the capability is available.

alarm_storage plain array

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

storage:production_ready plain boolean

Indicates whether the the configured database back end is ready to use in production environment. A value of true indicates that the database back end is ready to use in a production environment.

event_storage plain array

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

storage:production_ready plain boolean

Indicates whether the the configured database back end is ready to use in production environment. A value of true indicates that the database back end is ready to use in a production environment.

storage plain array

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

storage:production_ready plain boolean

Indicates whether the the configured database back end is ready to use in production environment. A value of true indicates that 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:pagination": true,
        "meters:query:complex": false,
        "meters:query:metadata": true,
        "meters:query:simple": true,
        "resources:pagination": false,
        "resources:query:complex": false,
        "resources:query:metadata": true,
        "resources:query:simple": true,
        "samples:pagination": 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:pagination": true,
        "statistics:query:complex": false,
        "statistics:query:metadata": true,
        "statistics:query:simple": true
    },
    "event_storage": {
        "storage:production_ready": true
    },
    "storage": {
        "storage:production_ready": true
    }
}

<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>samples:pagination</key>
      <value>true</value>
    </item>
    <item>
      <key>statistics:pagination</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>resources:pagination</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:pagination</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>statistics:aggregation:selectable:sum</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>