Прочие команды

ping

Проверка работоспособности виртуальной машины

Запрос

Пример

{
  "session_id": "00000000000000000000000000000000",
  "body": {
    "cmd": "ping"
  }
}

Описание

Ключ	Значение	Тип	Обяз-но
session_id	Идентификатор сессии	string
body	Тело запроса	object
∟ cmd	Имя команды	string

Успех

Пример

{
  "status": [
    2000,
    "SUCCESS",
    "CMD_COMPLETED_SUCCESSFULLY"
  ],
  "session_id": "00000000000000000000000000000000",
  "body": {
    "cmd": "ping",
    "result_data": {
      "server_time": 1670677815.849,
      "version": "2.1.1__20221209_1113",
      "ping": "pong"
    },
    "session_data": {
      "vm_id": "1552",
      "duration_hours": 18.33,
      "duration_hours_txt": "0W 0D 18:19:37",
      "cost": 17.95,
      "cost_txt": "17.95",
      "queue_size": 0
    }
  }
}

Описание

Ключ	Значение	Тип
status	Статус ответа	array
session_id	Идентификатор сессии	string
body	Тело ответа	object
⊢ cmd	Входная команда	string
⊢ result_data	Результат	object
| ⊢ server_time	Временная метка	number
| ⊢ version	Версия	string
| ⊢ ping	Текст ответа	string
⊢ session_data	Данные сессии	object
| ⊢ vm_id	ID виртуальной машины	string
| ⊢ duration_hours	Текущая длительность сессии	number
| ⊢ duration_hours_txt	Текущая длительность сессии текстом	string
| ⊢ cost	Текущая стоимость	number
| ⊢ cost_txt	Текущая стоимость текстом	string
| ⊢ queue_size	Размер очереди	number

get_system_info

Запрос системной информации о виртуальной машине

Запрос

Пример

{
  "session_id": "00000000000000000000000000000000",
  "body": {
    "cmd": "get_system_info"
  }
}

Описание

Ключ	Значение	Тип	Обяз-но
session_id	Идентификатор сессии	string
body	Тело запроса	object
∟ cmd	Имя команды	string

Успех

Пример

{
  "status": [
    2000,
    "SUCCESS",
    "CMD_COMPLETED_SUCCESSFULLY"
  ],
  "session_id": "00000000000000000000000000000000",
  "body": {
    "cmd": "get_system_info",
    "result_data": {
      "disks": {
        "X": {
          "total": 99999,
          "percent": 0,
          "used": 0
        }
      },
      "cpu": {
        "percent": 0
      },
      "memory": {
        "total": 99999,
        "percent": 0,
        "used": 0
      }
    }
  }
}

Описание

Ключ	Значение	Тип
status	Статус ответа	array
session_id	Идентификатор сессии	string
body	Тело ответа	object
⊢ cmd	Входная команда	string
⊢ result_data	Результат	object
| ⊢ disks	Объект дисков виртуальной машины	object
| | ⊢ <DISC>	Имя диска виртуальной машины	object
| | | ⊢ total	Общее количество байт диска	number
| | | ⊢ percent	Процент используемого пространства	number
| | | ⊢ used	Количество используемых байт	number
| ⊢ cpu	Объект информации о процессоре	object
| | ⊢ percent	Загрузка ЦПУ в процентах	number
| ⊢ memory	Объект информации об оперативной памяти	object
| | ⊢ total	Общее количество байт оперативной памяти	number
| | ⊢ percent	Процент используемой памяти	number
| | ∟ used	Количество используемых байт	number

get_cmd_info

Запрос информации о команде

Запрос

Пример

{
  "session_id": "00000000000000000000000000000000",
  "body": {
    "cmd": "get_cmd_info",
    "cmd_id": 1
  }
}

Описание

Ключ	Значение	Тип	Обяз-но
session_id	Идентификатор сессии	string
body	Тело запроса	object
⊢ cmd	Имя команды	string
∟ cmd_id	Идентификатор команды	number

Успех

Пример

{
  "status": [
    2000,
    "SUCCESS",
    "CMD_COMPLETED_SUCCESSFULLY"
  ],
  "session_id": "00000000000000000000000000000000",
  "body": {
    "cmd": "get_cmd_info",
    "result_data": {
      "status_code": 2000,
      "cmd": "doStake",
      "cmd_uuid": "00000000-0000-0000-0000-000000000000",
      "id": 1,
      "added_at": "1970-01-01 00:00:00.000",
      "done_at": "1970-01-01 00:00:00.000",
      "status_txt": "CMD_COMPLETED_SUCCESSFULLY",
      "result_data": {
        "bet_ref": "1",
        "stake_id": 1
      }
    }
  }
}

Описание

Ключ	Значение	Тип
status	Статус ответа	array
session_id	Идентификатор сессии	string
body	Тело ответа	object
⊢ cmd	Входная команда	string
⊢ result_data	Результат	object
| ⊢ status_code	Код сатуса	number
| ⊢ cmd	Имя команды	string
| ⊢ cmd_uuid	UUID команды	string
| ⊢ id	ID команды	number
| ⊢ added_at	Дата добавления команды	string
| ⊢ done_at	Дата выполнения команды	string
| ⊢ status_txt	Текстовый статус выполнения команды	string
| ∟ result_data	Результат запрашиваемой команды	object

Ошибка запроса

Пример

{
  "status": [
    4004,
    "ERROR",
    "BAD_REQUEST: Not found : status"
  ],
  "session_id": "00000000000000000000000000000000",
  "body": {
    "result_data": [],
    "cmd": {
      "cmd": "get_cmd_info",
      "cmd_id": 0
    }
  }
}

Описание

Ключ	Значение	Тип
status	Статус ответа	array
session_id	Идентификатор сессии	string
body	Тело ответа	object
⊢ result_data	Результат	array
⊢ cmd	Входная команда	object
| ⊢ cmd	Имя команды	object
| ∟ cmd_id	ID команды	number

Ошибка ID

Пример

{
  "status": [
    4006,
    "ERROR",
    "BAD_REQUEST: Field type error : cmd_id not int"
  ],
  "session_id": "00000000000000000000000000000000",
  "body": {
    "result_data": [],
    "cmd": {
      "cmd": "get_cmd_info",
      "cmd_id": "1"
    }
  }
}

Описание

Ключ	Значение	Тип
status	Статус ответа	array
session_id	Идентификатор сессии	string
body	Тело ответа	object
⊢ result_data	Результат	array
∟ cmd	Входная команда	object