APIs in Category: perf | Cluster-Mode API version 1.20

perf-archive-config-get perf-archive-config-modify perf-archive-create perf-archive-destroy perf-archive-get-iter perf-archive-modify perf-object-counter-list-info perf-object-get-instances perf-object-instance-list-info-iter perf-object-list-info perf-preset-create perf-preset-delete perf-preset-detail-get perf-preset-get-iter perf-preset-modify | The perf APIs enable monitoring of system performance. They provide a single interface to performance data across various subsystems in the appliance. Data are organized hierarchically, with objects, instances, and counters. An object generally represents a subsystem, an instance represents a single physical or logical entity within the subsystem, and a counter is a datum specific to the instance. An example of the object-instance-counter hierarchy is processor:processor0:processor_busy. Each CPU in the system is an instance of the 'processor' object. The processor_busy counter of the processor0 instance reports the time during which this processor has been active since an arbitrary point in the past. A second counter, processor_elapsed_time, reports the total time, so the change in processor_busy divided by the change in processor_elapsed_time over an interval can be used to compute the average utilization of the processor. Processor_elapsed_time is referred to as the 'base counter' of processor_busy since it is needed to compute a useful value from processor_busy. A typical user of these APIs will initially request a list of objects using the perf-object-list-info call. The user may then request a list of counters available for instances of an object by calling perf-object-counter-list-info for each interesting object. The sets of objects and counters are static, so these calls will not need to be made again. The core perf API call is perf-object-get-instances. This API returns the names and raw counter values of instances of an object at the time of the call. Unlike objects and counters, the set of instances is not always fixed, and the values of counters will vary across calls. Typically this API must be called at least twice over some interval in order to evaluate subsystem performance during that interval. Depending on counter properties, the user may need to perform additional computation on the raw value in order to correctly interpret it. Each counter has a property which indicates how it's raw value should be interpreted. This property is available as part of the static counter metadata returned by a call to perf-object-counter-list-info. Possible properties are 'raw', 'rate', 'delta', 'average', 'percent', 'string', and 'no-display'. String counters report textual information, such as volume or disk identifiers. No-display counters are not intended for direct use, and this property is typically assigned to base counters. The other properties are interpreted as follows: raw: single counter value is used delta: change in counter value between two samples is used rate: delta divided by the time in seconds between samples is used average: delta divided by the delta of a base counter is used percent: 100*average is used For 'average' and 'percent' counters, the 'base-counter' element will be set to the name of the base counter. Some counters are multidimensional, and for these the counter description includes a list of labels of the counter subelements, and a 'type' element indicating the counter is an array. For example, again consider the processor::processor_busy counter. The description and properties of this counter state that it is a percentage, but a call to perf-object-get-instances will return a raw number which must be further processed by the user. Because the counter is a percentage, the user must note the value of its base counter, (processor::processor_elapsed_time) and then make a second call to perf-object-get-instances and again note the raw value of the counter and base counter. Suppose the user made the calls at time T1 and later at time T2, and these raw values were returned (the object and instance name are not shown): (T1) processor_busy=2000000, processor_elapsed_time=3000000 (T2) processor_busy=2400000 ,processor_elapsed_time=4000000 The user must then perform the following computation to determine processor utilization: 100*(2400000-2000000)/(4000000-3000000) = 40% The perf-object-instance-list-info API may be used to list the names of current instances of an object. It does not return any counter values.

NetApp Manage ONTAP

perf-archive-config-get | [top]

> Display the current Performance Archive configuration

> Input Name | Range | Type | Description
> desired-attributes |  | archive-config-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> Output Name | Range | Type | Description
> attributes |  | archive-config-info | The attributes of the perf-archive-config.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

perf-archive-config-modify | [top]

> Modify the current Performance Archive configuration

