tags.php¶

В этой статье

• Методы API
• tags/add
• tags/clear
• tags/get
• tags/list
• tags/remove
• tags/search
• tags/search_user
• tags/show
• tags/values

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

Методы API¶

tags/add¶

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

HTTP-метод: POST

Параметры:

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

{
"result": "OK",
"action": "add",
"id": 123,
"component": "eq",
"component_id": 45,
"tag": "hostname",
"value": "my-server.com",
"extra": "",
"internal": 0
}

{
"code": -1,
"message": "DuplicateTagNameException: tag already exists"
}

tags/clear¶

Очищает теги компонента. Клиенты очищают только не-essential теги, администраторы могут очистить всё (кроме preset).

HTTP-метод: POST

Параметры:

curl -s "https://invapi.hostkey.ru/tags.php" -X POST \
--data "action=clear" \
--data "token=HOSTKEY_TOKEN" \
--data "id=45" \
--data "component=eq" \
--data "tag=all"

{
"result": "OK",
"action": "clear",
"id": 45,
"component": "eq",
"tags": [
{
"id": 10,
"tag": "example_tag"
}
]
}

{
"code": -1,
"message": "$module/$action: invalid server id"
}

tags/get¶

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

HTTP-метод: GET

Параметры:

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

{
"result": "OK",
"action": "get",
"data": {
"unknown": "example_value"
}
}

{
"code": -1,
"message": "Ошибка выполнения запроса"
}

tags/list¶

Возвращает список всех тегов, назначенных серверу или компоненту.

HTTP-метод: POST

Параметры:

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

{
"result": "OK",
"action": "list",
"tags": [
{
"id": 1,
"tag": "hostname",
"value": "srv-01.net"
},
{
"id": 2,
"tag": "os_type",
"value": "ubuntu"
}
]
}

{
"code": -1,
"message": "invalid server id"
}

tags/remove¶

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

HTTP-метод: POST

Параметры:

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

{
"result": "OK",
"action": "remove",
"id": 105,
"tag": "old_tag",
"component": "eq",
"component_id": 45
}

{
"code": -1,
"message": "tag old_tag not found for element 45 on eq"
}

tags/search¶

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

HTTP-метод: POST

Параметры:

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

{
"result": "OK",
"action": "search",
"tags": [
{
"id": 1,
"tag": "os",
"value": "debian",
"component_id": 45
}
]
}

{
"code": -2,
"message": "Invalid hash"
}

tags/search_user¶

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

HTTP-метод: POST

Параметры:

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": 10,
"name": "server-name"
},
{
"id": 11,
"name": "server-name-2"
}
]
}

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

tags/show¶

Метод не реализован (пустой)

HTTP-метод: POST

Параметры:

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": "Not implemented"
}

tags/values¶

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

HTTP-метод: POST

Параметры:

curl -s "https://invapi.hostkey.ru/tags.php" -X POST \
--data "action=values" \
--data "token=HOSTKEY_TOKEN" \
--data "component=eq" \
--data "tag=os"

{
"result": "OK",
"action": "values",
"component": "eq",
"tag": "os",
"values": [
"ubuntu",
"debian",
"centos"
]
}

{
"code": -1,
"message": "tag required"
}