|
APIs in Category: perf |
API version 1.5 |
| perf-object-counter-list-info | [top] |
get the info about an object's counters
Input Name Range Type Description objectname string
Name of the object to get information for. Output Name Range Type Description counters counter-info[]
| perf-object-get-instances | [top] |
get the instances of the object.
Input Name Range Type Description counters counter[]
optional
instances instance[]
optional
objectname string
Name of the object to get information for. Output Name Range Type Description instances instance-data[]
timestamp string
Timestamp in seconds
| perf-object-get-instances-iter-end | [top] |
Terminate an iteration over the performance instances.
Input Name Range Type Description tag string
Tag from a pervious perf-object-get-instances-iter-start
| perf-object-get-instances-iter-next | [top] |
Obtain a list of performance object instances
Input Name Range Type Description maximum integer
Maximum number of entries to retrieve. tag string
Tag from a pervious perf-object-get-instances-iter-start Output Name Range Type Description instances instance-data[]
records integer
This tells you how many records are being returned from this call to perf-object-instance-info-iter-next. When this value is 0, you have retrieved everything.
| perf-object-get-instances-iter-start | [top] |
start the iteration over the set of instances of a performance object
Input Name Range Type Description counters counter[]
optional
instances instance[]
optional
objectname string
Name of the object to get information for. Output Name Range Type Description max-index integer
This tells you the numer of items that have been saved for future retrieval with perf-object-instance-list-info-iter-next tag string
Tag to be used in subsequent iterations. timestamp string
Timestamp in seconds
| perf-object-instance-list-info | [top] |
get the info about an object's instances.
Input Name Range Type Description objectname string
Name of the object to get information for. Output Name Range Type Description instances instance-info[]
| perf-object-instance-list-info-iter-end | [top] |
terminate a perf-object-instance iteration
Input Name Range Type Description tag string
Tag from a previous perf-object-instance-list-info-iter-start
| perf-object-instance-list-info-iter-next | [top] |
obtain a list of instances of performance objects
Input Name Range Type Description maximum integer
Maximum number of entries to retrieve. tag string
Tag from a pervious perf-object-instance-list-info-iter-start Output Name Range Type Description instances instance-info[]
records integer
This tells you how many records are being returned from this call to perf-object-instance-info-iter-next. When this value is 0, you have retrieved everything.
| perf-object-instance-list-info-iter-start | [top] |
start an iteration over the performance object instances
Input Name Range Type Description objectname string
Name of the object to get information for. Output Name Range Type Description max-index integer
This tells you the numer of items that have been saved for future retrieval with perf-object-instance-list-info-iter-next tag string
Tag to be used in subsequent iterations.
| perf-object-list-info | [top] |
get the list of objects.
Output Name Range Type Description objects object-info[]
| Element definition: counter | [top] |
Name of the counter to get information for.
[none]
| Element definition: counter-info | [top] |
Describes a counter
Name Range Type Description base-counter string
optional
Name of the counter used as the denominator to calculate values of counters involving percentages. desc string
Description of the counter labels label-info[]
optional
name string
Name of the counter privilege-level string
privilege-level of the counter. can be basic, admin, advanced or diag. properties string
optional
Comma separated properties of the counter Possible values: raw, rate, delta, percent, string and no-display. raw, rate, delta, percent and string are mutually exclusive. type string
optional
Type of the counter. Values: array unit string
optional
Unit of the counter Values: per_sec, percent, b_per_sec, kb_per_sec, msecs, usecs
| Element definition: instance | [top] |
Name of the instance to get information for.
[none]
| Element definition: instance-data | [top] |
Describes an instance
Name Range Type Description counters counter-data[]
name string
Name of the instance
| Element definition: instance-info | [top] |
Describes an instance
Name Range Type Description name string
Name of the instance
| Element definition: object-info | [top] |
Describes an object
Name Range Type Description name string
Name of the object privilege-level string
privilege-level of the object. can be basic, admin, advanced or diag.
| Element definition: counter-data | [top] |
Describes a counter
Name Range Type Description name string
Name of the counter value string
Comma separated array of values. represents single values or arrays.
| Element definition: label-info | [top] |
Comma separated labels in the array.
[none]