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

Получение запущенного экземпляра браузера

Описание: Этот метод возвращает данные запущенного экземпляра браузера для указанного профиля. Поле connectionString содержит WebSocket-строку для подключения к браузеру по Chrome DevTools Protocol (CDP), а поле processId — идентификатор процесса (PID) браузера. Если для профиля нет запущенного экземпляра, API возвращает ошибку.

Параметры запроса:​

ПараметрТипФорматЗначение по умолчаниюОписание
profileIdstringuuid(required)Уникальный идентификатор профиля.
workspaceIdintegerint64-1Идентификатор рабочего пространства. Значение -1 означает рабочее пространство по умолчанию.

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

POST
CURL:

curl 'http://localhost:8160/v1/browser_instances/get_running?profileId=123e4567-e89b-12d3-a456-426614174000&workspaceId=-1' \
--request POST \
--header 'Api-Token: YOUR_SECRET_TOKEN'

C#:

var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("http://localhost:8160/v1/browser_instances/get_running?profileId=123e4567-e89b-12d3-a456-426614174000&workspaceId=-1"),
Headers =
{
{ "Api-Token", "YOUR_SECRET_TOKEN" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}

Cube:

http://localhost:8160/v1/browser_instances/get_running?profileId=123e4567-e89b-12d3-a456-426614174000&workspaceId=-1

Дополнительно:
User-Agent: {-Profile.UserAgent-}
Api-Token: токен из UserArea2.

Ответ API:​

Код ответаРезультат
200 OKУспешно
401 UnauthorizedНе авторизован
403 ForbiddenДоступ запрещен
409 ConflictДля указанного профиля нет запущенного экземпляра браузера
500 Internal Server ErrorВнутренняя ошибка сервера

Поля ответа:​

ПолеТипФорматОписание
connectionStringstringWebSocket-строка для подключения к браузеру по Chrome DevTools Protocol (CDP).
processIdintegerint32Идентификатор процесса (PID) браузера.
profileIdstringuuidУникальный идентификатор профиля.

Успешный ответ (200 OK):

{
"connectionString": "ws://127.0.0.1:12345/devtools/browser/example",
"processId": 1234,
"profileId": "123e4567-e89b-12d3-a456-426614174000"
}

Ответ с ошибкой (500):

{
"message": null
}