————-zkontrolovat přidání věcí————–

Dokumentace I2PControl API

I2PControl je JSON-RPC 2.0 API dodávané s I2P routerem (od verze 0.9.39). Umožňuje autentifikované monitorování a ovládání routeru prostřednictvím strukturovaných JSON požadavků.

Výchozí heslo: itoopie — toto je tovární výchozí nastavení a mělo by být okamžitě změněno z bezpečnostních důvodů.

1. Přehled a přístup

2. Formát JSON-RPC

Všechny požadavky dodržují strukturu JSON-RPC 2.0:

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

Úspěšná odpověď obsahuje pole result; při selhání je vrácen objekt error:

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

nebo

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

3. Tok autentizace

Požadavek (Autentifikace)

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/

Úspěšná odpověď

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

Tento Token musíte zahrnout do všech následujících požadavků v params.

4. Metody a koncové body

4.1 RouterInfo

Získává klíčovou telemetrii o routeru.

Příklad požadavku

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/

Pole odpovědi (result) Podle oficiální dokumentace (GetI2P): - i2p.router.status (String) — čitelný stav - i2p.router.uptime (long) — milisekundy (nebo string pro starší i2pd) :contentReference[oaicite:0]{index=0} - i2p.router.version (String) — řetězec verze :contentReference[oaicite:1]{index=1} - i2p.router.net.bw.inbound.1s, i2p.router.net.bw.inbound.15s (double) — příchozí šířka pásma v B/s :contentReference[oaicite:2]{index=2} - i2p.router.net.bw.outbound.1s, i2p.router.net.bw.outbound.15s (double) — odchozí šířka pásma v B/s :contentReference[oaicite:3]{index=3} - i2p.router.net.status (long) — číselný stavový kód (viz výčet níže) :contentReference[oaicite:4]{index=4} - i2p.router.net.tunnels.participating (long) — počet účastnických tunelů :contentReference[oaicite:5]{index=5} - i2p.router.netdb.activepeers, fastpeers, highcapacitypeers (long) — statistiky peerů v netDb :contentReference[oaicite:6]{index=6} - i2p.router.netdb.isreseeding (boolean) — zda je aktivní reseed :contentReference[oaicite:7]{index=7} - i2p.router.netdb.knownpeers (long) — celkový počet známých peerů :contentReference[oaicite:8]{index=8}

Status Code Enum (i2p.router.net.status)

4.2 GetRate

Používá se k načtení metrik rychlosti (např. šířka pásma, úspěšnost tunnelů) během daného časového okna.

Příklad požadavku

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/

Ukázková odpověď

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

4.3 RouterManager

Provádět administrativní akce.

Povolené parametry / metody - Restart, RestartGraceful - Shutdown, ShutdownGraceful - Reseed, FindUpdates, Update :contentReference[oaicite:10]{index=10}

Příklad požadavku

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/

Úspěšná odpověď

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

4.4 NetworkSetting

Získat nebo nastavit parametry konfigurace sítě (porty, upnp, sdílení šířky pásma, atd.)

Příklad požadavku (získání aktuálních hodnot)

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/

Ukázková odpověď

{
  "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
  }
}

Poznámka: verze i2pd starší než 2.41 mohou vracet číselné typy namísto řetězců — klienti by měli zvládnout oba případy. :contentReference[oaicite:11]{index=11}

4.5 Pokročilé nastavení

Umožňuje manipulaci s interními parametry routeru.

Příklad požadavku

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/

Příklad odpovědi

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

5. Kódy chyb

Standardní chybové kódy JSON-RPC2

6. Použití a nejlepší postupy

• Vždy zahrňte parametr Token (kromě případů autentifikace).
• Při prvním použití změňte výchozí heslo (itoopie).
• Pro Java I2P se ujistěte, že je I2PControl webapp povolena přes WebApps.
• Buďte připraveni na drobné variace: některá pole mohou být čísla nebo řetězce v závislosti na verzi I2P.
• Zalamujte dlouhé stavové řetězce pro přívětivý výstup pro zobrazení.