Перейти к содержимому

API процессов ​

Транспорт ​

AgentBox exposes this service through the Connect protocol over HTTP. The AgentBox SDK supplies the routing and authorization headers automatically.

  • Базовый URL: https://sandbox.agentbox-runtime.ru
  • Полное имя сервиса: process.Process
  • Шаблон URL RPC: POST https://sandbox.agentbox-runtime.ru/process.Process/{RPC}

Заголовки запроса ​

  • Agentbox-Sandbox-Id · обязательно — Sandbox identifier.
  • Agentbox-Sandbox-Port · обязательно — Envd port routed by the sandbox proxy. По умолчанию: 49983.
  • X-Access-Token · при наличии — Sandbox-scoped envd access token, when one was issued.

List ​

Public RPC exposed by envd.

  • URL RPC: POST https://sandbox.agentbox-runtime.ru/process.Process/List
  • Запрос: ListRequest
  • Ответ: ListResponse

Connect ​

Public RPC exposed by envd.

  • URL RPC: POST https://sandbox.agentbox-runtime.ru/process.Process/Connect
  • Запрос: ConnectRequest
  • Ответ: stream ConnectResponse

Start ​

Public RPC exposed by envd.

  • URL RPC: POST https://sandbox.agentbox-runtime.ru/process.Process/Start
  • Запрос: StartRequest
  • Ответ: stream StartResponse

Update ​

Public RPC exposed by envd.

  • URL RPC: POST https://sandbox.agentbox-runtime.ru/process.Process/Update
  • Запрос: UpdateRequest
  • Ответ: UpdateResponse

StreamInput ​

Client input stream ensures ordering of messages

  • URL RPC: POST https://sandbox.agentbox-runtime.ru/process.Process/StreamInput
  • Запрос: stream StreamInputRequest
  • Ответ: StreamInputResponse

SendInput ​

Public RPC exposed by envd.

  • URL RPC: POST https://sandbox.agentbox-runtime.ru/process.Process/SendInput
  • Запрос: SendInputRequest
  • Ответ: SendInputResponse

SendSignal ​

Public RPC exposed by envd.

  • URL RPC: POST https://sandbox.agentbox-runtime.ru/process.Process/SendSignal
  • Запрос: SendSignalRequest
  • Ответ: SendSignalResponse

CloseStdin ​

Close stdin to signal EOF to the process. Only works for non-PTY processes. For PTY, send Ctrl+D (0x04) instead.

  • URL RPC: POST https://sandbox.agentbox-runtime.ru/process.Process/CloseStdin
  • Запрос: CloseStdinRequest
  • Ответ: CloseStdinResponse

Типы сообщений ​

PTY ​

ПолеТипНомерОписание
sizeSize1

PTY.Size ​

ПолеТипНомерОписание
colsuint321
rowsuint322

ProcessConfig ​

ПолеТипНомерОписание
cmdstring1
argsrepeated string2
envsmap<string, string>3
cwdoptional string4

ListRequest ​

ProcessInfo ​

ПолеТипНомерОписание
configProcessConfig1
piduint322
tagoptional string3

ListResponse ​

ПолеТипНомерОписание
processesrepeated ProcessInfo1

StartRequest ​

ПолеТипНомерОписание
processProcessConfig1
ptyoptional PTY2
tagoptional string3
stdinoptional bool4This is optional for backwards compatibility. We default to true. New SDK versions will set this to false by default.

UpdateRequest ​

ПолеТипНомерОписание
processProcessSelector1
ptyoptional PTY2

UpdateResponse ​

ProcessEvent ​

ПолеТипНомерOneofОписание
startStartEvent1event
dataDataEvent2event
endEndEvent3event
keepaliveKeepAlive4event

ProcessEvent.StartEvent ​

ПолеТипНомерОписание
piduint321

ProcessEvent.DataEvent ​

ПолеТипНомерOneofОписание
stdoutbytes1output
stderrbytes2output
ptybytes3output

ProcessEvent.EndEvent ​

ПолеТипНомерОписание
exit_codesint321
exitedbool2
statusstring3
erroroptional string4

ProcessEvent.KeepAlive ​

StartResponse ​

ПолеТипНомерОписание
eventProcessEvent1

ConnectResponse ​

ПолеТипНомерОписание
eventProcessEvent1

SendInputRequest ​

ПолеТипНомерОписание
processProcessSelector1
inputProcessInput2

SendInputResponse ​

ProcessInput ​

ПолеТипНомерOneofОписание
stdinbytes1input
ptybytes2input

StreamInputRequest ​

ПолеТипНомерOneofОписание
startStartEvent1event
dataDataEvent2event
keepaliveKeepAlive3event

StreamInputRequest.StartEvent ​

ПолеТипНомерОписание
processProcessSelector1

StreamInputRequest.DataEvent ​

ПолеТипНомерОписание
inputProcessInput2

StreamInputRequest.KeepAlive ​

StreamInputResponse ​

SendSignalRequest ​

ПолеТипНомерОписание
processProcessSelector1
signalSignal2

SendSignalResponse ​

CloseStdinRequest ​

ПолеТипНомерОписание
processProcessSelector1

CloseStdinResponse ​

ConnectRequest ​

ПолеТипНомерОписание
processProcessSelector1

ProcessSelector ​

ПолеТипНомерOneofОписание
piduint321selector
tagstring2selector

Типы перечислений ​

Signal ​

ЗначениеНомерОписание
SIGNAL_UNSPECIFIED0
SIGNAL_SIGTERM15
SIGNAL_SIGKILL9