Resource /webmapi/statsExpand | Collapse

APIs for real-time or archived performance history

Get the current statistics for an object
Description

Get the current statistics for an object

HTTP Example

POST /webmapi/stats

Input

Pass input arguments in StatsShowInputType

Output

Reports successful result in ResponseContentType<StatsShowOutputType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
STATS_SHOW_OBJECT_NOT_FOUND21011Object not found.
STATS_SHOW_INSTANCE_NOT_FOUND21012Instances not found.
STATS_SHOW_COUNTER_NOT_FOUND21013Counters not found.
STATS_SHOW_INCORRECT_ARGUMENTS21014The arguments specified were incorrect. Possible reasons: Interval specified is greater than duration, value of interval or duration is negative, specified an interval and no duration (or vice versa).
STATS_SHOW_COUNTERS_NOT_SET21015Counter names were not specified in the input.
STATS_SHOW_INSTANCES_NOT_SET21016Instances were not specified in the input.
STATS_SHOW_OBJECT_NOT_SET21017Object was not specified in the input.
STATS_SHOW_DISK_NOT_AVAILABLE21022There are no disks.
STATS_SHOW_CM_NOT_INIT21032Counter manager is not initialized.
STATS_SHOW_CM_IN_PRESHUTDOWN21033Counter manager is in preshutdown state; cannot service request.
STATS_SHOW_CM_SCOPE_INSTANCE_SPECIFIED21035Scope and instances parameters are mutually exclusive.
STATS_SHOW_SORT_BY_COUNTER_NOT_SPECIFIED21036The top and bottom parameters must be accompanied by sort-by-counter parameter.
STATS_SHOW_SORT_BY_STRING_COUNTER_NOT_ALLOWED21037Unable to sort by a string type counter.
STATS_SHOW_SORT_BY_HISTOGRAM_COUNTER_NOT_ALLOWED21038Unable to sort by a histogram type counter.
STATS_SHOW_SORT_BY_COUNTER_NOT_FOUND21039Counter specified by sort-by-counter parameter not found.
STATS_SHOW_CM_TOP_BOTTOM_SPECIFIED21040Top and bottom parameters are mutually exclusive.
Produces

application/json

Consumes

application/json

Since

1.0

Counter archiver history for requested counters
Description

Counter archiver history for requested counters

HTTP Example

POST /webmapi/stats/archives

Input

Pass input arguments in ArchiverShowInputType

Output

Reports successful result in ResponseContentType<ArchiverShowOutputType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
ARCHIVER_SHOW_INTERNAL_ERROR34000Internal error occurred.
ARCHIVER_SHOW_ARCHIVER_NEGATIVE_TIMESTAMP34001Timestamp specified must be positive.
ARCHIVER_SHOW_ARCHIVER_TIME_BEGIN_AFTER_END34002Begin time must start before or at end time.
ARCHIVER_SHOW_ARCHIVER_INSTANCE_NOT_FOUND34003Instance not found.
ARCHIVER_SHOW_ARCHIVER_COUNTER_NOT_FOUND34004Counter not found.
ARCHIVER_SHOW_ARCHIVER_OBJECT_NOT_FOUND34005Object not found.
ARCHIVER_SHOW_ARCHIVER_SCOPE_INSTANCE_NOT_SET34006Scope or instances must be set.
ARCHIVER_SHOW_ARCHIVER_DB_QUERY_FAILED34007Error returned from database query.
ARCHIVER_SHOW_ARCHIVER_TOO_MANY_INSTANCES34008Too many instances specified, max = 4.
Produces

application/json

Consumes

application/json

Since

1.0