Cloud Server
API
Meccanismo di autenticazione
Le API sono protette con account e password e richiedono un'autorizzazione per ogni operazione, per maggiori dettagli consulta gli articoli relativi a come ottenere le
credenziali di accesso ed
effettuare la prima connessione. Una volta ottenute le credenziali per l'autenticazione (username e password) sarà necessario invocare il metodo GetUserAuthenticationToken, il quale, a fronte della presentazione di credenziali corrette, genera un token (temporaneo e temporale) che mantiene lo stato di autenticazione per l'utente. Non vi sarà quindi necessità di ri-autenticarsi.
Di seguito un esempio C# di utilizzo di tale metodo:
private static void LoginToWsEndUser(WsEndUserClient client)
{
//specifica le credenziali dell'account
client.ClientCredentials.UserName.UserName = "ARU-0000";
client.ClientCredentials.UserName.Password = "0123456789";
try
{
var result = client.GetUserAuthenticationToken();
if (result.Success)
{
//il metodo è andato a buon fine
}
else
{
throw new Exception(result.ResultMessage);
}
}
catch (MessageSecurityException msEx)
{
//utente non autenticato
throw new Exception(msEx.Message);
}
catch (Exception ex)
{
//eccezione generica
throw new Exception(ex.Message);
}
}
Per maggiori informazioni:
https://kb.cloud.it/api/api/login-ed-uso-del-token-sostitutivo.aspx
URL web documentazione API
Funzionalità invocabili tramite API
- Ottenere informazioni sulle impostazioni di configurazione dei datacenter (GetDatacenterCon figurations)
- Ottenere una lista degli hypervisor disponibili e dei template associati a ciascun hypervisor (GetHypervisors)
- Ottenere la lista dei Template disponibili con le relative risorse configurabili (GetHypervisors)
- Ottenere una lista di oggetti di classe VirtualDataCenter (GetVirtualDatacenter)
- Conoscere il dettaglio dei costi per ogni singola componente del virtual datacenter (GetVirtualDatacenterCost)
- Verificare il credito associato all'account specificato in fase di autenticazione (GetCredit)
- Ottenere una lista di oggetti di classe Job (GetJobs)
- Ottenere la lista dei Job attivi per il server indicato (GetServerDetails)
- Ottenere la lista dei messaggi di log generata nel periodo richiesto (GetLogs)
- Ottenere l'elenco delle notifiche relative all'utente tipo licenze acquistabili, promozioni, novità, ecc. (GetNews)
- Segnalare una News come già letta in maniera tale da non ripresentarla all'utente (SetReadNews)
- Creare un server virtuale specificando le caratteristiche delle varie risorse di cui si compone (SetEnqueueServerCreation)
- Ottenere i pacchetti preconfigurati (GetPreconfiguredPackages)
- Accodare un'operazione (Job) di startup del server virtuale (SetEnqueueServerStart)
- Spegnere il server come se si staccasse la corrente (SetEnqueueServerPowerOff)
- Spegnere il server tramite comandi da sistema operativo (SetEnqueueServerStop)
- Accodare un'operazione (Job) di cancellazione del server virtuale (SetEnqueueServerDeletion)
- Riservare all'account specificato il primo indirizzo IP pubblico libero (SetPurchaseIpAddress)
- Rimuovere l'indirizzo IP specificato, se associato all'account con cui si effettua la chiamata al metodo (SetRemoveIpAddress)
- Ottenere una lista di oggetti di classe IPAddress che rappresentano gli indirizzi IP acquistati (GetPurchasedIpAddresses)
- Acquistare una VLan denominata (SetPurchaseVLan)
- Rimuovere la VLan specificata (SetRemoveVLan)
- Recuperare la configurazione della VLan (GetPurchasedVLans)
- Ottenere i listini prezzi orari applicati all'account specificato in fase di autenticazione (GetPriceList)
- Conoscere il dettaglio dei costi orari e mensili ed effettuare proiezioni per ogni singola componente del virtual datacenter (GetVirtualDataCenterCost)
- Modificare le risorse di un server virtuale, specificando le caratteristiche delle risorse che sono cambiate (SetEnqueueServerUpdate)
- Accodare un operazione (Job) di gestione di un disco virtuale (SetEnqueueVirtualDiskManage)
- Modificare il nome col quale il server viene visualizzato (SetRenameServer)
- Associare a network adapter uno o più IPAddress riservati all'account indicato in fase di autenticazione (SetEnqueueAssociateIpAddress)
- Disassociare a network adapter uno o più IPAddress riservati all'account indicato in fase di autenticazione (SetEnqueueDeassociateIpAddress)
- Associare una scheda di rete ad uno Switch Virtuale (SetEnqueueAssociateVLan)
- Associare un virtual switch al nostro server (SetEnqueueAssociateVLan)
- Rimuovere l'associazione di una scheda di rete da uno Switch Virtuale (SetEnqueueDeassociateVLan)
- Eseguire un'operazione di creazione, ripristino o cancellazione di uno snapshot dei dischi di un server virtuale (SetEnqueueServerSnapshot)
- Aggiungere, modificare oppure cancellare le note associate al server virtuale specificato (SetChangeNoteServer)
- Accodare un'operazione (Job) di archiviazione del server virtuale (SetEnqueueServerArchiviation)
- Accodare un'operazione (Job) di ripristino di un server virtuale archiviato (SetEnqueueServerRestore)
- Associare alcuni indirizzi IP ad una scheda di rete (SetEnqueueAssociateIpAddress)
- Rimuovere l'associazione degli indirizzi IP da una scheda di rete (SetEnqueueDeassociateIpAddress)
- Creare un account FTP (SetEnqueueCreateFTPAccount)
- Modificare la dimensione dello spazio FTP dell'utente (SetEnqueueResizeFTPAccount)
- Ottenere le credenziali di accesso (GetPurchasedFTP)
- Ottenere una lista di oggetti di classe CustomVirtualDisk che rappresentano i dischi virtuali importati nell'area di FTP (GetCustomVirtualDisks)
- Esportare un disco virtuale (SetEnqueueVirtualDiskExport)
- Montare un immagine ISO su una macchina virtuale (SetEnqueueMountDvdIso)
- Smontare un immagine ISO da una macchina virtuale (SetEnqueueUnmountDvdIso)
- Effettuare la formattazione della macchina virtuale (SetEnqueueReinitializeServer)
- Acquistare una licenza specificando la licenza madre con le relative licenze Addon e le quantità corrispondenti (SetEnqueuePurchasePleskLicense)
- Rimuovere una licenza, se associato all'account con cui si effettua la chiamata al metodo (SetRemoveLicense)
- Ottenere le informazioni di dettaglio sulle licenze acquistate dall'utente (GetPurchasedLicenses)
- Ottenere la lista delle licenze acquistabili (GetAvailableLicenses)
- Leggere le operazioni schedulate (GetScheduledOperations)
- Leggere le istanze eseguite delle operazioni schedulate (GetScheduleOccurrences)
- Aggiungere un'operazione schedulata (SetAddServerScheduledOperation)
- Aggiungere un'operazione schedulata ricorrente (SetAddServerScheduledOperation)
- Modificare un'operazione schedulata ricorrente (SetUpdateServerScheduledOperation)
- Sospendere un'operazione schedulata ricorrente (SetUpdateServerScheduledOperation)
- Eliminare un'operazione schedulata (SetRemoveServerScheduledOperation)
- Mostrare tutti gli storage acquistati da un account (GetSharedStorages)
- Acquistare un network storage (SetEnqueuePurchaseSharedStorage)
- Modificare la dimensione di uno storage (SetEnqueueModifySharedStorage)
- Eliminare un network storage (SetEnqueueRemoveSharedStorage)
- Modificare il nome di un network storage (SetRenameSharedStorage)
- Ottenere la lista dei bilanciatori (GetLoadBalancers)
- Creare un bilanciatore di carico (SetEnqueueLoadBalancerCreation)
- Avviare un bilanciatore (SetEnqueueLoadBalancerStart)
- Modificare il nome di un bilanciatore e il parametro "health check notification agreement" (SetModifyLoadBalancer)
- Spegnere un bilanciatore (SetEnqueueLoadBalancerPowerOff)
- Eliminare un bilanciatore (SetEnqueueLoadBalancerDeletion)
- Ottenere la statistica del carico di lavoro di un bilanciatore (GetLoadBalancerLoads)
- Ottenere la lista delle statistiche di una regola del bilanciatore (GetLoadBalancerRuleStatistics)
- Aggiungere una regola al bilanciatore (SetAddLoadBalancerRule)
- Rimuovere una regola del bilanciatore (SetRemoveLoadBalancerRule)
- Aggiungere un indirizzo IP al bilanciatore (SetEnqueueLoadBalancerAddInstances)
- Rimuovere alcuni indirizzi dal bilanciatore (SetEnqueueLoadBalancerRemoveInstances)
- Ottenere la lista delle notifiche da inviare relative ad un bilanciatore (GetLoadBalancerNotifications)
- Aggiungere un contatto al bilanciatore (SetAddLoadBalancerContacts)
- Rimuovere dei contatti dal bilanciatore (SetRemoveLoadBalancerContacts)
- Recuperare la lista dei template personalizzati attivi creati dell'utente (GetAvailablePersonalTemplates)
- Creazione di un nuovo template personalizzato a partire dal disco primario di un Cloud Server attivo sul sistema (SetEnqueuePersonalTemplateCreation)
- Aggiornare gli attributi del personal template creato (SetUpdatePersonalTemplate)
- Rimuovere un personal template creato da un utente (SetRemovePersonalTemplate)
- Ottenere la lista delle richieste di assistenza inserite dall'utente in un intervallo temporale (GetUserAssistanceRequests)
- *Ottenere tutte le informazioni circa una richiesta di assistenza (GetAssistanceRequestDetails)
- Accettare o rifiutare una quotazione elaborata dal team di assistenza (SetAssistanceQuotationAcceptance)
- Ottenere l'elenco dei Private Cloud acquistati (GetPurchasedPrivateClouds)
- Conoscere gli attributi di un Private Cloud (GetPrivateCloudResourcesTypes)
- Acquistare un Private Cloud (setEnqueuePurchasePrivateCloud)
- Modificare il nome, la descrizione, il numero di telefono e l'email di un Private Cloud (SetModifyPrivateCloud)
- Modificare la quantità di risorse di un Private Cloud (SetEnqueueModifyPrivateCloudResources)
- Cancellare un Private Cloud (SetEnqueuePrivateCloudDeletion)
- Attivare un Private Cloud (SetEnqueuePrivateCloudActivation)
- Ritorna una lista di lingue con cui l'utente può chiedere assistenza (GetAssistanceLanguages)
- Recupera la compagnia in base ai parametri dell'URL (GetCompanyByUrl)
- Ritorna il dettaglio del template disponibile nel singolo Hypervisor (GetHypervisorDetails)
- Ritorna i differenti tipi di Hypervisor (GetHypervisorTypes)
- Ritorna una lista di immagini Iso disponibili (GetIsos)
- Recupera la configurazione del network adapter per il server specificato (GetNetworkAdapterConfiguration)
- Recupera il dettaglio del Private Cloud acquistato (GetPurchasedPrivateCloudDetails)
- Ritorna la lista di tipi di scheduler (GetSchedulerDataTypes)
- Recupera i log delle operazioni schedulate per un dato server (GetServerSchedulesLogs)
- Ottiene una lista di server per l'utente specificato (GetServers)
- Mostra le statistiche d'uso per le risorse di un dato server (GetSystemStatusHistory)
- Ritorna la lista di attributi associati al template (GetTemplateCategories)
- Ritorna il dettaglio di un dato template (GetTemplateDetails)
- Produce il token e lo associa all'utente chiamante (GetUserAuthenticationToken)
- Ritorna informazioni relative all'utente (GetUserInfo)
- Aggiunge una visualizzazione grafica del virtual data center dell'utente (GetVDCGraph)
- Imposta visualizzazione grafica del virtual data center dell'utente (SetAddVDCGraph)
- Aggiunge IQN ad un Network Storage (SetEnqueueAddIQNSharedStorage)
- Rimuove IQN ad un Network Storage (SetEnqueueRemoveIQNSharedStorage)
- Produce un operazione di reset del server virtuale specificato (SetEnqueueServerReset)
- Produce un riavvio del server virtuale specificato (SetEnqueueServerRestart)
- Assegna un nuovo nome con l'account specificato in autenticazione (SetRenameVLan)
- Permette l'aggiornamento degli attributi del personal template (SetUpdatePersonalTemplate)
- Aggiorna la visualizzazione grafica per il virtual data center (SetUpdateVDCGraph)