traffic_plans.php¶

В этой статье

Методы API

traffic_plans/add

traffic_plans/list

traffic_plans/remove

traffic_plans/update

Модуль управления тарифными планами трафика: просмотр доступных планов с учетом параметров сервера или локации, добавление, удаление и обновление планов

Методы API¶

Метод	Действие	Описание
`add`	добавление тарифа	Создает новый тарифный план трафика с заданными лимитами и стоимостью.
`list`	получение списка тарифов	Возвращает список тарифных планов, подходящих для конкретного сервера (по ID) или доступных в определенной локации.

traffic_plans/add¶

Создает новый тарифный план трафика с заданными лимитами и стоимостью.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add`
token	✅	string	Токен авторизации
name	✅	string	Название тарифного плана.
active	❌	integer	Статус активности тарифа. По умолчанию 1.
locations	✅	string	Список локаций для тарифа.
limit_in	❌	integer	Лимит входящего трафика. По умолчанию 999.
limit_out	❌	integer	Лимит исходящего трафика. По умолчанию 999.
rate_in	❌	number	Стоимость входящего трафика. По умолчанию 0.
rate_out	❌	number	Стоимость исходящего тарифа. По умолчанию 0.
bandwidth	❌	integer	Пропускная способность канала. По умолчанию 1000.
currency_id	✅	integer	ID валюты.
web_plan	❌	string	Связанный веб-план. По умолчанию 0.
price	❌	number	Цена тарифа. По умолчанию 0.
main_plan	❌	string	Основной тарифный план.
location	❌	string	Географическое положение или локация для размещения тарифного плана.

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

curl -s "https://invapi.hostkey.ru/traffic_plans.php" -X POST \
--data "action=add" \
--data "token=HOSTKEY_TOKEN" \
--data "name=Example Plan" \
--data "locations=NL,US" \
--data "currency_id=1"

Пример успешного ответа

{
"result": "OK",
"action": "add",
"active": 1,
"bandwidth": 1000,
"currency_id": 1,
"limit_in": 500,
"limit_out": 500,
"locations": "NL",
"main_plan": "standard",
"price": 49.99,
"rate_in": 0.1,
"rate_out": 0.2,
"web_plan": "basic"
}

Примеры ошибок

{
"code": -1,
"message": "traffic plans add: traffic plan example already exists"
}

traffic_plans/list¶

Возвращает список тарифных планов, подходящих для конкретного сервера (по ID) или доступных в определенной локации.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list`
id	❌	integer	ID сервера для подбора подходящих тарифов.
location	❌	string	Локация (название или ID) для получения всех доступных планов в этом регионе.
vm	❌	integer	Флаг наличия виртуальной машины (1 — да, 0 — нет).
bm	❌	integer	Флаг наличия выделенного сервера (1 — да, 0 — нет).
gpu	❌	integer	Флаг наличия графического процессора (1 — да, 0 — нет).
vgpu	❌	integer	Флаг наличия виртуального графического процессора (1 — да, 0 — нет).
ten_gig	❌	integer	Флаг наличия интерфейса со скоростью 10 Гбит/с.
exclude_list	❌	`array<string>`	Список ID тарифных планов, которые необходимо исключить из выдачи.
all_tags	❌	`array<string>`	Набор тегов для фильтрации тарифных планов.
email	❌	string	Email пользователя для проверки приватности тарифов.
traffic_plans	✅	`array`	Параметр `traffic_plans`
instance	❌	integer	Идентификатор пресета для фильтрации подходящих тарифных планов.

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

curl -s "https://invapi.hostkey.ru/traffic_plans.php" -X POST \
--data "action=list" \
--data "id=123" \
--data "location=NL" \
--data "exclude_list[]=10" \
--data "exclude_list[]=11" \
--data "traffic_plans[]=plan1"

Пример успешного ответа

{
"result": "OK",
"action": "list",
"traffic_plans": [
{
"id": 123,
"name": "Standard Plan",
"active": true,
"location": "NL",
"locations": "Amsterdam",
"price": 49.99,
"billing_plan": {
"EUR": 49.99,
"USD": 58.78
},
"limit_in": 1000,
"limit_out": 1000,
"rate_in": 0.01,
"rate_out": 0.02,
"bandwidth": 1000,
"currency_id": 0,
"tags": [
{
"tag": "vds",
"value": "true"
}
]
}
]
}

Примеры ошибок

{
"code": -1,
"message": "$module/$action: location or server id required"
}

traffic_plans/remove¶

Удаляет существующий тарифный план по его ID.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `remove`
token	✅	string	Токен авторизации
id	✅	integer	ID удаляемого тарифного плана.

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

curl -s "https://invapi.hostkey.ru/traffic_plans.php" -X POST \
--data "action=remove" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Пример успешного ответа

{
"result": "OK",
"action": "remove",
"id": 123
}

Примеры ошибок

{
"code": -1,
"message": "traffic plans remove: error during deletion"
}

traffic_plans/update¶

Обновляет параметры существующего тарифного плана.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: update
token	✅	string	Токен авторизации
id	✅	integer	ID обновляемого тарифного плана.
name	❌	string	Новое название тарифа.
active	❌	integer	Статус активности.
locations	❌	string	Список локаций.
limit_in	❌	integer	Лимит входящего трафика.
limit_out	❌	integer	Лимит исходящего трафика.
rate_in	❌	number	Стоимость входящего трафика.
rate_out	❌	number	Стоимость исходящего трафика.
bandwidth	❌	integer	Пропускная способность.
currency_id	❌	integer	ID валюты.
web_plan	❌	string	Связанный веб-план.
price	❌	number	Цена тарифа.
main_plan	❌	string	Основной тарифный план.

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

curl -s "https://invapi.hostkey.ru/traffic_plans.php" -X POST \
--data "action=update" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "name=New Plan Name" \
--data "active=1"

Пример успешного ответа

{
"result": "OK",
"action": "update",
"id": 123,
"name": "Updated Plan",
"active": 1,
"locations": "US,EU",
"limit_in": 100,
"limit_out": 100,
"rate_in": 0.5,
"rate_out": 0.5,
"bandwidth": 1000,
"currency_id": 1,
"web_plan": "basic",
"price": 10.0,
"main_plan": "standard"
}

Примеры ошибок

{
"code": -1,
"message": "traffic plans update: failed to update traffic plan example"
}