OPCUAExchange HTTP API

• /help
• /status
• /getparam и /setparam

Базовый URL

/api/v01/<object>/

/help

Возвращает список доступных команд и их краткое описание.

GET /<object>/help

/status

Возвращает текущее состояние объекта обмена OPC UA (эквивалентно содержанию getInfo()).

GET /api/v01/OPCUAExchange1/status

Response

{
  "result": "OK",
  "status": {
    "name": "OPCUAExchange1",
    "logserver": {
      "host": "127.0.0.1",
      "port": 5510,
      "short": "LogServer: OK"
    },
    "channels": [
      { "index": 0, "disabled": 0, "ok": 1, "addr": "opc.tcp://127.0.0.1:4840" },
      { "index": 1, "disabled": 1 }
    ],
    "iolist_size": 32,
    "subscription": {
      "enabled": 1,
      "items": 120
    },
    "monitor": "vmon: OK",
    "httpEnabledSetParams": 1
  }
}

Если подписка отключена (enableSubscription=0), вместо поля subscription возвращаются структуры с разбиением по «тикам»:

{
  "result": "OK",
  "status": {
    ...,
    "read_attributes": [
      { "tick":  0, "batches": [25],      "total": 25 },
      { "tick": 10, "batches": [12, 12],  "total": 24 }
    ],
    "write_attributes": [
      { "tick":  0, "batches": [10],      "total": 10 }
    ],
    "monitor": "vmon: OK"
  }
}

/getparam и /setparam

Чтение и изменение выбранных runtime-параметров обмена.

Поддерживаемые параметры:

• polltime (ms) — период цикла обмена
• updatetime (ms) — период обновления данных в SM
• reconnectPause (ms) — пауза между попытками переподключения
• timeoutIterate (ms) — таймаут итерации цикла

Чтение параметров

GET /api/v01/OPCUAExchange1/getparam?name=polltime&name=updatetime&name=reconnectPause&name=timeoutIterate
Response
{
  "result": "OK",
  "params": {
    "polltime": 100,
    "updatetime": 500,
    "reconnectPause": 2000,
    "timeoutIterate": 50
  }
}

Изменение параметров

GET /api/v01/OPCUAExchange1/setparam?polltime=200&updatetime=700&reconnectPause=3000&timeoutIterate=60
Response
{
  "result": "OK",
  "updated": {
    "polltime": 200,
    "updatetime": 700,
    "reconnectPause": 3000,
    "timeoutIterate": 60
  }
}

Ограничения

• Изменение может быть заблокировано флагом httpEnabledSetParams.

Коды ошибок

• 400/5xx: некорректные значения (например, timeoutIterate="abc" или < 0)
• 400: пустой запрос /setparam (нет key=value) или /getparam (нет name)