Zde můžete vidět rozdíly mezi vybranou verzí a aktuální verzí dané stránky.
Obě strany předchozí revizePředchozí verzeNásledující verze | Předchozí verzeNásledující verzeObě strany příští revize | ||
navody:vps:api [2018/11/28 19:48] – [Práce s API] fix haveapi js lib url uxes | navody:vps:api [2020/05/12 18:53] – [Dokumentace API] 1john2 | ||
---|---|---|---|
Řádek 2: | Řádek 2: | ||
====== API ====== | ====== API ====== | ||
- | Naše API běží na adrese https:// | + | Naše API běží na adrese https:// |
- | akcí, stejně jako z webového | + | co jde naklikat ve webovém |
- | správa uživatelských profilů (adresa, e-mail, apod.). | + | běžící na https:// |
- | + | ||
- | Ve skutečnosti webové rozhraní běžící na https:// | + | |
- | využívá a pro každý úkon jej volá. | + | |
===== Dokumentace API ===== | ===== Dokumentace API ===== | ||
- | Dokumentace API, tzn. seznam | + | Dokumentace API, tzn. seznam |
- | parametrů je k vidění na https:// | + | parametrů je k vidění na https:// |
- | Bez přihlášení se zobrazuje seznam všech | + | Bez přihlášení se zobrazuje seznam všech |
pracovat pouze administrátoři. Vpravo nahoře se lze přihlásit stejnými údaji | pracovat pouze administrátoři. Vpravo nahoře se lze přihlásit stejnými údaji | ||
jako do vpsAdminu a poté se zobrazí pouze objekty, akce a parametry, se | jako do vpsAdminu a poté se zobrazí pouze objekty, akce a parametry, se | ||
Řádek 26: | Řádek 23: | ||
* Ruby - https:// | * Ruby - https:// | ||
- | * PHP - https:// | + | * PHP - https:// |
* JavaScript - https:// | * JavaScript - https:// | ||
+ | * Go - https:// | ||
* Webové rozhraní z HaveAPI - https:// | * Webové rozhraní z HaveAPI - https:// | ||
* Souborový systém založený na FUSE - https:// | * Souborový systém založený na FUSE - https:// | ||
Řádek 46: | Řádek 44: | ||
Druhou metodou je autentizace přes tokeny. Funguje to tak, že klient nejprve | Druhou metodou je autentizace přes tokeny. Funguje to tak, že klient nejprve | ||
- | požádá o vytvoření tokenu, k tomu potřebuje jméno | + | požádá o vytvoření tokenu, k tomu potřebuje jméno, heslo a připadně i TOTP. |
- | token, může jméno a heslo zapomenout a dále se autentizuje získaným tokenem. | + | Jakmile |
+ | získaným tokenem. | ||
Tokeny mohou být několika typů s různě dlouhou životností: | Tokeny mohou být několika typů s různě dlouhou životností: | ||
Řádek 63: | Řádek 62: | ||
Ruby, OpenSSL a ncurses (většinou balíčky s příponou '' | Ruby, OpenSSL a ncurses (většinou balíčky s příponou '' | ||
- | <note> | + | ==== Linux ==== |
+ | ====Instalace na Centos 7==== | ||
+ | |||
+ | Zdrojový kod klienta lze najít [[https:// | ||
+ | |||
+ | vpsfree-client vyžaduje ruby > | ||
+ | |||
+ | Ruby ve verzi nižší než [[https:// | ||
+ | |||
+ | Aktuální Ruby je možné nainstalovat pomocí [[ https:// | ||
+ | |||
+ | Například: | ||
+ | < | ||
+ | yum install -y openssl-devel readline-devel zlib-devel | ||
+ | / | ||
+ | # následně je zapotřebí přidat rbenv do PATH a provést trochu magie(snippet z .bashrc): | ||
+ | export PATH=" | ||
+ | if [ -d '/ | ||
+ | eval " | ||
+ | fi | ||
+ | / | ||
+ | / | ||
+ | #projistotu spustte nový bash který uvidí novou verzi ruby | ||
+ | / | ||
+ | #proveďte instalaci | ||
+ | / | ||
+ | # | ||
+ | / | ||
+ | / | ||
+ | / | ||
+ | Usage: / | ||
+ | ... | ||
+ | </ | ||
+ | =============== | ||
+ | ====Instalace CLI na Linux distribucích založených na Arch Linux==== | ||
+ | Testováno na [[https:// | ||
+ | |||
+ | <code bash> | ||
+ | sudo pacman -Syu # | ||
+ | sudo pacman -S rubygems # | ||
+ | gem install vpsfree-client # | ||
+ | </ | ||
+ | |||
+ | Přidáme PATH k nainstalovaným gems do '' | ||
+ | |||
+ | <code bash> | ||
+ | sudo nano ~/.bashrc | ||
+ | </ | ||
+ | |||
+ | Na konec souboru přidáme: | ||
+ | |||
+ | <code bash> | ||
+ | if which ruby >/ | ||
+ | PATH=" | ||
+ | fi | ||
+ | </ | ||
+ | |||
+ | Restartujeme shell '' | ||
+ | <code bash> | ||
+ | vpsfreectl ip_traffic top | ||
+ | </code> | ||
+ | |||
+ | Výše uvedené příkazy nefungují na distribucích založených na Debian/ | ||
+ | |||
+ | ==== macOS ==== | ||
Na OS X je nutné nainstalovat OpenSSL přes [[http:// | Na OS X je nutné nainstalovat OpenSSL přes [[http:// | ||
poté se dá nainstalovat EventMachine (gem, jenž klient vyžaduje). | poté se dá nainstalovat EventMachine (gem, jenž klient vyžaduje). | ||
Řádek 71: | Řádek 135: | ||
$ sudo gem install eventmachine -- --with-opt-include="/ | $ sudo gem install eventmachine -- --with-opt-include="/ | ||
</ | </ | ||
- | </ | ||
Nainstalovat jej lze pomocí ruby gems: | Nainstalovat jej lze pomocí ruby gems: | ||
Řádek 88: | Řádek 151: | ||
</ | </ | ||
- | ==== Instalace ve Windows 10 využitím Ubuntu Linux subsystem | + | ==== Windows ==== |
- | + | Instalace ve Windows 10 využitím Ubuntu Linux subsystem: | |
- | === Instalace Ubuntu (Linux subsystemu Windows 10) === | + | |
- ve Windows 10 povolit developer mode, nechat nainstalovat | - ve Windows 10 povolit developer mode, nechat nainstalovat | ||
Řádek 143: | Řádek 205: | ||
</ | </ | ||
- | ==== Použití ==== | + | ==== Použití |
< | < | ||
Řádek 187: | Řádek 249: | ||
Available resources: | Available resources: | ||
- | auth_token | ||
cluster | cluster | ||
cluster_resource | cluster_resource | ||
+ | cluster_resource_package | ||
+ | cluster_resource_package.item | ||
dataset | dataset | ||
dataset.snapshot | dataset.snapshot | ||
Řádek 199: | Řádek 262: | ||
environment.config_chain | environment.config_chain | ||
environment.dataset_plan | environment.dataset_plan | ||
+ | host_ip_address | ||
integrity_check | integrity_check | ||
integrity_fact | integrity_fact | ||
integrity_object | integrity_object | ||
ip_address | ip_address | ||
- | ip_range | ||
ip_traffic | ip_traffic | ||
ip_traffic_monitor | ip_traffic_monitor | ||
Řádek 216: | Řádek 279: | ||
migration_plan.vps_migration | migration_plan.vps_migration | ||
network | network | ||
+ | network_interface | ||
node | node | ||
node.status | node.status | ||
Řádek 221: | Řádek 285: | ||
os_template | os_template | ||
pool | pool | ||
+ | session_token | ||
snapshot_download | snapshot_download | ||
+ | system_config | ||
transaction | transaction | ||
transaction_chain | transaction_chain | ||
Řádek 228: | Řádek 294: | ||
user.cluster_resource | user.cluster_resource | ||
user.public_key | user.public_key | ||
+ | user.mail_role_recipient | ||
+ | user.mail_template_recipient | ||
user.state_log | user.state_log | ||
+ | user_cluster_resource_package | ||
+ | user_cluster_resource_package.item | ||
+ | user_namespace | ||
+ | user_namespace_map | ||
+ | user_namespace_map.entry | ||
user_session | user_session | ||
vps | vps | ||
Řádek 234: | Řádek 307: | ||
vps.config | vps.config | ||
vps.feature | vps.feature | ||
- | vps.ip_address | ||
vps.mount | vps.mount | ||
vps.outage_window | vps.outage_window | ||
Řádek 240: | Řádek 312: | ||
vps.status | vps.status | ||
vps_config | vps_config | ||
+ | monitored_event | ||
+ | monitored_event.log | ||
+ | outage | ||
+ | outage.entity | ||
+ | outage.handler | ||
+ | outage_update | ||
+ | user_outage | ||
+ | vps_outage | ||
+ | vps_outage_mount | ||
+ | help_box | ||
+ | news_log | ||
+ | incoming_payment | ||
+ | payment_stats | ||
+ | user_account | ||
+ | user_payment | ||
+ | user_request | ||
+ | user_request.registration | ||
+ | user_request.change | ||
action_state | action_state | ||
</ | </ | ||
Řádek 268: | Řádek 358: | ||
-a, --auth METHOD | -a, --auth METHOD | ||
-s, --save | -s, --save | ||
- | --username | + | --user USER User name |
--password PASSWORD | --password PASSWORD | ||
--token TOKEN Token | --token TOKEN Token | ||
Řádek 686: | Řádek 776: | ||
aither | aither | ||
</ | </ | ||
+ |