> Input Name | Range | Type | Description
> datastore-file-rotation | [1..120] | integer optional | Minutes Between Performance Archive Data File Rotations
> datastore-max-percent | [0..100] | integer optional | Maximum Percentage of Root Volume Used for Performance Archive Data
> datastore-max-retention | [1..365] | integer optional | Days to Retain Performance Archive Data
> is-enabled |  | boolean optional | Is the Performance Archive Enabled?

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

perf-archive-create | [top]

> Save a new Performance Archive

> Input Name | Range | Type | Description
> archive |  | string | Performance Archive Name
> case-number |  | string optional | Support Case Number Associated with Archive
> comment |  | string optional | Performance Archive Comment
> end-time | [0..2^31-1] | integer | End of Performance Archive's time range (UTC)
> source-nodes |  | node-name[] optional | Originating Nodes for Archive Data
> start-time | [0..2^31-1] | integer | Start of Performance Archive's time range (UTC)
> Output Name | Range | Type | Description
> result |  | perf-archive-info optional | The perf-archive created (keys or the entire object if requested)
> result-error-code | [0..2^32-1] | integer optional | Error code, if the operation caused an error.
> result-error-message |  | string optional | Error description, if the operation caused an error.
> result-jobid | [0..2^64-1] | integer optional | The ID of the job that was spawned to create this perf-archive.
> result-status |  | string optional | The operation status. Possible values: "succeeded" if creation completed successfully, "in_progress" if creation is in progress, "failed" if creation failed.

> Errno | Description
> EINTERNALERROR |  |

perf-archive-destroy | [top]

> Destroy a Performance Archive

> Input Name | Range | Type | Description
> archive |  | string | Performance Archive Name
> Output Name | Range | Type | Description
> result-error-code | [0..2^32-1] | integer optional | Error code, if the deletion operation caused an error.
> result-error-message |  | string optional | Error description, if the operation caused an error.
> result-jobid | [0..2^64-1] | integer optional | Job Id, if this operation was performed via a job.
> result-status |  | string | The operation status. Possible values: "succeeded", "in_progress", "failed".

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

perf-archive-get-iter | [top]

> Iteratively get information about Performance Archives

> Input Name | Range | Type | Description
> desired-attributes |  | perf-archive-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | perf-archive-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the perf-archive object. All perf-archive objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | perf-archive-info[] optional | The list of attributes of perf-archive objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more perf-archive objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

perf-archive-modify | [top]

> Modify properties of a Performance Archive

> Input Name | Range | Type | Description
> archive |  | string | Performance Archive Name
> case-number |  | string optional | Support Case Number Associated with Archive
> comment |  | string optional | Performance Archive Comment

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

perf-object-counter-list-info | [top]

> Get information about the counters of an object. This information is static and independent of any particular instance of the object. It includes counter names and descriptions, as well as properties which are necessary to to interpret counter values.

> Input Name | Range | Type | Description
> filter-data |  | filter-data optional | Allows selecting counters from a particular node. An example filter is "node_name=hostname". This element is deprecated in Data ONTAP 8.2 and later, as filtering by node is no longer necessary. Each node contains the same set of counter definitions, so filtering by node yields the same results as not filtering at all.
> objectname |  | string | Name of the object to get information for.
> Output Name | Range | Type | Description
> counters |  | counter-info[] | List of counters available for instances of this object.

perf-object-get-instances | [top]

> Get a list of current counter values of instances of an object. This will return the values of all specified counters and instances of the specified object with one call. In Data ONTAP 7-Mode, if the object is expected to have a large number of instances and/or counters, the iterator version of this API should be used.

