API RU VDSNachfolgend finden Sie eine ältere Version der API, die keine neuen Updates und keinen Support mehr erhält. Dokumentation mit Beispielen für die aktuelle Version von API v2 finden Sie unter: https://ruvds.com/api-docs .
Unter Nutzung von RU VDS-API können Sie ein eigenes White-label-Geschäft aufbauen, wobei Sie die gesamte Liste von Funktionen bekommen, die in Ihrem Persönlichen Kabinett zugänglich sind.
Alle an API gerichteten Anfragen werden SSL-verschlüsselt sowie auf übliche und bequemste Weise verschickt: mit gewöhnlichem HTTP GET oder einer POST-Anfrage und einer Antwort im JSON-Format.
API-Funktionen
Standardmäßig stellt diese Funktion Informationen über alle Ihre Server zur Verfügung. Falls Sie nur Informationen über ganz bestimmte Server benötigen, können Sie zusätzlich deren IDs angeben (das wird strikt empfohlen).
Adresse: https://ruvds.com/api/servers/
Anfrageparameter:
sessionToken – Bei der Autorisierung erhaltenes Token
userId – Benutzer-ID, der die Server zuzuordnen sind (falls zugänglich)
fields – Eine Liste von Eigenschaftsnamen, die durch Kommas (,) oder Semikolons (;) getrennt sind, des Elementobjekts, dessen Wert abgerufen werden muss; Wenn der Parameter nicht angegeben ist oder die Liste leer ist, werden alle verfügbaren Dateien angezeigt
id – die IDs der benötigten Server, durch Kommas getrennt
Anfragebeispiel:
https://ruvds.com/api/servers/?sessionToken=YOURTOKEN&id=
Antwortbeispiel:
{
"rejectReason": 0,
"items":
[ {
"id": 38420,
"cpu": 2,
"ram": 2,
"vram": 64,
"drive": [ {"type":1,"capacity":60 } ],
"ip":
{
"count": 1,
"assigned": [ "192.168.111.222" ],
},
"premium": false,
"tariff":
{
"premium": false,
"id": 4,
"cpu": 60,
"ram": 140,
"vram": 1.953125,
"drive": {"hdd":5,"ssd":20 },
"ip": 100,
"active": true
},
"priceRub": 693,
"additionalServices":
[ {
"count": 1,
"name": "Schutz vor DDoS-Angriffen",
"price": 400,
"applyDiscount": true,
"monthIsMin": true
}
], "paymentPeriod": 3,
"discount":
{
"paymentPeriod": 0.05,
"promocode": 0.1
},
"state": 100,
"addDT": "07022016092512",
"createDT": "07022016092850",
"createProgress": 100,
"createState": 100,
"defaultAdminPassword": "eCvpQmXh",
"configurationUpdating": false,
"limitedTrafficMbps": null,
"running": true,
"paid": true,
"paidTill": "07042016092850",
"stat":
{
"traffic": {"value":21,"limit":153600,"state":1 },
"trafficOutbound": {"value":5,"limit":null,"state":1 },
"trafficInbound": {"value":16,"limit":null,"state":1 },
"driveRead": 938,
"driveWritten": 263,
"avgIOPS": 5,
"avgCPU": 0
},
"notifications":
[ {
"id": 3829,
"type": 3,
"blocked": true,
"message": "<div style="margin-bottom:6px;">Großer eingehender Trash-Traffic wurde entdeckt.: <b>83 GB</b></div><div style="margin-bottom:6px;">Das kann die Ursache sein für...",
"dt": "19022016175602"
}
], "configurationChangeable": true,
"canRecreate": true
}
]
}
Antwortbeispiel:
rejectReason – numerischer Wert (Fehler-Code)
errMessage – Textbeschreibung eines eventuellen Fehlers
items – Server-Array
id – Server-ID im System RuVDS (bestimmt den Servernamen RUXXXX)
cpu – Anzahl der CPU-Kerne
ram – Arbeitsspeicher-Volumen (RAM), GB
vram – Grafikspeicher-Volumen auf dem Server, MB
drive – Eingebaute Festplatten, deren Typ (1 - HDD, 3 - SSD) und Volumen, GB
ip – Information zu den IP-Adressen des Servers
count – angeforderte Adressenanzahl
assigned – Bereich der zugewiesenen IP-Adressen
premium – Ist es ein Server mit Premium-Standort?
tariff – Details zum Tarifplan
premium – Ist das ein „Premium“-Tarifplan?
id – Tarifplan-ID im RuVDS-System
cpu – Preis pro 1 CPU-Kern (RUB)
ram – Preis pro 1 GB Arbeitsspeicher (RAM) (RUB)
vram – Preis pro 1MB Video-RAM (RUB)
drive – Pries pro 1GB Speicherplatz (RUB) und zugängliche Optionen (HDD, SSD)
ip – Preis pro 1 zusätzliche IP-Adresse (RUB). 1 IP wird mit jedem Server gratis vergeben.
active – Ist der Tarif momentan aktiv?
priceRub – die vollen Kosten des Servers, einschließlich zusätzlicher Dienste, für den Zahlungszeitraum, einschließlich Gutscheincode und Rabatte für den Zahlungszeitraum
additionalServices – Zusätzliche Services, die für diesen Server aktiviert sind
count – Angeschlossene Anzahl.
name – Service-Name
price – Monatlicher Service-Preis ohne Rabatte
applyDiscount – Sind Rabatte für diesen Service erhältlich?
monthIsMin – Wenn TRUE, beträgt der Mindest-Abrechnungszeitraum 1 Monat, beim vorzeitigen Deaktivieren keine Rückerstattung.
paymentPeriod – 1 - Testzeitraum; 2 - 1 month; 3 - 3 months; 4 - 6 months; 5 - 1 year
discount – Auf den Server bezogene Rabatte, NULL falls keine
paymentPeriod – Rabatt für ausgewählten Bezahlungszeitraum, %
promocode – Promo-Code-Rabatt, %
state – 1 – neu; 2 -konfiguriert; 3 – Kontaktdaten nicht bestätigt; 4 – keine zugänglichen Ressourcen; 5 – nicht bezahlt; 6 – wegen Verstoß blockiert; 100 - betriebsbereit
addDT – Datum und Uhrzeit des Eintrags (UTC, im Format ddMMyyyyHHmmss)
createDT – Datum und Uhrzeit der abschließenden Einrichtung (UTC, im Format ddMMyyyyHHmmss), NULL falls nicht eingerichtet
createProgress – Zustand der Servereinrichtung (Wert von 0 bis 100)
createState – 1 - Standby; 2 - Beginn; 3 – Kopieren der Dateien; 4 – Hochfahren des Systems; 5 - Konfigurierung; 6 - Neustart; 100 – beendet
defaultAdminPassword – Default-Passwort für den User „Administrator“
configurationUpdating – Läuft die Konfigurationsänderung auf dem Server?
limitedTrafficMbps – Datenverkehrs-Einschränkung (Mbps)
running – Läuft der Server jetzt?
paid – Ist der Server bezahlt?
paidTill – Bis wann ist der Server bezahlt (UTC im Format ddMMyyyyHHmmss)
stat – Grundinfos über Ressourcennutzung; Stand: 1 – optimale Auslastung; 2 – nahe an der Limitgrenze; 3 – Limit überschritten
traffic – Summarischer Datenverkehr in den letzten 24 h, MB
trafficOutbound – Ausgehender Datenverkehr in den letzten 24 h, МB
trafficInbound – Eingehender Datenverkehr in den letzten 24 h, MB
driveRead – Von der Festplatte abgelesene Datenmenge in den letzten 24 h, MB
driveWritten – Auf die Festplatte gespeicherte Datenmenge in den letzten 24 h, MB
avgIOPS – Durchschnittliche Festplatten-Auslastung in den letzten 24 h, IOPS
avgCPU – Durchschnittliche CPU-Auslastung in den letzten 24 h (von 0 bis 100)
notifications – Server-Meldungen
id – System-ID-Meldungen
type – 1 - Information; 2 - Warnung; 3 – Verstoß
blocked – Hat die Meldung zum Blockieren geführt?
message – Text der Meldung im HTML-Format
dt – Datum und Uhrzeit der Meldung (UTC, im Format ddMMyyyyHHmmss)
configurationChangeable – Ist es möglich, die Konfiguration dieses Servers zu ändern?
canRecreate – Ist komplettes Neueinrichten des Servers möglich?
userComment – Benutzerkommentar
Fehlercodes:
0 – Anfrage erfolgreich ausgeführt
1 – Falsches Autorisierungstoken
2 – Kein Autorisierungs-Token angegeben
100 – Interner Systemfehler
Diese Funktion liefert Daten für die Erstellung von Auslastungskurven - ähnlich denen, die im persönlichen Kabinett abgebildet sind.
Die Anfrage ist jeweils nur für einen Server möglich.
Adresse: https://ruvds.com/api/server/stat/
Anfrageparameter:
sessionToken – Bei der Autorisierung erhaltenes Token
id – ID des Servers, über den Statistiken angefordert werden
Anfragebeispiel:
https://ruvds.com/api/server/stat/?sessionToken=YOURTOKEN&id=38420
Antwortbeispiel:
{
"rejectReason": 0,
"id": 38420,
"cpu":
[ {
"date": "19022016",
"avgLoad": 0
},
{
"date": "20022016",
"avgLoad": 1
}
],
"drive":
[ {
"date": "19022016",
"read": 52,
"write": 5,
"avgIOPS": 1
},
{
"date": "20022016",
"read": 52,
"write": 6,
"avgIOPS": 1
}
],
"traffic":
[ {
"date": "19022016",
"inbound": 0,
"outbound": 0
},
{
"date": "20022016",
"inbound": 8,
"outbound": 1
}
]
}
Antwortfelder:
rejectReason – numerischer Wert (Fehler-Code)
errMessage – Textbeschreibung eines eventuellen Fehlers
id – ID des Servers, über den Sie Statistiken abgerufen haben
cpu – Details zur CPU-Auslastung an einzelnen Tagen
date – Tag (UTC, im Format ddMMyyyy)
avgLoad – durchschnittliche CPU-Auslastung (von 0 bis 100)
drive – Details der SSD/HDD-Auslastung an einzelnen Tagen
date – Tag (UTC, im Format ddMMyyyy)
read – gelesene Datenmenge, MB
write – geschriebene Datenmenge, MB
avgIOPS – Durchschnittliche SSD/HDD-Auslastung, IOPS
traffic – Details zum Datenverkehr an einzelnen Tagen
date – Tag (UTC, im Format ddMMyyyy)
inbound – eingehender Datenverkehr, MB
outbound – ausgehende Datenverkehr, MB
Fehlercodes:
0 – Anfrage erfolgreich ausgeführt
1 – Falsches Autorisierungstoken
2 – Kein Autorisierungs-Token angegeben
4 – Virtueller Server unter angegebenem ID nicht gefunden
100 – Interner Systemfehler
Mit dieser Funktion bekommen Sie das aktuelle Bild auf dem Server-Bildschirm. Zugängliche Abmessungen: Breite von 64 bis 640, Höhe von 48 bis 480.
Wegen Caching der Ergebnisse macht es keinen Sinn, das Bild öfter als alle 10 Sekunden abzufragen.
Adresse: https://ruvds.com/api/server/image/
Anfrageparameter:
sessionToken – Bei der Autorisierung erhaltenes Token
id – ID des Servers, für dessen Bildschirm Sie einen Screenshot bekommen möchten
width – Bildbreite
height – Bildhöhe
Anfragebeispiel:
https://ruvds.com/api/server/image/?sessionToken=YOURTOKEN&id=38420
&width=340&height=240 Antwortbeispiel:
{
"rejectReason": 0,
"id": 38420,
"state": 100,
"running": true,
"imageBase64": "/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAMCAg..."
}
Antwortfelder:
rejectReason – numerischer Wert (Fehler-Code)
errMessage – Textbeschreibung eines eventuellen Fehlers
id – ID des Servers, für den ein Screenshot abgerufen wurde
state – 1 – neu; 2 -konfiguriert; 3 – Kontaktdaten nicht bestätigt; 4 – keine zugänglichen Ressourcen; 5 – nicht bezahlt; 6 – wegen Verstoß blockiert; 100 - betriebsbereit
running – Läuft der Server jetzt?
imageBase64 – Byte-Array für das Bild im Base64-Format
Falls der Wert des Feldes state nicht gleich 100 oder running nicht gleich true, dann wird ins Feld imageBase64 der Wert NULL zurückgegeben.
Fehlercodes:
0 – Anfrage erfolgreich ausgeführt
1 – Falsches Autorisierungstoken
2 – Kein Autorisierungs-Token angegeben
4 – Virtueller Server unter angegebenem ID nicht gefunden
100 – Interner Systemfehler
Da während des Kopierens und Konfigurierens des Systems die Platten ziemlich stark ausgelastet werden, bitte beim Austesten der Funktion Server auf SSD-Platten einrichten. Aber sogar auf SSD sollte man sich auf eine Mindestanzahl von Anfragen beschränken.
Beim Einrichten und späteren Löschen von mehr als 10 Servern pro Tag kann Ihr Account mit einem zeitweiligen Verbot der Einrichtung neuer Server belegt werden.
Adresse: https://ruvds.com/api/server/create/
Anfrageparameter:
sessionToken – Bei der Autorisierung erhaltenes Token
userId – Benutzer-ID, für die der Server einzurichten ist (falls zugänglich)
datacenter – Datencenter-ID (siehe Erste Schritte > Daten-Center)
tariff – Tarifplankennung (siehe Erste Schritte> Tarifpläne)
os – Betriebssystemkennung (siehe Erste Schritte > Betriebssysteme) [optionales Feld]
cpu – Anzahl der CPU-Kerne
ram – Arbeitsspeicher-Volumen (RAM), GB
vram – Grafikspeicher-Volumen auf dem Server, MB (Mögliche Werte: 0, 64, 128, 256, 512, 1024)
drivesCount – Anzahl der virtuellen Serverfestplatten
driveXTariff – Tarifplankennung (siehe Erste Schritte> Tarifpläne), wobei X - [0..drivesCount-1]
driveXСapacity – Festplattenkapazität in GB, wobei X - [0..drivesCount-1]
driveXSystem – ein Flag, das angibt, dass auf dieser Festplatte ein Betriebssystem installiert wird (wenn mehrere angegeben sind, wird letzteres als das System ausgewählt), wobei X - [0..drivesCount-1]
ip – benötigte Anzahl der IP-Adressen
ddosProtection – Falls für den Server Schutz gegen DDoS-Angriffe benötigt wird, ist die Bandbreite für den eingehenden legitimen Datenverkehr anzugeben (teilbar durch 0.5 Mbps)
template – Vorlagen-ID (Template-ID) des zu installierenden Betriebssystems (falls vorhanden)
paymentPeriod – 2 - 1 month; 3 - 3 months; 4 - 6 months; 5 - 1 year
promocode – Promo-Code, um einen ständigen Rabatt zu erhalten
promo – Promo-Konfigurations-ID; nicht empfohlen zu verwenden, kann ohne Vorankündigung geändert werden; Senden Sie eine Anfrage an den technischen Support, um die aktuelle Promoliste zu klären. Die Werbekonfiguration kann die Verwendung von Werbecodes, einschließlich der PROMO-API, unterbinden
computerName – Computer-Name des einzurichtenden virtuellen Servers. Falls nicht angegeben, defaultmäßig WIN-XXXXXXX
userComment – Benutzerkommentar
Anfragebeispiel:
https://ruvds.com/api/server/create/?sessionToken=YOURTOKEN&datacenter=1&tariff=14&os=15&cpu=2
&ram=4&vram=0&drivesCount=1&drive0Tariff=1&drive0Capacity=40&drive0System=true&ip=1 &ddosProtection=0&paymentPeriod=2&promocode=PROMO-API&computerName=CustomVDS Antwortbeispiel:
{
"rejectReason": 0,
"id": 38420,
"cost": 279
}
Antwortfelder:
rejectReason – numerischer Wert (Fehler-Code)
errMessage – Textbeschreibung eines eventuellen Fehlers
id – ID des neuen Servers
cost – Serverpreis für ausgewählten Zeitraum alle Rabatte eingerechnet (RUB)
Nach Erhalt einer erfolgreichen Antwort vom System beginnt der Prozess der Einrichtung eines virtuellen Servers, den Sie mitverfolgen können, indem Sie die Server-Info abrufen wie dies oben im Abschnitt "Meine Server" beschrieben ist.
Fehlercodes:
0 – Anfrage erfolgreich ausgeführt
1 – Falsches Autorisierungstoken
2 – Anzahl der CPU-Kerne falsch angegeben
3 – Falsch angegebenes Arbeitsspeicher-Volumen (RAM)
4 – Festplatte-Größe falsch angegeben
5 – Falsch angegebene Anzahl von IP-Adressen
6 – User oder Promo-Code nicht gefunden
7 – Der aktuelle Tarifplan konnte nicht identifiziert werden. (Interner Systemfehler)
8 – Fehler bei Datenspeicherung (Interner Systemfehler)
10 – Einrichtung neuer Server ist für Ihren Account untersagt
13 – Einrichten eines neuen Servers unmöglich
17 – Keine zugänglichen Ressourcen für die gewünschte Konfiguration
19 – Nicht genügend Geldmittel auf Ihrem Guthaben
31 – Kein Autorisierungs-Token angegeben
33 – Unzulässige Zeichen im Namen Ihres Computers
39 – Grafikspeicher-Volumen falsch angegeben
100 – Interner Systemfehler
Der Prozess von Konfigurationsänderung läuft asynchron ab, d.h. nach Erhalt einer erfolgreichen Rückmeldung vom System ist die Konfiguration noch nicht geändert. Es kann passieren, dass sie sich gar nicht ändert, falls dabei irgendwelche Fehler auftreten.
Nach Erhalt einer erfolgreichen Rückmeldung überwachen Sie bitte den Serverzustand anhand des Feldes configurationUpdating sowie dessen Konfiguration, wie oben im Abschnitt „Meine Server“ beschrieben ist. Falls nachdem das Feld configurationUpdating den Wert false angenommen, die Konfiguration unverändert geblieben, sind im Zuge der Konfigurationsänderung ein Fehler aufgetreten.
Adresse: https://ruvds.com/api/server/update/configuration/
Anfrageparameter:
sessionToken – Bei der Autorisierung erhaltenes Token
id – ID des zu ändernden virtuellen Servers
cpu – Anzahl der CPU-Kerne
ram – Arbeitsspeicher-Volumen (RAM), GB
vram – Grafikspeicher-Volumen auf dem Server, MB (Mögliche Werte: 0, 64, 128, 256, 512, 1024)
drive – Festplattenvolumen, GB
ip – benötigte Anzahl der IP-Adressen
ddosProtection – Falls für den Server Schutz gegen DDoS-Angriffe benötigt wird, ist die Bandbreite für den eingehenden legitimen Datenverkehr anzugeben (teilbar durch 0.5 Mbps)
Anfragebeispiel:
https://ruvds.com/api/server/update/configuration/?sessionToken=YOURTOKEN&id=38420
&cpu=2&ram=2&vram=128&drive=40&ip=2&ddosProtection=0.5 Antwortbeispiel:
{
"rejectReason": 0
}
Antwortfelder:
rejectReason – numerischer Wert (Fehler-Code)
errMessage – Textbeschreibung eines eventuellen Fehlers
Fehlercodes:
0 – Anfrage erfolgreich ausgeführt
1 – Falsches Autorisierungstoken
2 – Anzahl der CPU-Kerne falsch angegeben
3 – Falsch angegebenes Arbeitsspeicher-Volumen (RAM)
4 – Festplatte-Größe falsch angegeben
5 – Falsch angegebene Anzahl von IP-Adressen
6 – Virtueller Server unter angegebenem ID nicht gefunden
10 – Umkonfigurierung der Server ist für Ihren Account untersagt
13 – Server ist inaktiv
14 – Konfigurationsänderung bereits gestartet
15 – Aktuelle Abrechnungsperiode läuft in weniger als 30 Minuten aus, somit eine Konfigurationsänderung unmöglich
16 – Aktuelle Abrechnungsperiode ist abgelaufen
17 – Keine zugänglichen Ressourcen für die gewünschte Konfiguration
19 – Nicht genügend Geldmittel auf Ihrem Guthaben
20 – Tageslimit der Umkonfigurierungen für diesen Server erreicht
21 – Monatslimit der Umkonfigurierungen für diesen Server erreicht
26 – Konfigurationsänderung ist für diesen Server unzugänglich
31 – Kein Autorisierungs-Token angegeben
39 – Grafikspeicher-Volumen falsch angegeben
100 – Interner Systemfehler
Ähnlich wie bei der Änderung des Abrechnungszeitraums über das persönliche Kabinett ist die Ausführung dieser Funktion nicht mit Geldabbuchung vom Kontoguthaben verbunden. Die Verlängerung des Servers gemäß dem neu angegebenen Zeitraum erfolgt erst kurz vor dem Auslaufen des bisherigen Abrechnungszeitraums.
Adresse: https://ruvds.com/api/server/update/payment_period/
Anfrageparameter:
sessionToken – Bei der Autorisierung erhaltenes Token
id – ID des zu ändernden virtuellen Servers
paymentPeriod – 2 - 1 month; 3 - 3 months; 4 - 6 months; 5 - 1 year
Anfragebeispiel:
https://ruvds.com/api/server/update/payment_period/?sessionToken=YOURTOKEN&id=38420
&paymentPeriod=2 Antwortbeispiel:
{
"rejectReason": 0
}
Antwortfelder:
rejectReason – numerischer Wert (Fehler-Code)
errMessage – Textbeschreibung eines eventuellen Fehlers
Fehlercodes:
0 – Anfrage erfolgreich ausgeführt
1 – Falsches Autorisierungstoken
2 – Kein Autorisierungs-Token angegeben
4 – Virtueller Server unter angegebenem ID nicht gefunden
8 – Konfigurationsänderung bereits gestartet
100 – Interner Systemfehler
Diese Funktion umfasst eine Vielzahl von einfachen Aufgaben wie: Ein- und Ausschalten, Neustart, Herunterfahren, Generierung eines neuen Admin-Passwortes, Neueinrichtung des Servers (Systemrücksetzung), Löschen.
Alle Funktionen mit Ausnahme der Neuerstellung des virtuellen Servers werden in Echtzeit ausgeführt und werden mit Garantie erfolgreich abgeschlossen, soweit Sie eine fehlerfreie Meldung bekommen.
Adresse: https://ruvds.com/api/server/command/
Anfrageparameter:
sessionToken – Bei der Autorisierung erhaltenes Token
id – ID des zu ändernden virtuellen Servers
type – Befehlstyp:
start – den Server hochfahren
stop – den Server runterfahren (im Notfall)
shutdown – Herunterfahren
reset – Neustart (im Notfall)
new_password – Ein neues Passwort für den User Administrator angeben
recreate – den virtuellen Server neu einrichten
remove – den virtuellen Server löschen
Anfragebeispiel:
https://ruvds.com/api/server/command/?sessionToken=YOURTOKEN&id=38420&&type=start
Antwortbeispiel:
{
"rejectReason": 0
}
Antwortfelder:
rejectReason – numerischer Wert (Fehler-Code)
errMessage – Textbeschreibung eines eventuellen Fehlers
Fehlercodes:
0 – Anfrage erfolgreich ausgeführt
1 – Falsches Autorisierungstoken
2 – Kein Autorisierungs-Token angegeben
4 – Virtueller Server unter angegebenem ID nicht gefunden oder falscher Befehl
6 – Der Server ist noch nicht eingerichtet oder gesperrt.
7 – Zum Absetzen dieses Befehls muss man den Server hochfahren.
8 – Konfigurationsänderung bereits gestartet
10 – Aktuelle Abrechnungsperiode läuft in weniger als 30 Minuten aus, somit eine Konfigurationsänderung unmöglich
11 – Aktuelle Abrechnungsperiode ist abgelaufen
12 – Umkonfigurierung ist für diesen Server unzugänglich
13 – Tageslimit der Umkonfigurierungen für diesen Server erreicht
14 – Monatslimit der Umkonfigurierungen für diesen Server erreicht
100 – Interner Systemfehler
|
