Referencia de la API 2.2 de Cube Panel: Acceso a los servicios web de Cube Panel
Anterior		Siguiente

Capítulo 2. Referencia de la API

Tabla de contenidos
Tipos complejos usados
Servicios web de propósito general
Administración de clientes
Administración de dominios
Buzones de correo
Redirecciones de correo
Gestión de listas de correo
Gestión de bases de datos MySQL
Gestión de bases de datos SQL Server
Gestión de DNS
Rectricciones de directorios WEB
Gestión de FTP

Tipos complejos usados

A continuación se enumeran los tipos complejos usados por los servicios web de la API de Cube Panel.

AdminIp

Elemento	Tipo	Desc.
idIp	int	Identificador de la IP
ip	string	Valor de la IP
mask	string	Máscara de la interfaz de red
interface	string	Nombre de la interfaz de red
type	string	Tipo de IP
clients	int	Número de clientes que usan la IP
domains	int	Número de dominos que usan la IP
state	boolean	Estado de la IP

ClientInfo

Elemento	Tipo	Desc.
Id	int	Identificador de cliente
Name	string	Nombre de cliente
Status	string	Estado en el que se encuentra el cliente
Company	string	Empresa del cliente
NumDomains	int	Número de dominios que posee el cliente
Date	int	Fecha de creación
IdTemplate	int	Identificador de la plantilla del cliente
server	string	Ip del servidor en el que se encuentra el cliente
port	int	Puerto del servidor en el que se encuentra el cliente
serverName	string	Nombre del servidor en el que se encuentra el cliente
register	boolean	Indica si el cliente está dado de alta en el módulo de registro de dominios

ClientIP_Ip

Elemento	Tipo	Desc.
idIp	int	Identificador de la IP
ip	string	Valor de la IP
type	string	Tipo de la IP (private/public/panel/principal)
domains	int	Número de dominios que usan la IP
state	boolean	Indica si la IP está activada o no

ClientTemplateInfo

Elemento	Tipo	Desc.
Id	int	Identificador de la plantilla de cliente
Name	string	Nombre de la plantilla
Date	string	Fecha de creación
nClients	int	Número de clientes usando la plantilla
server	string	IP del servidor en el que existe la plantilla
port	int	Puerto del servidor en el que existe la plantilla
serverName	int	Nombre del servidor en el que existe la plantilla

Country

Elemento	Tipo	Desc.
Id	int	Identificador de país
Desc	string	Nombre del país

CurrencyInfo

Elemento	Tipo	Desc.
id	int	Identificador de divisa
shortDesc	string	Acrónimo de la divisa
symbol	string	Símbolo de la divisa
desc	string	Descripción de la divisa

DetailClientInfo

Elemento	Tipo	Desc.
Login	string	Nombre del cliente
Company	string	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	E-Mail del cliente
Address	string	Dirección del cliente
City	string	Localidad del cliente
State	string	Estado/Provincia del cliente
PostalCode	string	Código postal del cliente
IdCountry	int	Identificador del país del cliente
IdTemplate	int	Identificador de la plantilla del cliente
IdPanelIP	int	Identificador de la IP de panel que usa el cliente
PanelIP	string	Valor de la IP de panel que usa el cliente
PanelPort	int	Puerto en el que el cliente tiene la web de acceso al panel
Register	boolean	Indica si el cliente está dado de alta en el módulo de registro de dominios
FiscalId	string	Identificador fiscal del cliente
Taxes	int	Porcentaje de impuesto de valor añadido que se aplica a las facturas del cliente
IdCurrency	int	Divisa en la que se factura al cliente

DNSInfo

Elemento	Tipo	Desc.
id	int	Identificador de la entrada DNS
name	string	Nombre de la entrada DNS
idType	int	Tipo de entrada DNS
type	string	Descripción del tipo de entrada DNS
value	string	Valor de la entrada DNS
default	int	Indica si la entrada la ha creado el usuario o existe por defecto

DomainInfo

Elemento	Tipo	Desc.
id	string	Identificador del dominio
name	string	Nombre del dominio
status	string	Estado del cliente
date	int	Fecha de alta del dominio
diskSpace	int	Espacio en disco ocupado por el cliente (bytes)
traffic	int	Trafico generado por el dominio (bytes)
client	string	Nombre del cliente al que pertenece el dominio
templateName	string	Nombre del plan al que pertenece el dominio
server	string	IP del servidor en el que se encuentra el dominio
port	int	Puerto del servidor en el que se encuentra el dominio
serverName	string	Nombre del servidor en el que se encuentra el dominio

DomainPersonalData