> Input Name | Range | Type | Description
> counters |  | counter[] optional | List of counters whose values will be retrieved. This element can be used to limit data collection to a specified subset of the counters of instances of the object. If this element is absent, values of all counters will be retrieved.
> filter-data |  | filter-data optional | Filter to apply to the performance data.
> instance-uuids |  | instance-uuid[] optional | List of instance UUIDs for which to get counter values. This element can be used to limit data collection to a specified subset of the instances of the object. Either instances or instance-uuids input must be provided. The API errors out if both of these inputs are provided or neither of these inputs is provided, or if more than 500 instances are requested.
> instances |  | instance[] optional | List of instance names for which to get counter values. This element can be used to limit data collection to a specified subset of the instances of the object. In Data ONTAP 7-Mode, counter values of all instances of the object will be retrieved when this element is absent. In Data ONTAP Cluster-Mode, either instances or instance-uuids input must be provided. The API errors out if both of these inputs are provided or neither of these inputs is provided, or if more than 500 instances are requested.
> objectname |  | string | Name of the object to get counter values for.
> privilege-level |  | string optional | Name of the privilege level. Possible values: "basic", "admin", "advanced", "diag" If the element is absent, the default privilege of the object will be used.
> Output Name | Range | Type | Description
> instances |  | instance-data[] | List of instances of the object. Each element of this list
> timestamp |  | string | Timestamp in seconds since January 1, 1970.

perf-object-instance-list-info-iter | [top]

> Gets the list of names and UUIDs of current instances of an object. This iterative API will return names and UUIDs of the current instances of the specified object; the number of records returned is specified by the max-records input element. To retrieve all the instances of the specified object, the value of the next-tag output element should be passed in as the value of the tag input element on the subsequent API call.

> Input Name | Range | Type | Description
> desired-attributes |  | instance-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> filter-data |  | string optional | Filter to apply to instance list; see filter-data type for details.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 1000
> objectname |  | string | Name of the object for which to get instance information.
> query |  | instance-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the perf object. All perf objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | instance-info[] optional | The list of attributes of perf objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more perf objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

perf-object-list-info | [top]

> Get list of performance objects in the system.

> Input Name | Range | Type | Description
> filter-data |  | filter-data optional | Allows selecting objects from a particular node. An example filter is "node_name=hostname". This element is deprecated in Data ONTAP 8.2 and later as filtering by node is no longer necessary. Each node contains the same set of object definitions, so filtering by node yields the same results as not filtering at all.
> Output Name | Range | Type | Description
> objects |  | object-info[] | List of performance objects.

perf-preset-create | [top]

> Create a single Performance Preset configuration and all of its details

> Input Name | Range | Type | Description
> comment |  | string optional | Preset Description
> expiration-length | [5..1440] | integer optional validate | Default expiration length (in minutes) until the Performance Preset will be automatically disabled.
> is-archive-enabled |  | boolean optional | Is Preset Enabled?
> preset |  | string | Preset Name
> preset-detail-infos |  | preset-detail-info[] optional | Details of the Performance Preset
> privilege |  | string optional | Privilege level Possible Values: admin, advanced, diagnostic

perf-preset-delete | [top]

> Delete a Performance Preset and all of its Preset Details

> Input Name | Range | Type | Description
> preset |  | string | Preset Name

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

perf-preset-detail-get | [top]

> Get detailed information about a single Performance Preset configuration

> Input Name | Range | Type | Description
> preset |  | string | Preset Name
> Output Name | Range | Type | Description
> comment |  | string optional | Preset Description
> expiration-end-date | [0..2^32-1] | integer optional | Date when the Preset will be automatically disabled, represented as the number of seconds since January 1, 1970.
> expiration-length | [5..1440] | integer optional | Default expiration length (in minutes) until the Performance Preset will be automatically disabled.
> generation-id | [0..2^32-1] | integer | Preset Generation ID
> is-archive-enabled |  | boolean | Is Preset Archive-Enabled?
> is-read-only |  | boolean | Is Preset Read-Only?
> preset |  | string | Preset Name
> preset-detail-infos |  | preset-detail-info[] | The details of the Performance Preset configuration
> privilege |  | string optional | Preset Privilege Level Possible Values: admin, advanced, diagnostic
> uuid |  | uuid | Preset UUID

perf-preset-get-iter | [top]

> Iteratively get information about Performance Presets

