ListMeters
The ListMeters
action returns information about statistics meters, including the meter name, the meter type, and whether the meter is enabled.
By default, ListMeters
returns all meters for all the connected Controllers, and all services. You can use ControllerUUIDs, Port, and Type to restrict the response.
Coordinator attempts to retrieve the latest live values for meter names from the Controllers. If a Controller is unavailable, Coordinator uses the cached values, and returns a warning that the values are cached. You can also explicitly request the cached values by setting LiveDetails
to False
. In this case, Coordinator does not return a warning.
ListMeters
does not return any statistical values for the meters. To retrieve this information, use the GetStatistics action.
Example
a=ListMeters
a=ListMeters&Port=9000&Type=process
Optional Parameters
This action accepts the following optional parameters.
Parameter | Description |
---|---|
ControllerUUIDs | The UUIDs of the Controllers for which you want to return the list of meters. |
LiveDetails | Whether to retrieve the latest meters from connected Controllers, or to use the cached versions. |
Port | The port on which the service for which you want to return the list of meters is running. |
Type | The type of meter to return. |