Информация API 1.7.0

Методы API для работы с разделом «Информация».

Базовый путь: https://{IP_контроллера}/api/v1. Версия описания API: 1.7.0.

Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.

Методы раздела

Метод	Путь
`GET`	`/info`
`GET`	`/serial`

`GET /info`

Раздел: Информация.

Возвращает информацию о контроллере

Источник в Teamly

Назначение	URL запроса
Возвращает информацию о контроллере	https://{IP_контроллера}/api/v1/info

Параметры запроса:

Отсутствуют

Варианты ответа:

Code 200 (Successfully) - удачное выполнение запроса

Название, * - обязательный	Тип	Формат	Назначение
serial*	string		Серийный номер контроллера
current_time*	integer	($int64)	Текущее время контроллера в формате UTC (метка времени UNIX в миллисекундах)
current_date_time_string	string		Строка текущей даты и времени
memory_usage*	integer		Задействованная оперативная память (в процентах)
memory_total*	integer		Общий объем оперативной памяти в байтах
disk_usage*	integer		Текущее использование дискового пространства в процентах
disk_total*	integer		Общий размер диска в байтах
cpu_load*	integer		Загрузка процессора
uptime*	integer		Время безотказной работы
version*	string		Версия прошивки
licence*	string	[ BASIC, ENBERPRISE ]	Тип лицензии

Пример:

{
  "serial": "string",
  "current_time": 0,
  "current_date_time_string": "string",
  "memory_usage": 0,
  "memory_total": 0,
  "disk_usage": 0,
  "disk_total": 0,
  "cpu_load": 0,
  "uptime": 0,
  "version": {
    "main": "string"
  },
  "licence": "BASIC"
}

Code 500 (Unexpected server error) - запрос не выполнен, получено сообщение об ошибке

Параметры и ответы по OpenAPI

{
  "description": "Get controller info",
  "responses": {
    "200": {
      "description": "Returns controller description",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "serial",
              "current_time",
              "memory_usage",
              "memory_total",
              "disk_usage",
              "disk_total",
              "cpu_load",
              "uptime",
              "version",
              "licence"
            ],
            "properties": {
              "serial": {
                "type": "string",
                "description": "Controller serial number"
              },
              "current_time": {
                "type": "integer",
                "format": "int64",
                "description": "Controller current time as UTC UNIX timestamp in milliseconds"
              },
              "current_date_time_string": {
                "type": "string"
              },
              "memory_usage": {
                "type": "integer",
                "description": "Used RAM in percentage"
              },
              "memory_total": {
                "type": "integer",
                "description": "Total RAM in bytes"
              },
              "disk_usage": {
                "type": "integer",
                "description": "Current disk usage in percentage"
              },
              "disk_total": {
                "type": "integer",
                "description": "Disk total size in bytes"
              },
              "cpu_load": {
                "type": "integer"
              },
              "uptime": {
                "type": "integer",
                "description": "System uptime in seconds"
              },
              "version": {
                "type": "object",
                "required": [
                  "main"
                ],
                "properties": {
                  "main": {
                    "type": "string"
                  }
                }
              },
              "licence": {
                "type": "string",
                "enum": [
                  "BASIC",
                  "ENBERPRISE"
                ]
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса

curl -k -X GET "https://{IP_контроллера}/api/v1/info" \
  -H "Authorization: Bearer <token>"

Пример ответа

{
  "serial": "string",
  "current_time": 1,
  "current_date_time_string": "string",
  "memory_usage": 1,
  "memory_total": 1,
  "disk_usage": 1,
  "disk_total": 1,
  "cpu_load": 1,
  "uptime": 1,
  "version": {
    "main": "string"
  },
  "licence": "BASIC"
}

`GET /serial`

Раздел: Информация.

Возвращает информацию о серийном номере контроллера

Источник в Teamly

Назначение	URL запроса
Возвращает информацию о серийном номере контроллера	https://{IP_контроллера}/api/v1/serial

Параметры запроса:

Отсутствуют

Варианты ответа:

Code 200 (Successfully received controller serial number as string reply) - удачное выполнение запроса

Название, * - обязательный	Тип	Формат	Назначение
—	string		Серийный номер контроллера

Пример:

Пример из Teamly сохранён дословно, но не является корректным JSON.

{
  00001116
}

Code 500 (Unexpected server error) - запрос не выполнен получено сообщение об ошибке

Параметры и ответы по OpenAPI

{
  "description": "Get controller serial number",
  "responses": {
    "200": {
      "description": "Successfully received controller serial number as string reply",
      "content": {
        "application/json": {
          "schema": {
            "type": "string"
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса

curl -k -X GET "https://{IP_контроллера}/api/v1/serial" \
  -H "Authorization: Bearer <token>"

Пример ответа

"string"

Методы раздела​

GET /info​

Примеры по OpenAPI​

Пример запроса​

Пример ответа​

GET /serial​

Примеры по OpenAPI​

Пример запроса​

Пример ответа​

Методы раздела

`GET /info`

Примеры по OpenAPI

Пример запроса

Пример ответа

`GET /serial`

Примеры по OpenAPI

Пример запроса

Пример ответа