> Input Name | Range | Type | Description
> desired-attributes |  | preset-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | preset-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the perf-preset object. All perf-preset objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | preset-info[] optional | The list of attributes of perf-preset objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more perf-preset objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

perf-preset-modify | [top]

> Modify a Performance Preset

> Input Name | Range | Type | Description
> comment |  | string optional | Preset Description
> is-archive-enabled |  | boolean optional | Is Preset Archive-Enabled?
> preset |  | string | Preset Name
> privilege |  | privilege-level optional | Preset Privilege Level

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

Element definition: archive-config-info | [top]

> Performance Archive configuration information When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> datastore-file-rotation | [1..120] | integer optional | Minutes Between Performance Archive Data File Rotations Attributes: non-creatable, modifiable
> datastore-max-percent | [0..100] | integer optional | Maximum Percentage of Root Volume Used for Performance Archive Data Attributes: non-creatable, modifiable
> datastore-max-retention | [1..365] | integer optional | Days to Retain Performance Archive Data Attributes: non-creatable, modifiable
> is-enabled |  | boolean optional | Is the Performance Archive Enabled? Attributes: non-creatable, modifiable
> version |  | string optional | Data ONTAP Version of Installed Configuration Attributes: non-creatable, non-modifiable

Element definition: counter | [top]

> Counter Name

> [none]

Element definition: counter-info | [top]

> Information about a single counter.

> Name | Range | Type | Description
> aggregation-style |  | string optional | For counters that can be aggregated, this element decribes the style. If the element is absent, no aggregation is available for this counter. Valid values include: [ strict, permissive ]. "strict" aggregation requires all items of a set to perform aggregation. If any item is missing, the aggregation will be rejected. "permissive" aggregation is a best effort aggregation. All available items of a set will be aggregated. Aggregation-style is deprecated in Data ONTAP 8.2 and later. This field has never been used.
> base-counter |  | string optional | Name of the counter used as the denominator to calculate values of counters involving averages and percentages.
> desc |  | string | Description of the counter
> is-key |  | boolean optional | True if the counter is a key counter. A set of key counters for an object can be used to uniquely identify instances of an object.
> labels |  | label-info[] optional | List of labels of an array type counter.
> name |  | string | Name of the counter.
> privilege-level |  | string | Privilege level of the counter. Any counter with a privilege level of "diag" is not guaranteed to work, to exist in future releases, or to remain unchanged. Possible values: basic, admin, advanced or diag.
> properties |  | string optional | Comma separated list of properties of the counter. The counter properties determine how raw counter values should be interpreted. Possible values: raw, rate, delta, percent, string, no-display and no-zero-values.
> translation-input-counter |  | string optional | Name of counter that is used as input for translation. Translation is needed for some counters because the precise value is unknown at the moment of sampling, and must be determined from another counter at a later time. Note that the time frame is still within a single request and response from the ZAPI client's point of view. Translation-input-counter is deprecated in Data ONTAP 8.2 and later. This field does not convey necessary information for about counters. It was previously used for diagnostic purposes, but it is no longer needed.
> type |  | string optional | Indicator for whether counter is a scalar or array. If this element is absent,the counter is a scalar. Possible values: array
> unit |  | string optional | Unit of the counter Possible values: per_sec, b_per_sec (bytes/s), kb_per_sec (Kbytes/s), mb_per_sec (Mbytes/s), percent, millisec, microsec, sec, or none

Element definition: filter-data | [top]

> A string, representing filter data, in the format of key=value pairs. Multiple pairs can be specified via comma (",") or pipe ("|") separation. The applied filter is a combination of ANDing and ORing the key-value pairs. A comma indicates ANDing, a pipe indicates ORing, and the order of precedence is AND and then OR. For example, "`instance_name=volA,vserver_name=vs1|vserver_name=vs2`" equates to "`(instance_name=volA && vserver_name=vs1) | (vserver_name=vs2)`". This would return instances on Vserver `vs1` with name `volA` and all instances on Vserver `vs2`.