Elemento	Tipo	Desc.
Login	string	Nombre del dominio
Company	string	Empresa del usuario del dominio
Contact	string	Nombre de contacto del usuario del dominio
Phone	string	Número de teléfono del usuario del dominio
Fax	string	Número de fax del usuario del dominio
Email	string	E-Mail del usuario del dominio
Address	string	Dirección del usuario del dominio
City	string	Localidad del usuario del dominio
State	string	Estado/Provincia del usuario del dominio
PostalCode	string	Código postal del usuario del dominio
Country	int	Identificador del país del usuario del dominio
IdTemplate	int	Identificador del plan al que pertenece el dominio
IdTemplateType	int	Identificador del tipo de plan al que pertenece el dominio
IdIP	int	Identificador de la IP en la que se encuentra alojado el dominio
IP	string	Valor de la IP en la que se encuentra alojado el dominio
IPType	string	Tipo de IP en la que se encuentra alojado el dominio (private/public/principal)
SystemUser	string	Nombre del usuario principal del sistema del dominio
SystemUserPassword	string	Contraseña del usuario principal del sistema del dominio

FTPUserInfo

Elemento	Tipo	Desc.
id	int	Identificador de la cuenta FTP
login	string	Nombre de la cuenta FTP
password	string	Contraseña de la cuenta FTP
homePath	string	Ruta inicial de la cuenta FTP
quota	int	Cuota reservada para la cuenta de FTP
type	string	Tipo de cuenta de FTP (R/RW/P)
date	int	Fecha de creación de la cuenta FTP

LangInfo

Elemento	Tipo	Desc.
Id	int	Identificador del idioma
Name	string	Nombre del idioma
LangCode	string	Código del idioma

ListID

Elemento	Tipo	Desc.
listID	int	Identificador de una lista de correo

LoginInfo

Elemento	Tipo	Desc.
login	string	Nombre del usuario
password	string	Contraseña del usuario

MailAliasInfo

Elemento	Tipo	Desc.
id	int	Identificador de una redirección de correo
name	string	Dirección de correo de origen
target	int	Dirección de correo de destino
creationdate	int	Fecha de creación de la redirección de correo

MailBoxInfo

Elemento	Tipo	Desc.
id	int	Identificador numérico del buzón
name	string	Dirección de correo electrónico
login	string	Login del buzón
password	string	Contraseña del buzón
creationdate	string	Fecha de creación del buzón

mailListInfo

Elemento	Tipo	Desc.
id	int	Identificador numérico de una lista de correo
list_email	string	Dirección de correo electrónico del administrador de la lista
password	string	Contraseña del administrador
date	int	Fecha de creación de la lista de correo
admin_url	string	URL de acceso a la web de administración de la lista de correo

MysqlInfo

Elemento	Tipo	Desc.
id	int	Identificador de la base de datos MySQL
login	string	Nombre de la base de datos y del usuario
password	string	Contraseña del usuario de la base de datos
date	int	Fecha de creación de la base de datos

OrderArray

Elemento	Tipo	Desc.
orderBy	string	parámetro de ordenación (depende de la función en la que se use)
orderType	int	1 -> Ascendente / 0 -> Descendente
min	int	Primer elemento a mostrar
max	int	Úlitmo elemento a mostrar

ResourceExtraParam

Elemento	Tipo	Desc.
Name	string	Nombre del parámetro extra
Value	string	Valor del parámetro

ResourceUsage

Elemento	Tipo	Desc.
Id	int	Identificador del recurso
Usage	int	Uso del recurso
descResource	string	Descripción del recurso
server	string	Servidor del que se ha obtenido el recurso
port	int	Puerto del servidor del que se ha obtenido el recurso

RestrictedDirInfo

Elemento	Tipo	Desc.
id	int	Identificador del directorio restringido
name	string	Nombre del directorio restringido
path	string	Ruta del directorio restringido
groups	ArrayOfInt	Número de grupos asociados al directorio restringido

RestrictedDirInfoSimple

Elemento	Tipo	Desc.
id	int	Identificador del directorio restringido
name	string	Nombre del directorio restringido
path	string	Ruta del directorio restringido
groups	int	Número de grupos asociados al directorio restringido

RestrictedGroupInfo

Elemento	Tipo	Desc.
id	int	Identificador del grupo de usuarios
name	string	Nombre del grupo de usuarios
comment	string	Comentario
users	ArrayOfInt	Usuarios pertenecientes al grupo

RestrictedGroupInfoSimple

Elemento	Tipo	Desc.
id	int	Identificador del grupo de usuarios
name	string	Nombre del grupo de usuarios
comment	string	Comentario
users	int	Número de usuarios pertenecientes al grupo

RestrictedUserInfo

Elemento	Tipo	Desc.
id	int	Identificador del usuario
name	string	Nombre del usuario
password	string	Contraseña del usuario
comment	string	Comentario

SQLServerInfo

Elemento	Tipo	Desc.
id	int	Identificador de la base de datos SQL Server
login	string	Nombre de la base de datos y usuario de conexión
password	string	Contraseña del usuario de conexión
date	int	Fecha de creación de la base de datos

TemplateInfo

Elemento	Tipo	Desc.
Id	int	Identificador del plan
Name	string	Nombre del plan
Date	int	Fecha de creación del plan
nDomains	int	Número de dominios que usan el plan
TemplateTypeDesc	string	Tipo de plan
TemplateTypeId	int	Identificador del tipo de plan

Anterior	Inicio	Siguiente
Accediendo a la API desde Java		Servicios web de propósito general