APIs in Category: graph | API version 3.7.1

graph-data-list-info graph-list-info-iter-end graph-list-info-iter-next graph-list-info-iter-start | These APIs allow the user to get information and data of all the graphs present in DFM. The graph-list-info-iter-* API can be used presentation and graph-data-list-info API is used for retrieving data of the graphs. Some of the key terms are as follows: A graph line is a line obtained on the graph when a graph sample is plotted against the timestamp. A graph line value is the sample value at an instance of time. Graph period is the period for which the graph data has to be returned. The graph data can be obtained for a period of 1 day (1d), 1 week (1w), 1 month (1m), 3 months (3m) and 1 year (1y). It may also contain some extrapolated values which can be used for trending.

NetApp Manage ONTAP

graph-data-list-info | [top]

> Retrieve data of all the graph lines of a graph.

> Input Name | Range | Type | Description
> end-date |  | integer optional | The number of seconds in the future that the graph should end. The graph values from the current time till the end-date will be extrapolated and used for trending. Use a negative value if the graph should stop in the past.
> graph-name |  | string | Name of the graph. Maximum length: 64 characters.
> graph-period |  | string optional | The period for which graph data has to be returned. This returns consolidated graph data depending on the graph period. Possible values: '1d' - graph data for 1 day. '1w' - graph data for 1 week. '1m' - graph data for 1 month. '3m' - graph data for 3 months. '1y' - graph data for 1 year. Default value is '1d'. The default value of start-date will be the same as the graph period specified. The default values of end-date will be as follows: 3 hours for graph period '1d'. 1 day for graph period '1w'. 4 days for graph period '1m'. 7 days for graph period '3m'. 31 days for graph period '1y'.
> primary-object |  | obj-name-or-id optional | The primary object for which the graph data is returned. If not specified then global group is considered.
> secondary-object |  | obj-name-or-id optional | This object is valid only if the primary object is a quota user and should be a volume or a qtree.The primary and secondary object together represent a single quota object. If not specified, - its ignored only if the primary object is not a quota user. - if the primary object is a quota user then the ZAPI will fail with errors. Used in graphs like user-disk-space-used-vs-total, user-disk-space-used-percent.
> start-date |  | integer optional | The number of seconds in the past that the graph should start.
> Output Name | Range | Type | Description
> graph-line-values |  | graph-line-value-info[] | Data for various lines in a graph.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EOBJECTNOTFOUND |  |
> EOBJECTAMBIGUOUS |  |

graph-list-info-iter-end | [top]

> Input Name | Range | Type | Description
> tag |  | string | An opaque handle used by the DFM station to identify a temporary store.

> Errno | Description
> EINVALIDTAG |  |

graph-list-info-iter-next | [top]

> Returns items from a previous call to graph-list-info-iter-start

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of entries to retrieve. Range: [1..(2^31)-1]
> tag |  | string | An opaque handle used by the DFM station to identify a temporary store.
> Output Name | Range | Type | Description
> graphs |  | graph-info[] | A list of graphs.
> records |  | integer | The number of records actually returned.

> Errno | Description
> EINVALIDTAG |  |

graph-list-info-iter-start | [top]

> Initiates a query for a list of graphs and its metadata like graph lines and sample information.

> Input Name | Range | Type | Description
> graph-name |  | string optional | Name of the graph. If not specified then all the graphs are returned. Maximum length: 64 characters.
> Output Name | Range | Type | Description
> records |  | integer | Number indicating how many items are available for future retrieval with graph-list-info-iter-next. Range: [1..(2^31)-1]
> tag |  | string | An opaque handle used by the DFM station to identify a temporary store. Used in subsequent calls to graph-list-info-iter-next or graph-list-info-iter-end.

> Errno | Description
> EGRAPHNOTFOUND |  |
> EAPIERROR |  |

Element definition: graph-info | [top]

> Describes the meta data of a graph.

> Name | Range | Type | Description
> graph-lines |  | graph-line-info[] | Specifies the list of lines in the graph.
> graph-name |  | string | Specifies the name of the graph. Maximum length: 64 characters.
> graph-pretty-name |  | string | Specifies the pretty name of the graph. Maximum length: 64 characters.

Element definition: graph-line-value-info | [top]

> The sample values of a line in a graph.

> Name | Range | Type | Description
> sample-name |  | string | Name of the sample. Maximum length: 64 characters.
> sample-values |  | string | A comma separated list of timestamp:value pairs. The timestamp value is the time in seconds since 00:00:00 Jan 1, 1970, UTC. The values may have optional decimal extensions, for example 1064439599:127, 1064439600:98.6, 1064439601:12. If the value of the sample is not available for a particular time, then the value returned will be empty e.g. (1188779400:).

Element definition: obj-name-or-id | [top]

> Name or internal ID of a DFM object. This typedef is an alias for the builtin ZAPI type string. An obj-name-or-id must contain between 1 and 64 characters, and must conform to one of the following formats: It must have the format of an obj-name, or It must be the decimal numeric string form of a positive integer whose value is in the range [1..2^31 - 1]. Elements of type obj-name-or-id are used only as inputs to ZAPIs. The value must match either the name or internal ID of an existing DFM object. The ZAPI must specify the object's DFM object type (e.g. data set, host, DP policy, etc.). Some ZAPIs allow the object to be one of several different types. If the format of an obj-name-or-id input element does not conform, or the value does not match the name or ID of an existing object, then generally the ZAPI documents that it fails with error code EOBJECTNOTFOUND. A ZAPI may return more specific error codes. In such cases, the ZAPI specification must document its behavior. If a ZAPI can accept a null value (e.g. reference to no object at all) for such an element, then the element is declared optional, and the absence of the input element represents a null value.

> [none]

Element definition: graph-line-info | [top]

> Describes the meta data of a line in a graph.

> Name | Range | Type | Description
> sample-format |  | string | The format in which the sample value is returned. Possible values: 'integer' 'float' Range of the sample value if integer: [0..(2^63) - 1] Range of the sample value if float: [0..(2^63) - 1]
> sample-name |  | string | Name of the sample. Maximum length: 64 characters.
> sample-pretty-name |  | string | The name of the sample which can be used for displaying. Maximum length: 64 characters.
> sample-suffix |  | string | The unit of the sample. If the unit is not known then 'none' is returned. Possible values: 'bytes' 'percentage' 'minutes' 'none'