MyChat Integration API: MCIAPI_CS_GetServerInfo, справочная информация о работающем сервере
Получить краткую статистику работающего сервера MyChat.
Синтаксис
{
"cmd" : "0012",
"ServerKey" : "iddqd",
"APIStype" : "mydata",
"context" : "myfunc"
}
Параметры
|
Параметр |
Тип |
Значение |
|
cmd |
string |
"0012", номер команды MCIAPI_CS_GetServerStat; |
|
ServerKey |
string |
ключ Integration API, задаётся в настройках сервера; |
|
APIStype |
string |
тип интеграции. Можно задавать произвольную строку; |
|
context |
string |
необязательный параметр, любой текст, который вернётся в ответной команде. |
Результат работы
{
"cmd": "0012",
"context": "myfunc",
"Uptime": 6807,
"Ver": "2023.4.2.5",
"Started": "01.08.2023.20.00.05",
"Connections": 0,
"ErrorsScripts": 0,
"StatConfMsgCount": 0,
"MaxConnects": 200,
"StatBBSMsgCount": 0,
"FTPPublicFolderSize": 0,
"OnlineUsers": 0,
"StatPrivMsgCount": 0,
"InTraffic": 0,
"NetInterfacesList": [
"192.168.1.26",
"192.168.199.1",
"192.168.22.1"
],
"RegUsers": 18148,
"Free": false,
"OutTraffic": 0,
"FTPUsersFoldersSize": 0,
"MaxOnline": 0,
"ServicesList": [
"autofind,true,udp,2004-2005,all",
"core,true,tcp,2004,all",
"ftp,true,tcp,20000-20100,all",
"web,true,tcp,443,all,http",
"turn,true,tcp/udp,8888,0.0.0.0",
"nodejs control,true,tcp,2015,127.0.0.1",
"email,true,tcp,587,smtp.dreamhost.com"
],
"VerDate": "21.07.2023",
"MyChatGuestInvites": 74,
"RegBy": "Network Software Solutions",
"StatBroadcastMsgCount": 0,
"ConfCount": 0
}
|
Поле |
Тип |
Значение |
|
cmd |
string |
HEX-номер команды, которая была успешно выполнена; |
|
context |
string |
произвольный текст, который был передан серверу в команде запроса; |
|
Uptime |
integer |
время непрерывной работы сервера в секундах; |
|
Ver |
string |
полная версия сервера; |
|
Started |
string |
дата запуска сервера в формате "dd.mm.yyyy.hh.nn.ss"; |
|
Connections |
integer |
количество активных подключений; |
|
ErrorsScripts |
integer |
количество ошибок, произошедших в скриптах во время работы текущего сеанса сервера; |
|
StatConfMsgCount |
integer |
количество отправленных сообщений в конференциях во время работы текущего сеанса сервера; |
|
MaxConnects |
integer |
максимально допустимое количество подключений в лицензии; |
|
StatBBSMsgCount |
integer |
сообщений на доске объявлений в текущем сеансе работы сервера; |
|
FTPPublicFolderSize |
int64 |
общий размер папки с публичными файлами встроенного FTP сервера; |
|
OnlineUsers |
integer |
сколько сейчас пользователей онлайн; |
|
StatPrivMsgCount |
integer |
приватных сообщений в текущем сеансе работы сервера; |
|
InTraffic |
int64 |
общий размер входящего трафика сервера; |
|
OutTraffic |
int64 |
общий размер исходящего трафика сервера (обычно эта цифра кратно больше); |
|
NetInterfacesList |
array |
список локальных сетевых интерфейсов сервера; |
|
RegUsers |
integer |
сколько пользователей зарегистрировано на сервере; |
|
Free |
boolean |
true, если сервер бесплатный, false — если коммерческая лицензия; |
|
FTPUsersFoldersSize |
int64 |
общий размер личных FTP-папок пользователей сервера; |
|
MaxOnline |
integer |
максимальное количество онлайн-подключений в текущем сеансе работы сервера; |
|
ServicesList |
array |
список работающих сервисов MyChat Server с названиями, статусом, типом (udp/tcp), портами (или диапазонами) и другой справочной информацией; |
|
VerDate |
string |
дата релиза сервера в формате "dd.mm.yyyy"; |
|
MyChatGuestInvites |
integer |
сколько всего было отправлено приглашений сервиса MyChat Guest; |
|
RegBy |
string |
на кого зарегистрирован сервер, если это коммерческая версия; |
|
StatBroadcastMsgCount |
integer |
сколько отправлено оповещений в текущем сеансе работы сервера; |
|
ConfCount |
integer |
сколько конференций создано. |