Traffic Log Chart

POST /vm/:vmid/traffic/chart
Ermöglicht die einfache Darstellung des Traffic-Verbrauchs in einem Diagramm. Es kann die Config für ChartJS und ApexCharts generiert werden, oder ein gerendertes Bild im Base64 Format ausgegeben werden

URL Variablen

Name Beschreibung
vmid Identifier der VM (fünfstellige Zahl)

Body Parameter (application/x-www-form-urlencoded)

Name Format Beschreibung Optional
type Enum (traffic.type) Traffic Typ welcher ausgegeben werden soll (Eingehend, Ausgehend, Ein- und Ausgehend)
summary Enum (traffic.summary) Summierung der Daten im Diagramm
output Enum (traffic.output) Art der Ausgabe (Config für ChartJS; ApexCharts; oder als Base64 Image)
dataset_in_label String Datensatz Bezeichnung für eingehenden Traffic (Standard: Eingehender Traffic)
dataset_out_label String Datensatz Bezeichnung für ausgehenden Traffic (Standard: Ausgehender Traffic)
dataset_in_color String Farbe des eingehenden Traffics, 6-stelliger Hexcode mit # startend. (Standard: #0077FF)
dataset_out_color String Farbe des ausgehenden Traffics, 6-stelliger Hexcode mit # startend. (Standard: #FF6347)
axes_y_label String Bezeichnung der Y-Achse, verwende {unit} als Platzhalter für die Einheit (Standard: Traffic in {unit})
datapoints Integer (2 - n) Anzahl der Datenpunkte im Diagramm
Wenn summary = DAILY: max. 90
Wenn summary = HOURLY: max. 48
Wenn summary = NONE: max. 72
size String Größe des Diagrams, {breite}x{höhe} (Standard: 900x300)
Breite: min. 200, max. 3000
Höhe: min. 200, max. 3000

Response (application/json) 

{
    "status": "success",
    "requestID": "0cf16b76-c2f4-4b3a-af6b-8a1881b3557b",
    "message": "traffic data are listed below",
    "data": {
        "config": {
            "type": "line",
            "data": {
                "labels": [
                    "25.05.",
                    "26.05.",
                    "27.05.",
                    "28.05.",
                    "29.05.",
                    "30.05.",
                    "31.05.",
                    "1.06.",
                    "2.06.",
                    "3.06.",
                    "4.06.",
                    "5.06.",
                    "6.06.",
                    "7.06.",
                    "8.06.",
                    "9.06.",
                    "10.06.",
                    "11.06.",
                    "12.06.",
                    "13.06.",
                    "14.06.",
                    "15.06.",
                    "16.06.",
                    "17.06.",
                    "18.06.",
                    "19.06.",
                    "20.06.",
                    "21.06.",
                    "22.06.",
                    "23.06."
                ],
                "datasets": [
                    {
                        "label": "Eingehender Traffic",
                        "data": [
                            0.26,
                            0.26,
                            0.24,
                            0.25,
                            0.25,
                            0.28,
                            0.28,
                            0.25,
                            0.25,
                            0.31,
                            0.25,
                            0.26,
                            0.25,
                            0.34,
                            0.26,
                            0.26,
                            0.26,
                            0.26,
                            0.33,
                            0.51,
                            0.28,
                            0.28,
                            0.25,
                            0.5,
                            0.26,
                            0.24,
                            0.25,
                            0.24,
                            0.25,
                            0.2
                        ],
                        "borderColor": "rgba(0,119,255, 1)",
                        "backgroundColor": "rgba(0,119,255, 0.25)"
                    },
                    {
                        "label": "Ausgehender Traffic",
                        "data": [
                            0.02,
                            0.01,
                            0.01,
                            0.01,
                            0.02,
                            0.05,
                            0.03,
                            0.01,
                            0.01,
                            0.01,
                            0.02,
                            0.02,
                            0.03,
                            0.02,
                            0.03,
                            0.04,
                            0.03,
                            0.02,
                            0.02,
                            0.03,
                            0.05,
                            0.05,
                            0.02,
                            0.03,
                            0.03,
                            0.02,
                            0.02,
                            0.02,
                            0.05,
                            0.02
                        ],
                        "borderColor": "rgba(255,99,71, 1)",
                        "backgroundColor": "rgba(255,99,71, 0.25)"
                    }
                ]
            },
            "options": {
                "title": {
                    "text": "Liniendiagramm mit 2 Datasets"
                },
                "scales": {
                    "yAxes": [
                        {
                            "ticks": {
                                "beginAtZero": true,
                                "unit": "MB"
                            },
                            "scaleLabel": {
                                "display": true,
                                "labelString": "Traffic in GB",
                                "padding": {
                                    "top": 10,
                                    "bottom": 10
                                }
                            }
                        }
                    ]
                }
            }
        }
    }
}

cURL

curl "https://live.fireapi.de/vm/:vmid/traffic/chart" -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "X-FIRE-APIKEY: REPLACE_API-KEY" -d "type=REPLACE_VALUE&summary=REPLACE_VALUE&output=REPLACE_VALUE&dataset_in_label=REPLACE_VALUE&dataset_out_label=REPLACE_VALUE&dataset_in_color=REPLACE_VALUE&dataset_out_color=REPLACE_VALUE&axes_y_label=REPLACE_VALUE&datapoints=REPLACE_VALUE&size=REPLACE_VALUE"

Anfrage testen