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

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

Описание: Этот метод возвращает список браузерных процессов, доступных для текущего пользователя, с подробной информацией.
Результаты можно отфильтровать по ID профиля или ID процесса, а также при необходимости отсортировать или ограничить по количеству возвращаемых записей.

warning

Эти действия применяются только к экземплярам браузера, запущенным через API.

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

ParameterTypeFormatDefaultDescription
workspaceIdintegerint64-1Идентификатор рабочего пространства. -1 означает рабочее пространство по умолчанию.
startintegerint320Начальный индекс для постраничного вывода
totalintegerint321000Максимальное количество результатов для возврата
profileIdstringuuid(empty)Фильтр по ID профиля (опционально).
processIdintegerint32(empty)Фильтр по ID процесса браузера (опционально).
sortingstring(empty)Параметры сортировки: ConnectionString, ProcessId, ProfileId (опционально).

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

GET
CURL:

curl 'http://localhost:8160/v1/browser_instances?workspaceId=-1&start=0&total=1000&profileId=&processId=&sorting=' \
--header 'Api-Token: YOUR_SECRET_TOKEN'

C#:

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("http://localhost:8160/v1/browser_instances?workspaceId=-1&start=0&total=1000&profileId=&processId=&sorting="),
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?workspaceId=-1&start=0&total=1000&profileId=&processId=&sorting=

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

Ответ API:

Response codeResult
200 OKУспешно
500 ErrorВнутренняя ошибка сервера

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

{
"totalCount": 1,
"items": [
{
"profileId": "123e4567-e89b-12d3-a456-426614174000",
"processId": 1,
"connectionString": null
}
]
}

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

{
"message": null
}