Peering Level API
Добро пожаловать в документацию по Peering Level API Teleport.
Этот раздел описывает управление настройками пиринга через API.
API позволяет получать и изменять параметры пиринга для API токенов Teleport.
Назначение
Peering Level API позволяет управлять параметрами пиринга для API токенов Teleport.
Настройки могут использоваться для:
- управления поведением загрузки через пиринг
- регулирования распределения трафика между CDN и P2P
- централизованного управления параметрами для нескольких токенов
- интеграции настроек пиринга во внешние системы управления инфраструктурой
Обязательные параметры запроса
Для работы с Peering Level API требуется API токен с разрешением peering-level.
| Параметр | Описание |
|---|---|
| X-Api-Token | API токен с разрешением peering-level |
Обязательные параметры
Если API токен отсутствует или не имеет разрешения peering-level, запрос выполнен не будет.
Ограничения
- операции API требуют действительного токена с разрешением peering-level
- токен может изменять настройки только для ключей, указанных при его создании
- значение настройки должно соответствовать параметрам, установленным системой
- значение настройки задаётся числом в диапазоне от 0 до 256
| Значение | Описание |
|---|---|
| 0 | пиринг отключён (0%) |
| 256 | пиринг используется без ограничений (100%) |
Логика работы
Peering Level API предоставляет следующие возможности:
| Операция | Описание |
|---|---|
| Получение списка настроек | возвращает список доступных параметров пиринга |
| Получение значения настройки | возвращает текущее значение настройки |
| Изменение настройки | обновляет значение настройки для выбранных ключей |