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

Получение списка папок прокси

Описание: Этот метод используется для получения списка папок прокси. Поддерживается фильтрация, сортировка и разбиение результатов на страницы. Дополнительные параметры запроса позволяют уточнить набор возвращаемых данных. Если параметры не указаны, метод возвращает первую страницу папок прокси в порядке сортировки по умолчанию.

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

ParameterTypeFormatDefaultDescription
workspaceIdintegerint64-1Идентификатор рабочего пространства. -1 означает рабочее пространство по умолчанию.
startintegerint320Индекс первой папки для возврата (отсчёт с нуля)
totalintegerint321000Максимальное количество возвращаемых результатов
idstringuuid(empty)Фильтрация по определённому идентификатору папки
namestring(empty)Фильтрация по имени папки
sortingstring(empty)Условие сортировки результатов
locationstring (enum)(empty)Фильтр по типу прокси (Local или Cloud)

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

GET
CURL:

curl 'http://localhost:8160/v1/proxy_folders?workspaceId=&start=&total=&id=&name=&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/proxy_folders?workspaceId=&start=&total=&id=&name=&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/proxy_folders?workspaceId=&start=&total=&id=&name=&sorting=&=

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

Ответ API:

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

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

{
"totalCount": 1,
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": null,
"location": "Local",
"quantity": 1
}
]
}

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

{
"message": null
}