| Referencia de la API 2.2 de Cube Panel: Acceso a los servicios web de Cube Panel | ||
|---|---|---|
| Anterior | Capítulo 2. Referencia de la API | Siguiente |
Parámetros de entrada:
- [clientId] : int : identificador del cliente del que se quiere obtener los dominios (se ha de indicar si lo invoca el usuario admin)
- [name] : string : nombre de dominio a buscar entre los resultados
- [orderArray] : OrderArray : estructura de ordenación de los resultados
Parámetros de salida:
- Devuelve un ArrayOfDomainInfo
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- NOT_RESULTS_FOR_SEARCH
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: admin, client
Permisos necesarios: ninguno
Funcionamiento:
- Devuelve la lista de los dominios del cliente (si lo invoca un cliente), o de todos los dominios existentes en el servidor (si lo invoca el usuario admin).
- El parámetro name permite filtrar la búsqueda por nombre de dominio.
- La ordenación se puede realizar respecto a los siguientes parámetros:
* server : nombre del servidor Cube Panel (sólo si lo invoca el usuario admin)
* name : nombre del dominio
* status : estado del dominio
* date : fecha de creación del dominio
* diskspace : espacio en disco usado por el dominio
* traffic : tráfico consumido por el dominio
* client : cliente al que pertenece el dominio (sólo si lo invoca el usuario admin)
* template : plan al que pertenece el dominio (sólo si lo invoca un usuario de tipo client)
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- [idresources] : Array : array de enteros con los identificadores de los recursos que se quieren calcular.
- [domainId] : int : identificador del dominio del que se quieren obtener los recursos
- [extraParams] : ArrayOfResourceExtraParam : parámetros extras necesarios para conocer el consumo de algunos recursos
Parámetros de salida:
- Devuelve un ArrayOfResourceUsage
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_CLIENTDOMAINS_DOMAINNOTOFCLIENT
- ERROR_CLIENTDOMAINS_GETRESOURCEUSAGE
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: admin, client, domain
Permisos necesarios: ninguno
Funcionamiento:
- Devuelve el consumo de los recursos indicados en idresources para el dominio especificado.
Si idresources es null, se devolverán todos los recursos.
- Si el usuario que invoca al servicio web es de tipo dominio, no es necesario indicar el parámetro domainId.
- Los parámetros extras usados son los siguientes:
* Month : int : especifica el més del que se quiere obtener el consumo de tráfico
* Year : int : especifica el año del que se quiere obtener el consumo de tráfico
* actualSpace : boolean : si es true, se obtiene el espacio en disco usado actualmente. Si es false, se obtiene un valor cacheado (de hasta 1 día de antigüedad).
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- login : string : nombre del nuevo dominio
- userPassword : string : contraseña que tendrá el usuario del dominio
- personalData : DomainPersonalData : tipo complejo con los datos personales del contacto del dominio
- idTemplate : int : identificador del plan en el que se creará el dominio
- idIP : int : identificador de la IP en la que se desea dar de alta la web del dominio
- idLanguage : int : identificador del idioma del dominio
Parámetros de salida:
- Devuelve un boolean con true en caso de éxito.
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERRROR_CLIENTDOMAINS_WRONGLICENSE
- ERROR_CLIENTDOMAINS_ADDNEWDOMAIN
- ERROR_CLIENTDOMAINS_DOMAINCREATEDWITHERRORS
- ERROR_CLIENTDOMAINS_NOTPERMISSIONSFORTHISTEMPLATE
- ERROR_CLIENTDOMAINS_TEMPLATEIDNOTEXISTS
- ERROR_CLIENTDOMAINS_MASTERDNSSERVER_NEEDED
- ERROR_CLIENTDOMAINS_IPNOTEXISTS
- ERROR_CLIENTDOMAINS_LOGINEXISTS
- ERROR_PROCESSOR_LIMIT_RESOURCES
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: client
Permisos necesarios: ninguno
Funcionamiento:
- Crea un nuevo dominio con el nombre indicado. El dominio se creará con los permisos y límites especificados por el plan (idTemplate) y la web
se creará en la IP indicada.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- domainId : int : identificador del dominio a eliminar
Parámetros de salida:
- Devuelve un boolean con true en caso de éxito.
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_CLIENTDOMAINS_REMOVEDOMAIN
- ERROR_PROCESSOR_DOMAIN_LOCKED
Invocable por: admin, client
Permisos necesarios: ninguno
Funcionamiento:
- Encola un dominio para su eliminación y lo bloquea. Si el dominio estaba bloqueado, devuelve un error.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- [orderArray] : OrderArray : estructura de ordenación de los resultados
Parámetros de salida:
- Devuelve un ArrayOfTemplateInfo
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_CLIENTDOMAINS_LISTTEMPLATES
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: admin, client
Permisos necesarios: ninguno
Funcionamiento:
- Devuelve los distintos tipos de planes creados.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- [idIp] : int : Si es distinto de null, se devuelven todas las IPs disponibles excepto la indicada
- [domainId] : int : Si es distinto de null, se devuelven también las IPs ocupadas por el propio dominio aunque no estén disponibles.
Parámetros de salida:
- Devuelve un ArrayOfClientIP_Ip
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_CLIENTIP_GETASSIGNABLEIPS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: client
Permisos necesarios: ninguno
Funcionamiento:
- Devuelve las IP's disponibles para el cliente (compartidas y privadas libres).
Ejemplos:
.NET Java PHP