diff --git a/api-ref/src/docbkx/ch_telemetry-v2.xml b/api-ref/src/docbkx/ch_telemetry-v2.xml index eac6a6b4b..dde8b3e4d 100644 --- a/api-ref/src/docbkx/ch_telemetry-v2.xml +++ b/api-ref/src/docbkx/ch_telemetry-v2.xml @@ -11,7 +11,7 @@ Manage Telemetry operations.
Alarms - List, create, gets details for, update, and delete + List, create, get details for, update, and delete alarms.
+
+ Capabilities + Get 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. + + + + + + +
diff --git a/api-ref/src/wadls/telemetry-api/src/v2/common.ent b/api-ref/src/wadls/telemetry-api/src/v2/common.ent new file mode 100644 index 000000000..e627487dd --- /dev/null +++ b/api-ref/src/wadls/telemetry-api/src/v2/common.ent @@ -0,0 +1,393 @@ + + + + An array of API capabilities for the + configured storage driver. + + + + + 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. + + + + + 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. + + + + + 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. + + + + + 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. + + + + + 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. + + + + + Indicates whether pagination + for meters is available for the configured database + back end. A value of true indicates that the capability is available. + + + + + 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. + + + + + 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. + + + + + 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. + + + + + Indicates whether pagination + for resources is available for the configured database + back end. A value of true indicates that the capability is available. + + + + + 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. + + + + + 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. + + + + + 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. + + + + + Indicates whether pagination + for samples is available for the configured database + back end. A value of true indicates that the capability is available. + + + + + 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. + + + + + 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. + + + + + 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. + + + + + 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. + + + + + + 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. + + + + + + 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. + + + + + 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. + + + + + 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. + + + + + 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. + + + + + 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. + + + + + 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. + + + + + 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. + + + + + 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. + + + + + Indicates whether pagination + for statistics is available for the configured database + back end. A value of true indicates that the capability is available. + + + + + 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. + + + + + 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. + + + + + 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. + + + + + Defines the capabilities for the storage that stores persisting alarm definitions. A value of true indicates that the capability is available. + + + + + + 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. + + + + + + + Defines the capabilities for the storage that stores + persisting events. A value of true indicates that + the capability is available. + + + + + + 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. + + + + + Defines the capabilities for the storage that stores persisting samples. A value of true indicates that the capability is available. + + + + + 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. + + + '> \ No newline at end of file diff --git a/api-ref/src/wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl b/api-ref/src/wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl index 2976b2d38..8b1e5fb9b 100644 --- a/api-ref/src/wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl +++ b/api-ref/src/wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl @@ -1,9 +1,11 @@ + +%common;]> - + @@ -53,8 +55,35 @@ + + + + + + A representation of + the API and storage capabilities. Usually + constrained by restrictions imposed by + the storage driver. + + + + + + + + + + + + &capabilitiesListParameters; + + + diff --git a/api-ref/src/wadls/telemetry-api/src/v2/samples/capabilities.json b/api-ref/src/wadls/telemetry-api/src/v2/samples/capabilities.json new file mode 100644 index 000000000..818c0dc01 --- /dev/null +++ b/api-ref/src/wadls/telemetry-api/src/v2/samples/capabilities.json @@ -0,0 +1,44 @@ +{ + "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 + } +} diff --git a/api-ref/src/wadls/telemetry-api/src/v2/samples/capabilities.xml b/api-ref/src/wadls/telemetry-api/src/v2/samples/capabilities.xml new file mode 100644 index 000000000..76398133f --- /dev/null +++ b/api-ref/src/wadls/telemetry-api/src/v2/samples/capabilities.xml @@ -0,0 +1,146 @@ + + + + statistics:query:complex + false + + + alarms:history:query:simple + true + + + meters:query:metadata + true + + + alarms:query:simple + true + + + resources:query:simple + true + + + statistics:aggregation:selectable:quartile + false + + + statistics:query:simple + true + + + statistics:aggregation:selectable:count + true + + + statistics:aggregation:selectable:min + true + + + samples:pagination + true + + + statistics:pagination + true + + + alarms:query:complex + true + + + meters:query:complex + false + + + resources:pagination + false + + + statistics:groupby + true + + + alarms:history:query:complex + true + + + meters:pagination + true + + + meters:query:simple + true + + + samples:query:metadata + true + + + statistics:query:metadata + true + + + samples:query:simple + true + + + resources:query:metadata + true + + + statistics:aggregation:selectable:max + true + + + samples:query:complex + true + + + statistics:aggregation:standard + true + + + statistics:aggregation:selectable:sum + true + + + events:query:simple + true + + + statistics:aggregation:selectable:stddev + true + + + statistics:aggregation:selectable:avg + true + + + statistics:aggregation:selectable:cardinality + true + + + resources:query:complex + false + + + + + storage:production_ready + true + + + + + storage:production_ready + true + + + + + storage:production_ready + true + + +