> [none]

Element definition: instance | [top]

> Instance name.

> [none]

Element definition: instance-data | [top]

> Instance name and counter values.

> Name | Range | Type | Description
> aggregation |  | aggregation-data optional | Information related to aggregation that was done. If element is absent, no aggregation was performed on this instance.
> counters |  | counter-data[] | List of counter values of this instance. Each element of this list contains the value of a single counter.
> name |  | string | Name of the instance
> uuid |  | string | UUID of the instance

Element definition: instance-info | [top]

> Description of an instance of an object.

> Name | Range | Type | Description
> name |  | string optional | Name of the instance
> uuid |  | string optional | UUID of the instance

Element definition: instance-uuid | [top]

> Instance UUID.

> [none]

Element definition: node-name | [top]

> The node's name

> [none]

Element definition: object-info | [top]

> Description of a performance object.

> Name | Range | Type | Description
> description |  | string optional | Description of the object
> get-instances-preferred-counter |  | string optional | Name of the counter, either instance_name or instance_uuid, which should be used for perf-object-get-instances ZAPI for optimal performance. If this element is absent for an object, the value of this element defaults to instance_name counter. This element is a performance hint for getting optimal performance for the perf-object-get-instances ZAPI. If the value of this element is set to instance UUID counter of an object, using the instance UUID counter in the perf-object-get-instances query will return the counter information faster than using instance name counter. Otherwise, instance_name will yield faster results.
> name |  | string | Name of the object
> privilege-level |  | string | The object privilege level. Any object with a privilege level of "diag" is not guaranteed to work, to exist in future releases, or to remain unchanged. Possible values: basic, admin, advanced or diag.

Element definition: perf-archive-info | [top]

> Performance Archive Information When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> archive |  | string optional | Performance Archive Name Attributes: key, required-for-create, non-modifiable
> case-number |  | string optional | Support Case Number Associated with Archive Attributes: optional-for-create, modifiable
> comment |  | string optional | Performance Archive Comment Attributes: optional-for-create, modifiable
> end-time | [0..2^31-1] | integer optional | End of Performance Archive's time range (UTC) Attributes: required-for-create, non-modifiable
> path |  | string[] optional | Path to Archive File(s) on Disk Attributes: non-creatable, non-modifiable
> size |  | size optional | Size of Archive File(s) on Disk Attributes: non-creatable, non-modifiable
> source-nodes |  | node-name[] optional | Originating Nodes for Archive Data Attributes: optional-for-create, non-modifiable
> start-time | [0..2^31-1] | integer optional | Start of Performance Archive's time range (UTC) Attributes: required-for-create, non-modifiable
> state |  | performance-archive-state optional | State of Performance Archive Attributes: non-creatable, non-modifiable Possible values: "create_calculating" - Archive properties being calculated, "create_queueing" - Archive waiting to be created, "create_packaging" - Archive files being packaged on source nodes, "create_incomplete" - Not all requested nodes included in saved Archive, "created" - Successfully saved Archive to disk, "create_failed" - Errors occurred while saving Archive to disk, "destroy_queueing" - Archive waiting to be destroyed, "destroy_cleaning" - Archive actively being destroyed and removed from disk, "destroy_incomplete" - Archive not completely removed from all nodes, "destroyed" - Archive successfully removed from the cluster, "destroy_failed" - Errors occurred while destroying Archive, "invalid_state" - Invalid state that should not be reached
> uuid |  | uuid optional | Performance Archive UUID Attributes: non-creatable, non-modifiable

Element definition: preset-detail-info | [top]

> Performance Preset Detail information, including specific objects, counter sets, instance filters, and associated sample period information for the Performance Archive.

