| 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 | |
Parámetros de entrada:
- [login] : string : nombre de la cuenta FTP
- homePath : string : ruta de inicio de la cuenta FTP (relativa al dominio)
- passwFTP : string : contraseña de la cuenta FTP
- quota : int : cuota de la cuenta en MB o -1 si es ilimitada.
- type : string : tipo de la cuenta de FTP (R -> Sólo lectura / RW -> Lectura y escritura)
Parámetros de salida:
- Devuelve un boolean a true si la operación se ha ejecutado correctamente.
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_EXCEDED_LIMIT_RESOURCES
- ERROR_FTP_QUOTAEXECED
- ERROR_FTP_ADDUSER
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: client, domain
Permisos necesarios: PERM_DOMAIN_FTP
Funcionamiento:
- Crea una nueva cuenta de FTP.
Si login es null, se asignará un nombre secuencial autogenerado a la cuenta.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- ftpID : int : identificador de la cuenta FTP
Parámetros de salida:
- Devuelve un boolean a true si la operación se ha ejecutado correctamente.
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_FTP_USERNOTEXISTS
- ERROR_FTP_DELUSER
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_FTP
Funcionamiento:
- Elimina la cuenta de FTP ftpID.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- ftpID : int : identificador de la cuenta FTP
- newPassword : string : nueva contraseña
Parámetros de salida:
- Devuelve un boolean a true si la operación se ha ejecutado correctamente.
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_FTP_USERNOTEXISTS
- ERROR_FTP_CHANGEPASSWORD
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_FTP
Funcionamiento:
- Asigna la nueva contraseña newPassword a la cuenta de FTP ftpId.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- ftpID : int : identificador de la cuenta FTP
- quota : int : nueva cuota (en MB y -1 si es ilimitada)
Parámetros de salida:
- Devuelve un boolean a true si la operación se ha ejecutado correctamente.
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_FTP_USERNOTEXISTS
- ERROR_FTP_CHANGEQUOTA
- ERROR_FTP_QUOTAEXECED
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_FTP
Funcionamiento:
- Actualiza la cuota asignada a la cuenta ftpID.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- [searchLogin] : string : filtrado de la búsqueda por el nombre de cuenta FTP
- [orderArray] : OrderArray : estructura de ordenación de resultados
Parámetros de salida:
- Devuelve un ArrayOfFTPUserInfo
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_FTP_LISTUSERS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: ninguno
Funcionamiento:
- Devuelve la lista de usuarios de FTP del dominio que invoca al servicio web
Los parámetros de ordenación pueden ser los siguientes:
- login : nombre de la cuenta de FTP
- quota : cuota asignada a la cuenta de FTP
- date : fecha de creación de la cuenta de FTP
- type : tipo de cuenta FTP (R / RW / P)
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- $userID : int : identificador de la cuenta de FTP
Parámetros de salida:
- Devuelve un FTPUserInfo
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_FTP_GETUSERINFO
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_FTP
Funcionamiento:
- Obtiene información sobre la cuenta de FTP asociada a userID.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- ninguno
Parámetros de salida:
- Devuelve un LoginInfo
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_FTP_GETPRINCIPALLOGIN
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: ninguno
Funcionamiento:
- Obtiene información sobre la cuenta principal FTP del dominio
Ejemplos:
.NET Java PHP