APIs in Category: Graph | API version 5.0

GraphDataListInfo GraphListInfoIterEnd GraphListInfoIterNext GraphListInfoIterStart | These APIs allow the user To get information and data of all the Graphs present in DFM. The GraphListInfoIter* API can be used presentation and GraphDataListInfo 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 API version 5.0

GraphDataListInfo (supported) | [top]

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

> Input Name | Type
> GraphDataListInfo | GraphDataListInfo
> Output Name | Type
> GraphDataListInfoResult | GraphDataListInfoResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |

GraphListInfoIterEnd (supported) | [top]

> Terminate a graph list iteration and clean up any saved info.

> Input Name | Type
> GraphListInfoIterEnd | GraphListInfoIterEnd
> Output Name | Type
> GraphListInfoIterEndResult | GraphListInfoIterEndResult

> Error Name | Description
> EINVALIDTAG |  |

GraphListInfoIterNext (supported) | [top]

> Returns items From a previous call To GraphListInfoIterStart

> Input Name | Type
> GraphListInfoIterNext | GraphListInfoIterNext
> Output Name | Type
> GraphListInfoIterNextResult | GraphListInfoIterNextResult

> Error Name | Description
> EINVALIDTAG |  |

GraphListInfoIterStart (supported) | [top]

> Initiates a Query for a list of Graphs and its metadata like graph Lines and sample information.

> Input Name | Type
> GraphListInfoIterStart | GraphListInfoIterStart
> Output Name | Type
> GraphListInfoIterStartResult | GraphListInfoIterStartResult

> Error Name | Description
> EAPIERROR |  |
> EGRAPHNOTFOUND |  |

Element definition: GraphDataListInfo | [top]

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

> Name | Type | Description
> EndDate | xsd:integer optional | The number of seconds in the future that the graph should end. The graph Values From the current time till the EndDate will be extrapolated and used for trending. Use a negative Value if the graph should stop in the past.
> GraphName | xsd:string | Name of the graph. Maximum Length: 64 characters.
> GraphPeriod | xsd: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 StartDate will be the same as the graph Period specified. The default Values of EndDate 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'.
> PrimaryObject | ObjNameOrId optional | The primary object for which the graph data is returned. If not specified then global Group is considered.
> SecondaryObject | ObjNameOrId 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.
> StartDate | xsd:integer optional | The number of seconds in the past that the graph should start.

Element definition: GraphDataListInfoResult | [top]

> Name | Type | Description
> GraphLineValues | ArrayOfGraphLineValueInfo | Data for various Lines in a graph.

Element definition: GraphListInfoIterEnd | [top]

> Terminate a graph list iteration and clean up any saved info.

> Name | Type | Description
> Tag | xsd:string | An opaque handle used by the DFM station To identify a temporary store.

Element definition: GraphListInfoIterEndResult | [top]

> [none]

Element definition: GraphListInfoIterNext | [top]

> Returns items From a previous call To GraphListInfoIterStart

> Name | Type | Description
> Maximum | xsd:integer | The Maximum number of entries To retrieve. Range: [1..(2^31)-1]
> Tag | xsd:string | An opaque handle used by the DFM station To identify a temporary store.

Element definition: GraphListInfoIterNextResult | [top]

> Name | Type | Description
> Graphs | ArrayOfGraphInfo | A list of Graphs.
> Records | xsd:integer | The number of Records actually returned.

Element definition: GraphListInfoIterStart | [top]

> Initiates a Query for a list of Graphs and its metadata like graph Lines and sample information.

> Name | Type | Description
> GraphName | xsd:string optional | Name of the graph. If not specified then all the Graphs are returned. Maximum Length: 64 characters.

Element definition: GraphListInfoIterStartResult | [top]

> Name | Type | Description
> Records | xsd:integer | Number indicating how many items are available for future retrieval with GraphListInfoIterNext. Range: [1..(2^31)-1]
> Tag | xsd:string | An opaque handle used by the DFM station To identify a temporary store. Used in subsequent calls To GraphListInfoIterNext or GraphListInfoIterEnd.

Element definition: ArrayOfGraphInfo | [top]

> Name | Type | Description
> GraphInfo | GraphInfo[] |

Element definition: ArrayOfGraphLineValueInfo | [top]

> Name | Type | Description
> GraphLineValueInfo | GraphLineValueInfo[] |

Element definition: ObjNameOrId | [top]

> Name or internal ID of a DFM object. This typedef is an alias for the builtin ZAPI Type string. An ObjNameOrId must contain between 1 and 64 characters, and must conform To one of the following formats: It must have the format of an ObjName, or It must be the decimal numeric string form of a positive integer whose Value is in the range [1..2^31 - 1]. In case of application resources From the Host Service, this field can contain unique identifier assigned To the object by the Host Service e.g. for a Virtual Machine, it can be a GUID of the VM. One exception is when such unique identifier is a decimal numeric string containing only digits From 0 through 9. In that case, you cannot use such identifier as ObjNameOrId input. Elements of Type ObjNameOrId 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. Dataset, Host, DP Policy, etc.). Some ZAPIs allow the object To be one of several different types. If the format of an ObjNameOrId 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: GraphInfo | [top]

> Describes the meta data of a graph

> Name | Type | Description
> DeprecatedBy | xsd:string optional | Name of the graph that replaces this graph. Will be absent for non-deprecated Graphs. Only returned via the GraphListInfoIterNext api.
> Description | xsd:string optional | Description of the graph. Maximum Length of 1024 characters. Only returned via the ReportGraphListInfoIterNext api.
> GraphLines | ArrayOfGraphLineInfo optional | Specifies the list of Lines in the graph. Only returned via the GraphListInfoIterNext api.
> GraphName | xsd:string | Unique Name of the graph. Maximum Length of 64 characters.
> GraphPrettyName | xsd:string | Long Name of the graph. Maximum Length of 64 characters.
> IsDefault | xsd:boolean optional | Specifies whether the graph is the default graph for the report. Only returned via the ReportGraphListInfoIterNext api.
> IsDeprecated | xsd:boolean optional | true if the graph is deprecated. Only returned via the GraphListInfoIterNext api.

Element definition: GraphLineValueInfo | [top]

> The sample Values of a line in a graph.

> Name | Type | Description
> SampleName | xsd:string | Name of the sample. Maximum Length: 64 characters.
> SampleValues | xsd: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: ArrayOfGraphLineInfo | [top]

> Name | Type | Description
> GraphLineInfo | GraphLineInfo[] |

Element definition: GraphLineInfo | [top]

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

> Name | Type | Description
> SampleFormat | xsd: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]
> SampleName | xsd:string | Name of the sample. Maximum Length: 64 characters.
> SamplePrettyName | xsd:string | The Name of the sample which can be used for displaying. Maximum Length: 64 characters.
> SampleSuffix | xsd:string | The Unit of the sample. If the Unit is not known then 'none' is returned. Possible Values: 'bytes' 'percentage' 'minutes' 'none'