Auswertung für ein bestimmtes Diagramm einer Domain oder Subdomain abrufen¶
Note
Sie müssen im ausgewählten Zeitraum mindestens READ-Berechtigungen besitzen.
Note
Domains und Subdomains, für die keine Berechtigungen bestehen, werden übersprungen.
Note
Im Body muss mindestens eines der Attribute domains oder subDomains definiert sein.
Senden einer POST-Anfrage an den Endpunkt /statistics/histogram/{startTime}/{finishTime}/{chartName}/{interval}/{compressed}/{sum}.
Beschreibung¶
Mit der Get-Histogram-Anfrage rufen Sie Daten für ein bestimmtes Diagramm für eine oder mehrere Domains oder Subdomains für den ausgewählten Zeitraum ab.
Voraussetzungen¶
Werte der Anfrage: Startdate {startTime}; Enddate {finishTime}; Chart {chartName}; Interval {interval}; Compressed {compressed}; Sum {sum}
Objekte: StatisticsVO
Anfrage¶
Um Daten für ein bestimmtes Diagramm für eine oder mehrere Domains oder Subdomains abzurufen, fügen Sie Startdate {startTime} und Enddate {finishTime} als Unix-Zeitstempel sowie die Attribute Chart {chartName}, Interval {interval}, Compressed {compressed} und Sum {sum} dem Pfad der Anfrage hinzu.
Chart {chartName} legt den Diagrammtyp fest, für den Informationen angefragt werden.
Die folgenden Werte sind verfügbar:
| Wert | Beschreibung |
|---|---|
total-requests |
Die Gesamtzahl der Anfragen. |
total-requests-without-blocked-requests |
Die Gesamtzahl der Anfragen ohne blockierte Anfragen. |
total-cached-requests |
Die Gesamtzahl der zwischengespeicherten Anfragen. |
total-uncached-requests |
Die Gesamtzahl der nicht zwischengespeicherten Anfragen. |
total-traffic |
Die Gesamtmenge des Traffics. |
total-cached-traffic |
Die Gesamtmenge des zwischengespeicherten Traffics. |
total-uncached-traffic |
Die Gesamtmenge des nicht zwischengespeicherten Traffics. |
total-ingress-traffic |
Die Gesamtmenge des eingehenden Traffics. |
total-egress-traffic |
Die Gesamtmenge des ausgehenden Traffics. |
upstream-time-avg |
Die durchschnittliche Upstream-Zeit. |
cached-uncached-requests-ratio |
Das Verhältnis von zwischengespeicherten zu nicht zwischengespeicherten Anfragen. |
cached-uncached-traffic-ratio |
Das Verhältnis von zwischengespeichertem zu nicht zwischengespeichertem Traffic. |
blocked-requests-by-treatment-type |
Die Gesamtzahl der Anfragen nach Behandlungstyp. |
requests-by-as-type |
Eine Liste der ASN-Namen, von denen die Anfragen stammen. |
requests-by-status-code |
Die Gesamtzahl der Anfragen nach Statuscode. |
Interval {interval} legt die Datenpunkte fest, anhand derer die Daten berechnet werden.
Die folgenden Werte sind verfügbar:
| Wert | Beschreibung |
|---|---|
2m |
Die Datenpunkte werden innerhalb des angegebenen Zeitraums alle zwei Minuten dargestellt. |
hourly |
Die Datenpunkte werden innerhalb des angegebenen Zeitraums alle 60 Minuten dargestellt. |
daily |
Die Datenpunkte werden innerhalb des angegebenen Zeitraums alle 24 Stunden dargestellt. |
weekly |
Die Datenpunkte werden innerhalb des angegebenen Zeitraums alle 7 Tage dargestellt. |
Sum {sum} legt fest, ob die Daten aller Domains und Subdomains in einem Diagramm zusammengefasst werden.
Die folgenden Werte sind verfügbar:
| Wert | Beschreibung |
|---|---|
0 |
Die Daten für jede Domain und Subdomain werden separat dargestellt. |
1 |
Die Daten für jede Domain und Subdomain werden als aufsummierte Gesamtsumme dargestellt. |
Compressed {compressed} legt fest, ob Datenpunkte ohne Daten aus dem Diagramm entfernt werden.
Die folgenden Werte sind verfügbar:
| Wert | Beschreibung |
|---|---|
0 |
Leere Datenpunkte bleiben im Diagramm erhalten. |
1 |
Leere Datenpunkte werden aus dem Diagramm entfernt. |
Für eine detaillierte Spezifikation, welche Informationen zum Abrufen einer Statistik erforderlich sind, müssen im Body die folgenden Attribute definiert werden:
| Attribut | Beschreibung | Werte |
|---|---|---|
domains |
Ein Array mit den Namen der Domains.HinweisUm eine Domain mit allen ihren Subdomains aufzunehmen, muss das Attribut subDomains leer sein. |
string |
subDomains |
Ein Array mit den Namen der Subdomains.HinweisUm nur bestimmte Subdomains aufzunehmen, kann das Attribut Domains leer sein. |
string |
Als Ergebnis erhalten Sie für jede Analysekategorie ein Statistikobjekt für die ausgewählten Domains oder Subdomains.
Das Objekt liefert die folgenden Informationen:
| Attribut | Beschreibung | Werte |
|---|---|---|
x |
Datum und Uhrzeit des Datenpunkts. | integer als Unix-Zeitstempel |
y |
Der Wert für den zugehörigen Datenpunkt. | integer |
max |
Der Maximalwert des Datenpunkts. | integer |
name |
Der Name des Diagramms, wie durch den Parameter Chart {chartName} festgelegt. |
integer |
sum |
Zeigt an, ob die Daten aufsummiert sind oder nicht. | integer |
time |
Zeigt den Unix-Zeitstempel des Maximalwerts an. | date |
Beispiel¶
Beispiel-Request-Body:
{
"domains": "string",
"subDomains": "string",
"x": 0,
"y": 0,
"max": 0,
"name": 0,
"sum": 0,
"time": "string"
}
Antworten¶
Die folgenden Antworten sind möglich:
| STATUSCODE | BESCHREIBUNG |
|---|---|
| 201 | Die Anfrage war erfolgreich und ein neues Objekt wurde erstellt. |
| 400 | Die Anfrage war nicht erfolgreich. Die Anfrage war fehlerhaft oder es fehlen Informationen. |
| 401 | Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war. |
| 403 | Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen. |