The Capabilities API allows you to directly discover which functions from the V2 API functionality, including the selectable aggregate functions, are supported by the currently configured storage driver. A capabilities query returns a flattened dictionary of properties with associated boolean values - a ‘False’ or absent value means that the corresponding feature is not available in the backend.
Returns a flattened dictionary of API capabilities.
Capabilities supported by the currently configured storage driver.
Return type: | Capabilities |
---|
A representation of the API and storage capabilities.
Usually constrained by restrictions imposed by the storage driver.
Data samples:
{
"api": {
"events:query:simple": true
},
"event_storage": {
"storage:production_ready": true
}
}
<value>
<api>
<item>
<key>events:query:simple</key>
<value>true</value>
</item>
</api>
<event_storage>
<item>
<key>storage:production_ready</key>
<value>true</value>
</item>
</event_storage>
</value>
Type: | dict(unicode: bool) |
---|
A flattened dictionary of API capabilities
Type: | dict(unicode: bool) |
---|
A flattened dictionary of event storage capabilities
Get all event types.
Return type: | list(unicode) |
---|
Unused API, will always return 404.
Parameters: |
|
---|
Return all trait names for an event type.
Parameters: |
|
---|---|
Return type: | list(TraitDescription) |
Return all instances of a trait for an event type.
Parameters: |
|
---|---|
Return type: | list(Trait) |
Return all events matching the query filters.
Parameters: |
|
---|---|
Return type: | list(Event) |
Return a single event with the given message id.
Parameters: |
|
---|---|
Return type: |
A System event.
Data samples:
{
"event_type": "compute.instance.update",
"generated": "2015-01-01T12:00:00",
"message_id": "94834db1-8f1b-404d-b2ec-c35901f1b7f0",
"raw": {
"status": {
"nested": "started"
}
},
"traits": [
{
"name": "tenant_id",
"value": "7f13f2b17917463b9ee21aa92c4b36d6"
},
{
"name": "request_id",
"value": "req-4e2d67b8-31a4-48af-bb2f-9df72a353a72"
},
{
"name": "service",
"value": "conductor.tem-devstack-01"
}
]
}
<value>
<message_id>94834db1-8f1b-404d-b2ec-c35901f1b7f0</message_id>
<event_type>compute.instance.update</event_type>
<traits>
<item>
<name>tenant_id</name>
<value>7f13f2b17917463b9ee21aa92c4b36d6</value>
</item>
<item>
<name>request_id</name>
<value>req-4e2d67b8-31a4-48af-bb2f-9df72a353a72</value>
</item>
<item>
<name>service</name>
<value>conductor.tem-devstack-01</value>
</item>
</traits>
<generated>2015-01-01T12:00:00</generated>
<raw>{'status': {'nested': 'started'}}</raw>
</value>
Type: | unicode |
---|
The type of the event
Type: | datetime |
---|
The time the event occurred
Type: | unicode |
---|
The message ID for the notification
Type: | json |
---|
The raw copy of notification
Type: | list(Trait) |
---|
Event specific properties
A Trait associated with an event.
Data samples:
{
"name": "service",
"type": "string",
"value": "compute.hostname"
}
<value>
<name>service</name>
<value>compute.hostname</value>
<type>string</type>
</value>
Type: | unicode |
---|
The name of the trait
Type: | unicode |
---|
the type of the trait (string, integer, float or datetime)
Type: | unicode |
---|
the value of the trait
See api-queries for how to query the API.
Query arguments for Event Queries.
Data samples:
{
"field": "event_type",
"op": "eq",
"type": "string",
"value": "compute.instance.create.start"
}
<value>
<type>string</type>
<op>eq</op>
<value>compute.instance.create.start</value>
<field>event_type</field>
</value>
Type: | unicode |
---|
the type of the trait filter, defaults to string