proxy.create

Описание

object proxy.create(object/array proxies)

Этот метод позволяет создавать новые прокси.

Этот метод доступен только пользователю типа Super admin. Разрешения на вызов метода могут быть отозваны в настройках роли пользователя. Дополнительную информацию см. в разделе Роли пользователей.

Параметры

(object/array) Прокси для создания.

Помимо стандартных свойств прокси, метод принимает следующие параметры.

Параметр Тип Описание
hosts array Узлы сети, которые должны отслеживаться прокси.
Если узел сети уже отслеживается другим прокси, он будет переназначен текущему прокси.

Узлы сети должны иметь только свойство hostid.
apm object Настройки мониторинга производительности приложений (APM) прокси.

Возвращаемые значения

(object) Возвращает объект, содержащий идентификаторы созданных прокси в свойстве proxyids. Порядок возвращаемых идентификаторов соответствует порядку переданных прокси.

Примеры

Создание активного прокси

Создайте активный прокси "Active proxy" и назначьте ему узел сети для мониторинга.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "proxy.create",
    "params": {
        "name": "Active proxy",
        "operating_mode": "0",
        "hosts": [
            {
                "hostid": "10279"
            }
        ]
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "proxyids": [
            "10280"
        ]
    },
    "id": 1
}

Создание пассивного прокси

Создайте пассивный прокси "Passive proxy" и назначьте ему два узла сети для мониторинга.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "proxy.create",
    "params": {
        "name": "Passive proxy",
        "operating_mode": "1",
        "address": "127.0.0.1",
        "port": "10051",
        "hosts": [
            {
                "hostid": "10192"
            },
            {
                "hostid": "10139"
            }
        ]
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "proxyids": [
            "10284"
        ]
    },
    "id": 1
}

Создание прокси и добавление его в группу прокси

Создайте активный прокси "Active proxy" и добавьте его в группу прокси с ID "1".

Запрос:

{
    "jsonrpc": "2.0",
    "method": "proxy.create",
    "params": {
        "name": "Active proxy",
        "proxy_groupid": "1",
        "operating_mode": "0"
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "proxyids": [
            "5"
        ]
    },
    "id": 1
}

Создание прокси с шифрованием на основе сертификатов

Создайте активный прокси с шифрованием на основе сертификатов. Прокси настроен на мониторинг узла сети "10785".

Запрос:

{
    "jsonrpc": "2.0",
    "method": "proxy.create",
    "params": {
        "name": "Active proxy",
        "operating_mode": "0",
        "hosts": [
            {
                "hostid": "10785"
            }
        ],
        "tls_accept": "4",
        "tls_issuer": "CN=Signing CA,OU=Development group,O=Zabbix SIA,DC=zabbix,DC=com",
        "tls_subject": "CN=Zabbix server,OU=Development group,O=Zabbix SIA,DC=zabbix,DC=com"
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "proxyids": [
            "2"
        ]
    },
    "id": 1
}

Создание прокси с включенным APM

Создайте активный прокси «Active proxy» с включенным APM. Прокси принимает до 1000 сообщений в секунду, добавляет атрибут ресурса deployment.environment к трассировкам и атрибут ресурса cloud.region к метрикам.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "proxy.create",
    "params": {
        "name": "Active proxy",
        "operating_mode": "0",
        "apm": {
            "data_collection_status": "1",
            "max_messages_per_second": "1000",
            "additional_resource_attributes": [
                {
                    "key": "deployment.environment",
                    "value": "production",
                    "signal_type": "0"
                },
                {
                    "key": "cloud.region",
                    "value": "eu-central-1",
                    "signal_type": "1"
                }
            ]
        }
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "proxyids": [
            "3"
        ]
    },
    "id": 1
}

См. также

Источник

CProxy::create() в ui/include/classes/api/services/CProxy.php.