————-проверить добавить материал————–

Документация API I2PControl

I2PControl — это JSON-RPC 2.0 API, встроенный в I2P router (начиная с версии 0.9.39). Он обеспечивает аутентифицированный мониторинг и управление router через структурированные JSON-запросы.

Пароль по умолчанию: itoopie — это заводская настройка по умолчанию, которая должна быть изменена немедленно для обеспечения безопасности.

1. Обзор и доступ

2. Формат JSON-RPC

Все запросы следуют структуре JSON-RPC 2.0:

{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "MethodName",
  "params": {
    /* named parameters */
  }
}

Успешный ответ включает поле result; при неудаче возвращается объект error:

{
  "jsonrpc": "2.0",
  "id": "1",
  "result": { /* data */ }
}

или

{
  "jsonrpc": "2.0",
  "id": "1",
  "error": {
    "code": -32001,
    "message": "Invalid password"
  }
}

3. Процесс аутентификации

Запрос (Аутентификация)

curl -s -H "Content-Type: application/json" \
  -d '{
        "jsonrpc": "2.0",
        "id": "1",
        "method": "Authenticate",
        "params": {
          "API": 1,
          "Password": "itoopie"
        }
      }' \
  http://127.0.0.1:7657/jsonrpc/

Успешный ответ

{
  "jsonrpc": "2.0",
  "id": "1",
  "result": {
    "Token": "a1b2c3d4e5",
    "API": 1
  }
}

Вы должны включать этот Token во все последующие запросы в params.

4. Методы и конечные точки

4.1 RouterInfo

Получает ключевую телеметрию о router.

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

curl -s -H "Content-Type: application/json" \
  -d '{
        "jsonrpc": "2.0",
        "id": "2",
        "method": "RouterInfo",
        "params": {
          "Token": "a1b2c3d4e5",
          "i2p.router.version": "",
          "i2p.router.status": "",
          "i2p.router.net.status": "",
          "i2p.router.net.tunnels.participating": "",
          "i2p.router.net.bw.inbound.1s": "",
          "i2p.router.net.bw.outbound.1s": ""
        }
      }' \
  http://127.0.0.1:7657/jsonrpc/

Поля ответа (result) Согласно официальной документации (GetI2P): - i2p.router.status (String) — понятный для человека статус - i2p.router.uptime (long) — миллисекунды (или строка для более старых i2pd) :contentReference[oaicite:0]{index=0} - i2p.router.version (String) — строка версии :contentReference[oaicite:1]{index=1} - i2p.router.net.bw.inbound.1s, i2p.router.net.bw.inbound.15s (double) — входящая пропускная способность в Б/с :contentReference[oaicite:2]{index=2} - i2p.router.net.bw.outbound.1s, i2p.router.net.bw.outbound.15s (double) — исходящая пропускная способность в Б/с :contentReference[oaicite:3]{index=3} - i2p.router.net.status (long) — числовой код статуса (см. enum ниже) :contentReference[oaicite:4]{index=4} - i2p.router.net.tunnels.participating (long) — количество участвующих tunnel :contentReference[oaicite:5]{index=5} - i2p.router.netdb.activepeers, fastpeers, highcapacitypeers (long) — статистика узлов netDB :contentReference[oaicite:6]{index=6} - i2p.router.netdb.isreseeding (boolean) — активна ли пересинхронизация :contentReference[oaicite:7]{index=7} - i2p.router.netdb.knownpeers (long) — общее количество известных узлов :contentReference[oaicite:8]{index=8}

Перечисление кодов состояния (i2p.router.net.status)

4.2 GetRate

Используется для получения метрик скорости (например, пропускная способность, успешность tunnel) за заданный временной интервал.

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

curl -s -H "Content-Type: application/json" \
  -d '{
        "jsonrpc": "2.0",
        "id": "3",
        "method": "GetRate",
        "params": {
          "Token": "a1b2c3d4e5",
          "Stat": "bw.combined",
          "Period": 60000
        }
      }' \
  http://127.0.0.1:7657/jsonrpc/

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

{
  "jsonrpc": "2.0",
  "id": "3",
  "result": {
    "Rate": 12345.67
  }
}

4.3 RouterManager

Выполнять административные действия.

Разрешённые параметры / методы - Restart, RestartGraceful - Shutdown, ShutdownGraceful - Reseed, FindUpdates, Update :contentReference[oaicite:10]{index=10}

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

curl -s -H "Content-Type: application/json" \
  -d '{
        "jsonrpc": "2.0",
        "id": "4",
        "method": "RouterManager",
        "params": {
          "Token": "a1b2c3d4e5",
          "Restart": true
        }
      }' \
  http://127.0.0.1:7657/jsonrpc/

Успешный ответ

{
  "jsonrpc": "2.0",
  "id": "4",
  "result": {
    "Restart": null
  }
}

4.4 NetworkSetting

Получить или установить параметры конфигурации сети (порты, upnp, распределение пропускной способности и т.д.)

Пример запроса (получение текущих значений)

curl -s -H "Content-Type: application/json" \
  -d '{
        "jsonrpc": "2.0",
        "id": "5",
        "method": "NetworkSetting",
        "params": {
          "Token": "a1b2c3d4e5",
          "i2p.router.net.ntcp.port": null,
          "i2p.router.net.ssu.port": null,
          "i2p.router.net.bw.share": null,
          "i2p.router.net.upnp": null
        }
      }' \
  http://127.0.0.1:7657/jsonrpc/

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

{
  "jsonrpc": "2.0",
  "id": "5",
  "result": {
    "i2p.router.net.ntcp.port": "1234",
    "i2p.router.net.ssu.port": "5678",
    "i2p.router.net.bw.share": "50",
    "i2p.router.net.upnp": "true",
    "SettingsSaved": true,
    "RestartNeeded": false
  }
}

Примечание: версии i2pd до 2.41 могут возвращать числовые типы вместо строк — клиенты должны обрабатывать оба варианта. :contentReference[oaicite:11]{index=11}

4.5 Расширенные настройки

Позволяет управлять внутренними параметрами router.

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

curl -s -H "Content-Type: application/json" \
  -d '{
        "jsonrpc": "2.0",
        "id": "6",
        "method": "AdvancedSettings",
        "params": {
          "Token": "a1b2c3d4e5",
          "Set": {
            "router.sharePercentage": "75",
            "i2np.flushInterval": "6000"
          }
        }
      }' \
  http://127.0.0.1:7657/jsonrpc/

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

{
  "jsonrpc": "2.0",
  "id": "6",
  "result": {
    "Set": {
      "router.sharePercentage": "75",
      "i2np.flushInterval": "6000"
    }
  }
}

5. Коды ошибок

Стандартные коды ошибок JSON-RPC2

6. Использование и лучшие практики

• Всегда включайте параметр Token (кроме случаев аутентификации).
• Измените пароль по умолчанию (itoopie) при первом использовании.
• Для Java I2P убедитесь, что веб-приложение I2PControl включено через WebApps.
• Будьте готовы к небольшим различиям: некоторые поля могут быть числами или строками, в зависимости от версии I2P.
• Переносите длинные строки статуса для удобного отображения.