Описание параметров
Имя | Описание | Пример | |
|---|---|---|---|
UserDescAdmin | параметры пользователе | { | |
| "id": string, | идентификатор пользователя | "id": "38b09bf3-47ed7ef6-f5e92e85-5003819d", | |
| "login" : string, | логин пользователя | "login": "user", | |
| "is_online" : bool, | статус пользователя | "is_online": true, | |
| "ip_address": string, | IP-address пользователя | "ip_address": "172.1.0.7", | |
| "last_cube_name": string, | имя последней использованной пользователем мультисферы | "last_cube_name": "MS_TEST", | |
| "last_login_ts" : Timestamp, | время последнего логина | "last_login_ts": 1570115414318868} | |
| DashboardDesc | параметры профиля | "dashboard" : { | |
| "id": DashboardId, | идентификатор профиля | "id": "00000000-00000000-00000000-00000000", | |
| "name": string, | имя профиля | "name": "Default", | |
| "created_by": string, | автор профиля | "created_by": "user", | |
| "create_timestamp": timestamp, | время создания | "create_timestamp" : 1572345987965680 | |
| "size": size_t | не используется | "size": 0} | |
| LayerDesc | параметры слоя | "layer" : { | |
| "uuid": LayerId, | идентификатор слоя | "uuid" : "3bd3b28b", | |
| "name": string, | имя слоя | "name" : "Слой 1", | |
| "is_public": bool, | расшарен слой или нет | "is_public" : false, | |
| "created_by": string, | автор слоя | "created_by" : "", | |
| "create_timestamp": timestamp, | время создания слоя | "create_timestamp" : 1572345987965680, | |
| "update_time": timestamp, | время обновления | "update_time": 1572345987965680, | |
"runtime_id": [RuntimeId], | идентификатор слоя, созданного из сценария | "runtime_id": "00000000", | |
| "script_id": [ScriptId], | идентификатор сценария, из которого создан слой | "script_id": "00000000", | |
| "description": string | описание слоя | "description": "desc"} | |
| ManagerSettings | настройки системы | "settings" : { | |
| "http_server_port": int, | порт web-сервера | "http_server_port" : 8080, | |
| "userlog_enabled" : bool | возможность скачать логи пользователей | "userlog_enabled" : false} | |
Обязательные действия
- авторизоваться authenticate : login
Общие ошибки
Код ошибки | Текст ошибки | Описание |
|---|---|---|
| "code": RequestAuthError (270) | "message": "Only authentication command allowed" | ошибка появляется, когда пользователь не залогинился |
| "code": RequestError (260) | "message": "Admin command handle fail." | ошибка появляется, когда отправленная команда не описана на сервере |
| "code": RequestError (260) | "message": "Admin command cast fail." | ошибка появляется, когда не удалось преобразовать команду к AdminCommand |
| "code": PermissionErro (204) | "message": "Such command not allowed." | ошибка появляется, когда у пользователя для отправки команды должна быть роль администратора |
| "code": InvalidArgumentError (101) | "message": "Null pointer." | ошибка появляется, когда не получена сессия либо пользователь |