Esta tradução foi gerada usando aprendizado de máquina e pode não ser 100% precisa. Ver versão em inglês

I2PControl JSON-RPC

API de gerenciamento remoto de router via webapp I2PControl

————-verificar adicionar coisas————–

Documentação da API I2PControl

I2PControl é uma API JSON-RPC 2.0 incluída com o router I2P (desde a versão 0.9.39). Ela permite monitoramento autenticado e controle do router através de requisições JSON estruturadas.

Senha padrão: itoopie — esta é a senha padrão de fábrica e deve ser alterada imediatamente por segurança.


1. Visão Geral e Acesso

ImplementationDefault EndpointProtocolEnabled by DefaultNotes
Java I2P (2.10.0+)http://127.0.0.1:7657/jsonrpc/HTTP❌ Must be enabled via WebApps (Router Console)Bundled webapp
i2pd (C++ implementation)https://127.0.0.1:7650/HTTPS✅ Enabled by defaultLegacy plugin behavior
No caso do Java I2P, você deve ir para **Router Console → WebApps → I2PControl** e habilitá-lo (configurar para iniciar automaticamente). Uma vez ativo, todos os métodos exigem que você primeiro se autentique e receba um token de sessão.

2. Formato JSON-RPC

Todas as requisições seguem a estrutura JSON-RPC 2.0:

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

Uma resposta bem-sucedida inclui um campo result; em caso de falha, um objeto error é retornado:

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

ou

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

3. Fluxo de Autenticação

Solicitação (Autenticar)

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/

Resposta Bem-sucedida

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

Você deve incluir esse Token em todas as solicitações subsequentes nos params.


4. Métodos e Endpoints

4.1 RouterInfo

Obtém telemetria chave sobre o router.

Exemplo de Requisição

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/

Campos de Resposta (result) De acordo com a documentação oficial (GetI2P): - i2p.router.status (String) — um status legível para humanos - i2p.router.uptime (long) — milissegundos (ou string para i2pd mais antigo) :contentReference[oaicite:0]{index=0} - i2p.router.version (String) — string de versão :contentReference[oaicite:1]{index=1} - i2p.router.net.bw.inbound.1s, i2p.router.net.bw.inbound.15s (double) — largura de banda de entrada em B/s :contentReference[oaicite:2]{index=2} - i2p.router.net.bw.outbound.1s, i2p.router.net.bw.outbound.15s (double) — largura de banda de saída em B/s :contentReference[oaicite:3]{index=3} - i2p.router.net.status (long) — código de status numérico (ver enum abaixo) :contentReference[oaicite:4]{index=4} - i2p.router.net.tunnels.participating (long) — número de tunnels participantes :contentReference[oaicite:5]{index=5} - i2p.router.netdb.activepeers, fastpeers, highcapacitypeers (long) — estatísticas de peers do netDB :contentReference[oaicite:6]{index=6} - i2p.router.netdb.isreseeding (boolean) — se o reseed está ativo :contentReference[oaicite:7]{index=7} - i2p.router.netdb.knownpeers (long) — total de peers conhecidos :contentReference[oaicite:8]{index=8}

Enumeração de Código de Status (i2p.router.net.status)

CodeMeaning
0OK
1TESTING
2FIREWALLED
3HIDDEN
4WARN_FIREWALLED_AND_FAST
5WARN_FIREWALLED_AND_FLOODFILL
6WARN_FIREWALLED_WITH_INBOUND_TCP
7WARN_FIREWALLED_WITH_UDP_DISABLED
8ERROR_I2CP
9ERROR_CLOCK_SKEW
10ERROR_PRIVATE_TCP_ADDRESS
11ERROR_SYMMETRIC_NAT
12ERROR_UDP_PORT_IN_USE
13ERROR_NO_ACTIVE_PEERS_CHECK_CONNECTION_AND_FIREWALL
14ERROR_UDP_DISABLED_AND_TCP_UNSET
---

4.2 GetRate

Usado para buscar métricas de taxa (por exemplo, largura de banda, sucesso do tunnel) ao longo de uma janela de tempo determinada.

Exemplo de Solicitação

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/

Resposta de Exemplo

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

4.3 RouterManager

Executar ações administrativas.

Parâmetros / métodos permitidos - Restart, RestartGraceful - Shutdown, ShutdownGraceful - Reseed, FindUpdates, Update :contentReference[oaicite:10]{index=10}

Exemplo de Solicitação

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/

Resposta de Sucesso

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

4.4 NetworkSetting

Obter ou definir parâmetros de configuração da rede (portas, upnp, compartilhamento de largura de banda, etc.)

Exemplo de Requisição (obter valores atuais)

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/

Resposta de Exemplo

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

Nota: versões do i2pd anteriores à 2.41 podem retornar tipos numéricos em vez de strings — os clientes devem lidar com ambos. :contentReference[oaicite:11]{index=11}


4.5 Configurações Avançadas

Permite manipular parâmetros internos do router.

Exemplo de Solicitação

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/

Exemplo de Resposta

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

5. Códigos de Erro

Códigos de Erro Padrão JSON-RPC2

CodeMeaning
-32700JSON parse error
-32600Invalid request
-32601Method not found
-32602Invalid parameters
-32603Internal error
### Códigos de Erro Específicos do I2PControl
CodeMeaning
-32001Invalid password provided
-32002No authentication token presented
-32003Authentication token doesn't exist
-32004The provided authentication token was expired and will be removed
-32005The version of the I2PControl API used wasn't specified, but is required to be specified
-32006The version of the I2PControl API specified is not supported by I2PControl
---

6. Uso e Melhores Práticas

  • Sempre inclua o parâmetro Token (exceto ao autenticar).
  • Altere a senha padrão (itoopie) no primeiro uso.
  • Para Java I2P, certifique-se de que o webapp I2PControl esteja habilitado via WebApps.
  • Esteja preparado para pequenas variações: alguns campos podem ser números ou strings, dependendo da versão do I2P.
  • Quebre strings de status longas para uma saída amigável à exibição.

Was this page helpful?