tags.php¶

Модуль управления метками (tags) для компонентов инфраструктуры: добавление, удаление, очистка, поиск и отображение списков тегов для серверов и переменных.

Методы API¶

Метод	Действие	Описание
`add`	добавление тега	Добавляет пользовательский тег к серверу или компоненту. Поддерживает добавление к одному ID или списку ID через параметр id_list. Для клиентов доступны только определенные теги.
`clear`	очистка меток	Очищает все или неэссенциальные метки от компонента. Для клиентов доступны только публичные метки.
`get`	получение меток	Получает метки для компонента. (Реализация в коде пуста, метод в whitelist)
`list`	получение списка тегов	Возвращает список тегов для указанного сервера или компонента. Для клиентов доступны только публичные теги.
`remove`	удаление тега	Удаляет указанный тег с компонента (сервера) по имени тега. Поддерживает удаление с одного ID или списка ID через id_list.
`search`	поиск меток	Ищет компоненты, соответствующие конкретной метке и значению.
`search_user`	поиск оборудования пользователя	Ищет оборудование пользователя по значению метки. Используется в глобальной форме поиска.
`show`	показ возможных меток	Показывает возможные метки для компонента. (Реализация в коде пуста, метод в whitelist)

tags/add¶

Добавляет пользовательский тег к серверу или компоненту. Поддерживает добавление к одному ID или списку ID через параметр id_list. Для клиентов доступны только определенные теги.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add`
token	✅	string	Токен авторизации пользователя
id	❌	int	ID компонента (сервера). Используется если не передан id_list
id_list	❌	string	Список ID компонентов через запятую. Если передан, используется вместо id
tag	✅	string	Имя тега
value	❌	string	Значение тега
extra	❌	string	Дополнительные данные тега
component	❌	string	Тип компонента (по умолчанию eq)
component_id	❌	int	ID компонента (альтернатива id)
internal	❌	int	Флаг внутреннего тега (0 или 1)
no_log	❌	bool	Если установлено, не добавлять запись в лог

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

curl -s "https://invapi.hostkey.ru/tags.php" -X POST \
--data "action=add" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345" \
--data "tag=hostname" \
--data "value=my-server-01"

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

{
"result": "OK",
"action": "add",
"id": 12345,
"component": "eq",
"component_id": 100,
"tag": "hostname",
"value": "my-server-01",
"extra": "",
"internal": 0
}

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

``` { "code": -1, "message": "tag/add: invalid token data, too long" }

```

tags/clear¶

Очищает все или неэссенциальные метки от компонента. Для клиентов доступны только публичные метки.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `clear`
token	✅	string	Токен авторизации
id	✅	int	ID сервера (компонента)
component	❌	string	Тип компонента (по умолчанию 'eq')
tag	❌	string	Фильтр очистки. Если 'all', очищаются все метки, включая исключенные

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

curl -s "https://invapi.hostkey.ru/tags.php" -X POST \
--data "action=clear" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

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

{
"result": "OK",
"action": "clear",
"id": 101,
"component": "eq",
"tags": [
{
"id": 501,
"tag": "preset",
"value": "standard"
}
]
}

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

{
"code": -1,
"message": "tag/clear: invalid server status, can't clean tags from the rented server"
}

tags/get¶

Получает метки для компонента. (Реализация в коде пуста, метод в whitelist)

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get`
token	✅	string	Токен авторизации
component	❌	string	Тип компонента (eq, vars и т.д.)
component_id	❌	int	ID компонента
internal	❌	int	Флаг отображения внутренних меток (0 или 1)

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

curl -s "https://invapi.hostkey.ru/tags.php" -X POST \
--data "action=get" \
--data "token=HOSTKEY_TOKEN"

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

{
"result": "OK",
"action": "get",
"data": []
}

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

{
"code": -1,
"message": "Method not implemented"
}

tags/list¶

Возвращает список тегов для указанного сервера или компонента. Для клиентов доступны только публичные теги.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list`
token	✅	string	Токен аутентификации пользователя
id	❌	int	ID сервера или компонента. Для клиентов обязателен (>0), для админов опционален.
component	❌	string	Тип компонента (eq, vars). По умолчанию 'eq'.

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

curl -s "https://invapi.hostkey.ru/tags.php" -X POST \
--data "action=list" \
--data "token=HOSTKEY_TOKEN"

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

{
"result": "OK",
"action": "list",
"tags": [
{
"id": 101,
"tag": "os",
"value": "Ubuntu 22.04",
"extra": "",
"internal": 0,
"component": "eq",
"component_id": 1
}
]
}

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

``` { "code": -1, "message": "tag/list: invalid server id" }

```

tags/remove¶

Удаляет указанный тег с компонента (сервера) по имени тега. Поддерживает удаление с одного ID или списка ID через id_list.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "remove",
"id": 12345,
"tag": "hostname",
"component": "eq",
"component_id": 101
}

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

``` { "code": -1, "message": "tag/remove: tag hostname not found for element 101 on eq", "error": "tag/remove: tag hostname not found for element 101 on eq" }

```

tags/search¶

Ищет компоненты, соответствующие конкретной метке и значению.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `search`
token	✅	string	Токен авторизации
tag	❌	string	Название метки для поиска
value	❌	string	Значение метки для поиска (поддерживает LIKE)
component	❌	string	Тип компонента (по умолчанию eq)
internal	❌	int	Флаг отображения внутренних меток (0 или 1)

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

curl -s "https://invapi.hostkey.ru/tags.php" -X POST \
--data "action=search" \
--data "token=HOSTKEY_TOKEN" \
--data "tag=location" \
--data "value=NL"

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

{
"result": "OK",
"action": "search",
"tags": [
{
"id": 1001,
"component": "eq",
"component_id": 101,
"tag": "location",
"value": "NL",
"extra": "",
"internal": 0
}
]
}

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

{
"code": -1,
"message": "tag/search: invalid token $token, logout"
}

tags/search_user¶

Ищет оборудование пользователя по значению метки. Используется в глобальной форме поиска.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `search_user`
token	✅	string	Токен авторизации
value	✅	string	Значение метки для поиска оборудования пользователя

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

curl -s "https://invapi.hostkey.ru/tags.php" -X POST \
--data "action=search_user" \
--data "token=HOSTKEY_TOKEN" \
--data "value=VALUE"

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

{
"result": "OK",
"action": "search_user",
"servers": [
{
"id": 101,
"hostname": "server-01",
"ip": "192.168.1.1"
}
]
}

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

{
"code": -1,
"message": "tag/search_user: Nothing found for value"
}

tags/show¶

Показывает возможные метки для компонента. (Реализация в коде пуста, метод в whitelist)

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/tags.php" -X POST \
--data "action=show" \
--data "token=HOSTKEY_TOKEN"

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

{
"result": "OK",
"action": "show",
"data": []
}

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

{
"code": -1,
"message": "Method not implemented"
}