| 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:
- [clientName] : string : filtro de cliente para búsqueda
- [orderArray] : OrderArray : estructura de ordenación de resultados
Parámetros de salida:
- Devuelve un ArrayOfClientInfo
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_ADMINCLIENTS_LISTCLIENTS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: admin
Permisos necesarios: ninguno
Funcionamiento:
- Devuelve la lista de los clientes creados en el servidor Cube Panel.
- El parámetro clientName permite filtrar la búsqueda por nombre de cliente.
- La ordenación se puede realizar respecto a los siguientes parámetros:
* server : nombre del servidor Cube Panel
* status : estado del cliente
* register : capacidad del cliente para registrar dominios
* date : fecha de creación del cliente
* ndomains : número de dominios que posee el cliente
* company : nombre de empresa del cliente
* username : login del cliente
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- login : string: nombre que tendrá el cliente en el servidor Cube Panel
- password : string : contraseña del nuevo cliente
- [company] : string : nombre de la empresa del cliente
- [contact] : string : nombre de contacto del cliente
- [phone] : string : número de teléfono del cliente
- [fax] : string : número de fax del cliente
- email : string : correo electrónico del cliente
- [address] : string : dirección del cliente
- [city] : string : localidad del cliente
- [state] : string : estado/provincia del cliente
- [postalCode] : int: código postal del cliente
- [country] : int : identificador del país
- idLanguage : int : identificador del idioma
- idTemplate : int : identificador de la plantilla de cliente con la que se desea crear el cliente
- panelIp : int : identificadador de la IP de Panel en la que se instalará el cliente.
- panelPort : int : siempre 8443
- [panelHostName] : string : nombre del dominio por el que accederá el cliente (y sus dominios) al panel de control
- [fiscalid] : string : identificador fiscal del cliente
- [taxes] : int : porcentaje que representa los impuestos añadidos que se aplicarán a las facturas del cliente.
- [idCurrency] : identificador de la divisa en la que se facturará al cliente.
Parámetros de salida:
- Devuelve un entero con el id de usuario creado
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_ADMINCLIENTS_ADDNEWCLIENT
- ERROR_ADMINCLIENTS_CLIENTCREATEDWITHERRORS
- ERROR_ADMINCLIENTS_TEMPLATEIDNOTEXISTS
- ERROR_ADMINCLIENTS_NEEDBILLINGDATA
- ERROR_ADMINCLIENTS_LOGINEXISTS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: admin
Permisos necesarios: ninguno
Funcionamiento:
- Este servicio web añade un nuevo cliente a partir de una plantilla que especifica los límites y permisos de los que dispondrá.
- fiscalId, taxes e idCurrency sólo son necesarios si se va a usar el módulo de "Registro de dominios" con el cliente.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- clientId: int : identificador del cliente a eliminar
Parámetros de salida:
- Devuelve "true" indicando si el cliente está siendo eliminado.
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_PROCESSOR_CLIENT_LOCKED
- ERROR_ADMINCLIENTS_REMOVECLIENT
Invocable por: admin
Permisos necesarios: ninguno
Funcionamiento:
- El servicio web comprueba que no exista ningún bloqueo en el cliente o en alguno de sus dominios.
- La eliminación es encolada en el servidor y elimina todos los recursos usados por los dominios, los propios dominios y al cliente.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- [idresources] : ArrayOfInt: array de identificadores de recursos de los que se quiere conocer su consumo.
- clientId : identificador del cliente del que se quiere conocer el consumo de recursos.
- [extraParams] : ArrayOfResourceExtraParam : parámetros extras necesarios para conocer el consumo de algunos recursos
Parámetros de salida:
- Devuelve un tipo complejo ArrayOfResourceUsage con el consumo solicitado de los recursos del cliente
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_ADMINCLIENTS_GETRESOURCEUSAGE
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: admin
Permisos necesarios: ninguno
Funcionamiento:
- El servicio web calcula el consumo total de los recursos indicados para el cliente especificado. El consumo
corresponde al total de los recursos consumidos por los dominios del cliente más el consumo específico del
cliente.
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:
- [orderArray] : OrderArray : array de ordenación de resultados
Parámetros de salida:
- Devuelve un tipo complejo ArrayOfClientTemplateInfo con la lista de plantillas de clientes disponibles.
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_ADMINCLIENTS_LISTTEMPLATES
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: admin
Permisos necesarios: ninguno
Funcionamiento:
- Devuelve la lista de plantillas de cliente creadas en el servidor.
- La ordenación se puede realizar respecto a los siguientes parámetros:
* serverName : nombre del servidor Cube Panel
* date : fecha de creación de la plantilla
* name : nombre de la plantilla
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- clientId : int : Identificador de cliente
Parámetros de salida:
- Devuelve un tipo complejo ArrayOfAdminIp con las IP's de panel que se pueden asignar al cliente.
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_ADMINCLIENTS_LISTTEMPLATES
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: admin
Permisos necesarios: ninguno
Funcionamiento:
- Devuelve las IP's que se pueden asignar al cliente clientId.
Ejemplos:
.NET Java PHP