class OvirtSDK4::StatisticsService
Constants
- LIST
Public Instance Methods
Retrieves a list of statistics.
For example, to retrieve the statistics for virtual machine `123` send a request like this:
- source
GET /ovirt-engine/api/vms/123/statistics
The result will be like this:
- source,xml
<statistics>
<statistic href="/ovirt-engine/api/vms/123/statistics/456" id="456"> <name>memory.installed</name> <description>Total memory configured</description> <kind>gauge</kind> <type>integer</type> <unit>bytes</unit> <values> <value> <datum>1073741824</datum> </value> </values> <vm href="/ovirt-engine/api/vms/123" id="123"/> </statistic> ...
</statistics>
Just a single part of the statistics can be retrieved by specifying its id at the end of the URI. That means:
- source
GET /ovirt-engine/api/vms/123/statistics/456
Outputs:
- source,xml
<statistic href=“/ovirt-engine/api/vms/123/statistics/456” id=“456”>
<name>memory.installed</name> <description>Total memory configured</description> <kind>gauge</kind> <type>integer</type> <unit>bytes</unit> <values> <value> <datum>1073741824</datum> </value> </values> <vm href="/ovirt-engine/api/vms/123" id="123"/>
</statistic>
The order of the returned list of statistics isn't guaranteed.
@param opts [Hash] Additional options.
@option opts [String] :follow Indicates which inner links should be followed. The objects referenced by these links will be fetched as part
of the current request. See <<documents/003_common_concepts/follow, here>> for details.
@option opts [Integer] :max Sets the maximum number of statistics to return. If not specified all the statistics are returned.
@option opts [Hash] :headers ({}) Additional HTTP headers.
@option opts [Hash] :query ({}) Additional URL query parameters.
@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
given then the timeout set globally for the connection will be used.
@option opts [Boolean] :wait (true) If `true` wait for the response.
@return [Array<Statistic>]
# File lib/ovirtsdk4/services.rb, line 21881 def list(opts = {}) internal_get(LIST, opts) end
Locates the service corresponding to the given path.
@param path [String] The path of the service.
@return [Service] A reference to the service.
# File lib/ovirtsdk4/services.rb, line 21903 def service(path) if path.nil? || path == '' return self end index = path.index('/') if index.nil? return statistic_service(path) end return statistic_service(path[0..(index - 1)]).service(path[(index + 1)..-1]) end
Locates the `statistic` service.
@param id [String] The identifier of the `statistic`.
@return [StatisticService] A reference to the `statistic` service.
# File lib/ovirtsdk4/services.rb, line 21892 def statistic_service(id) StatisticService.new(self, id) end