...
Required Parameters
| Parameters | |||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| { | |||||||||||||||||||||||||||||||||||||||||
requestData (struct)
|
| ||||||||||||||||||||||||||||||||||||||||
| } | |||||||||||||||||||||||||||||||||||||||||
| requestData | { | ||||||||||||||||||||||||||||||||||||||||
| model_view | "graph", no other options supported at this time | ||||||||||||||||||||||||||||||||||||||||
| parameters | { | #holds general parameters that might be used to gather several datasets for the same graph | |||||||||||||||||||||||||||||||||||||||
| time_period | "specific_time" or "time_difference. When specific_time is specified the times are used as-is. When time_difference is specified, the times given are subtracted, that period is then applied to the current time being the stop_date and start_date = current_time - period | ||||||||||||||||||||||||||||||||||||||||
| start_date | Any parse-able date, eg "16-May-2014 09:24:56", usage specified by time_period | ||||||||||||||||||||||||||||||||||||||||
| end_date | Any parse-able date, eg "23-May-2014 09:24:56", usage specified by time_period | ||||||||||||||||||||||||||||||||||||||||
| } | |||||||||||||||||||||||||||||||||||||||||
| options | {} | ||||||||||||||||||||||||||||||||||||||||
| dataset | { | ||||||||||||||||||||||||||||||||||||||||
| name | can be anything, unused but will be returned back in the response | ||||||||||||||||||||||||||||||||||||||||
| type | "nmis_rrd" or "nmis_graph". nmis_rrd will provide data directly as it is in the RRD files. nmis_graph will provide data after running it through the manipulations done by the NMIS graph | ||||||||||||||||||||||||||||||||||||||||
| data_source | Normally "local_nmis". Can also be other MySQL datasource if configured, then the name property of the data_source that is required. | ||||||||||||||||||||||||||||||||||||||||
| parameters | { | ||||||||||||||||||||||||||||||||||||||||
| node | maps to a node found using GET node | ||||||||||||||||||||||||||||||||||||||||
| graph_type | nmis_rrd: maps to a resource found using Get Node Resources (value attribute, which is the ID) nmis_graph: maps to the name of the graph if not indexed, maps to the same as nmis_rrd if indexed | ||||||||||||||||||||||||||||||||||||||||
| resource_index | If the resource is indexed, the index of the resource required | ||||||||||||||||||||||||||||||||||||||||
| index_graph_type | Only used if the resource is indexed: nmis_rrd: nmis_graph: the name of the graph | ||||||||||||||||||||||||||||||||||||||||
| field | Only used for nmis_rrd: maps to the dataset required found using GET node resource datasets (value attribute of desired dataset) | ||||||||||||||||||||||||||||||||||||||||
| axis | 0 or 1, the axis the dataset will group itself into, usually 0 | ||||||||||||||||||||||||||||||||||||||||
| } | |||||||||||||||||||||||||||||||||||||||||
| options | { | ||||||||||||||||||||||||||||||||||||||||
| datasetTitle | The title the dataset will return with itself | ||||||||||||||||||||||||||||||||||||||||
| } | |||||||||||||||||||||||||||||||||||||||||
| } | |||||||||||||||||||||||||||||||||||||||||
| | |||||||||||||||||||||||||||||||||||||||||
| } |
Request Example
| Code Block |
|---|
{
"requestData": {
"model": "nmis_rrd",
"model_view": "graph",
"data_source": "local_nmis",
"parameters": {
"start_date_raw": 1401346748,
"end_date_raw": 1401951548,
"node": "asgard",
"graph_type": "nodehealth",
"field": "avgBusy5",
"resource_index": "",
"index_graph_type": "",
"axis": "0"
},
"options": {
}
}
} |
...