Administracyjny Plugin RPC HTTP

• POST /api/v1/admin/rpc
• ten sam nasłuch co Gateway: http://<gateway-host>:<port>/api/v1/admin/rpc

​

Zanim go włączysz

• Wywołujący jest zaufany do obsługi Gateway.
• Wywołujący nie może używać klienta RPC WebSocket.
• Trasa jest osiągalna tylko przez loopback, tailnet albo prywatny uwierzytelniony punkt wejścia.
• Przejrzano dozwolone metody i odpowiadają automatyzacji, którą planujesz uruchomić.

​

Włączanie

openclaw plugins enable admin-http-rpc
openclaw gateway restart

{
  plugins: {
    entries: {
      "admin-http-rpc": { enabled: true },
    },
  },
}

openclaw plugins disable admin-http-rpc
openclaw gateway restart

​

Weryfikacja trasy

curl -sS http://<gateway-host>:<port>/api/v1/admin/rpc \
  -H 'Authorization: Bearer <gateway-token>' \
  -H 'Content-Type: application/json' \
  -d '{"method":"health","params":{}}'

{
  "id": "generated-request-id",
  "ok": true,
  "payload": {
    "status": "ok"
  }
}

​

Uwierzytelnianie

• uwierzytelnianie współdzielonym sekretem (gateway.auth.mode="token" albo "password"): Authorization: Bearer <token-or-password>
• zaufane uwierzytelnianie HTTP przenoszące tożsamość (gateway.auth.mode="trusted-proxy"): kieruj przez skonfigurowany serwer proxy świadomy tożsamości i pozwól mu wstrzyknąć wymagane nagłówki tożsamości
• otwarte uwierzytelnianie prywatnego punktu wejścia (gateway.auth.mode="none"): nagłówek uwierzytelniania nie jest wymagany

​

Model bezpieczeństwa

• Włączenie Plugin celowo udostępnia dostęp do dozwolonych metod RPC administratora pod adresem /api/v1/admin/rpc.
• Plugin deklaruje zarezerwowany kontrakt manifestu contracts.gatewayMethodDispatch: ["authenticated-request"], aby jego uwierzytelniona przez Gateway trasa HTTP mogła wysyłać metody płaszczyzny sterowania w procesie.
• Uwierzytelnianie bearer współdzielonym sekretem potwierdza posiadanie sekretu operatora gateway.
• Dla uwierzytelniania token i password węższe nagłówki x-openclaw-scopes są ignorowane i przywracane są zwykłe pełne domyślne uprawnienia operatora.
• Zaufane tryby HTTP przenoszące tożsamość respektują x-openclaw-scopes, gdy są obecne.
• gateway.auth.mode="none" oznacza, że ta trasa jest nieuwierzytelniona, jeśli Plugin jest włączony. Używaj tego tylko za prywatnym punktem wejścia, któremu w pełni ufasz.
• Żądania są wysyłane przez te same procedury obsługi metod Gateway i kontrole zakresów co RPC WebSocket po przejściu uwierzytelniania trasy Plugin.
• Utrzymuj tę trasę na loopback, tailnecie albo prywatnym zaufanym punkcie wejścia. Nie wystawiaj jej bezpośrednio do publicznego internetu.
• Kontrakty manifestu Plugin nie są piaskownicą. Zapobiegają przypadkowemu użyciu zarezerwowanych pomocników SDK; zaufane pluginy nadal działają w procesie Gateway.

​

Żądanie

POST /api/v1/admin/rpc
Authorization: Bearer <gateway-token>
Content-Type: application/json

{
  "id": "optional-request-id",
  "method": "health",
  "params": {}
}

• id (ciąg znaków, opcjonalne): kopiowane do odpowiedzi. UUID jest generowany, gdy pole zostanie pominięte.
• method (ciąg znaków, wymagane): dozwolona nazwa metody Gateway.
• params (dowolne, opcjonalne): parametry specyficzne dla metody.

​

Odpowiedź

{
  "id": "optional-request-id",
  "ok": true,
  "payload": {}
}

{
  "id": "optional-request-id",
  "ok": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "bad params"
  }
}

​

Dozwolone metody

• wykrywanie: commands.list Zwraca nazwy metod RPC HTTP dozwolone przez ten Plugin.
• gateway: health, status, logs.tail, usage.status, usage.cost, gateway.restart.request
• konfiguracja: config.get, config.schema, config.schema.lookup, config.set, config.patch, config.apply
• kanały: channels.status, channels.start, channels.stop, channels.logout
• web: web.login.start, web.login.wait
• modele: models.list, models.authStatus
• agenci: agents.list, agents.create, agents.update, agents.delete
• zatwierdzenia: exec.approvals.get, exec.approvals.set, exec.approvals.node.get, exec.approvals.node.set
• cron: cron.status, cron.list, cron.get, cron.runs, cron.add, cron.update, cron.remove, cron.run
• urządzenia: device.pair.list, device.pair.approve, device.pair.reject, device.pair.remove
• węzły: node.list, node.describe, node.pair.list, node.pair.approve, node.pair.reject, node.pair.remove, node.rename
• zadania: tasks.list, tasks.get, tasks.cancel
• diagnostyka: doctor.memory.status, update.status

​

Porównanie z WebSocket

​

Rozwiązywanie problemów

​

Powiązane

• Zakresy operatora
• Bezpieczeństwo Gateway
• Dostęp zdalny
• Manifest Plugin
• Podścieżki SDK