> Name | Range | Type | Description
> counter-set |  | counter[] | Counter Name Set
> generation-id | [0..2^32-1] | integer optional | Preset Detail Generation ID As input, this field must not be specified; as output, this field is always present.
> instance-filters |  | filter[] optional | Instance Filters
> object |  | string | Performance Object
> sample-period |  | string optional | Performance Archive Sample Period As input, this field is optional; as output, this field is always present. Possible Values: none, 1s, 5s, 10s, 30s, 1m, 5m, 10m, 30m, 1h, 6h, 12h, 1d, 1w, config Default: none

Element definition: preset-info | [top]

> Performance Preset information When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> comment |  | string optional | Preset Description Attributes: optional-for-create, modifiable
> generation-id | [0..2^32-1] | integer optional | Preset Generation ID Attributes: non-creatable, non-modifiable
> is-archive-enabled |  | boolean optional | Is Preset Archive-Enabled? Attributes: non-creatable, modifiable
> is-read-only |  | boolean optional | Is Preset Read-Only? Attributes: non-creatable, non-modifiable
> preset |  | string optional | Preset Name Attributes: key, required-for-create, non-modifiable
> privilege |  | privilege-level optional | Preset Privilege Level Attributes: optional-for-create, modifiable
> uuid |  | uuid optional | Preset UUID Attributes: non-creatable, non-modifiable

Element definition: privilege-level | [top]

> Level of Privilege

> [none]

Element definition: uuid | [top]

> The 128-bit universally-unique identifier (UUID). UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s.The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used.

> [none]

Element definition: aggregation-data | [top]

> Information related to aggregation that was done.

> Name | Range | Type | Description
> constituent-count | [0..2^32-1] | integer optional | Number of constituents used to aggregate this instance.
> result |  | string optional | Each counter for an instance can be part of an aggregation set. Each counter can either have a strict or permissive aggregation. (Basically whether an aggregation with missing data samples in the aggregation set can be considered valid.) Possible values: "complete_aggregation", "partial_aggregation" If aggregation is 'strict', and we have all of the data samples, we return: complete_aggregation If aggregation is 'strict' and we DON'T have all of the data samples, we return: partial_aggregation If aggregation is 'strict' and we only have one instance (such as a flex vole) we return: complete_aggregation If aggregation is 'permissive', we always return: complete_aggregation (since the results are always valid) NOTE: Since a given node DOES NOT have enough information to determine all of the members of the set, we have to assume if we can't contact a given node/process that may contain a piece to be aggregated, the aggregation is incomplete. (For example, if we're trying to aggregate 'volume' stats, and we can't contact the local dblade or a remote node, we'll mark it as incomplete.)

Element definition: counter | [top]

> Counter Name

> [none]

Element definition: counter-data | [top]

> Value of a single counter of an instance of an object at the time of the call.

> Name | Range | Type | Description
> name |  | string | Name of the counter
> value |  | string | Value of the counter. If the counter type is array, this is a comma separated list of values. The counter properties and units must be known in order to interpret this value. Refer to the perf API discussion for details on how raw counter values are interpreted.

Element definition: filter | [top]

> Instance filter specified as a comma-seperated list of "counter=value" pairs.

> [none]

Element definition: label-info | [top]

> Comma separated list of labels of an array type counter.

> [none]

Element definition: node-name | [top]

> The node's name

> [none]

Element definition: performance-archive-state | [top]

> The state of a Performance Archive Possible values: "create_calculating" - Archive properties being calculated, "create_queueing" - Archive waiting to be created, "create_packaging" - Archive files being packaged on source nodes, "create_incomplete" - Not all requested nodes included in saved Archive, "created" - Successfully saved Archive to disk, "create_failed" - Errors occurred while saving Archive to disk, "destroy_queueing" - Archive waiting to be destroyed, "destroy_cleaning" - Archive actively being destroyed and removed from disk, "destroy_incomplete" - Archive not completely removed from all nodes, "destroyed" - Archive successfully removed from the cluster, "destroy_failed" - Errors occurred while destroying Archive, "invalid_state" - Invalid state that should not be reached

> [none]

Element definition: size | [top]

> Size in bytes Range : [0..2^63-1].

> [none]