proxy.update

Описание

object proxy.update(object/array proxies)

Этот метод позволяет обновлять существующие прокси.

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

Параметры

(object/array) Свойства прокси, которые необходимо обновить.

Для каждого прокси необходимо определить свойство proxyid; все остальные свойства являются необязательными. Будут обновлены только переданные свойства, а все остальные останутся без изменений.

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

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

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

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

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

Примеры

Изменение узлов сети, контролируемых прокси

Обновите прокси, чтобы он контролировал два указанных узла сети.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "proxy.update",
    "params": {
        "proxyid": "10293",
        "hosts": [
            {
                "hostid": "10294"
            },
            {
                "hostid": "10295"
            }
        ]
    },
    "id": 1
}

Ответ:

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

Изменение статуса прокси

Измените прокси на активный прокси и переименуйте его в "Active proxy".

Запрос:

{
    "jsonrpc": "2.0",
    "method": "proxy.update",
    "params": {
        "proxyid": "10293",
        "name": "Active proxy",
        "operating_mode": "0"
    },
    "id": 1
}

Ответ:

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

Добавление прокси в группу прокси

Обновите прокси с ID "5" и добавьте его в группу прокси с ID "1".

Запрос:

{
    "jsonrpc": "2.0",
    "method": "proxy.create",
    "params": {
        "proxyid": "5",
        "proxy_groupid": "1",
        "local_address": "127.0.0.1"
    },
    "id": 1
}

Ответ:

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

См. также

Источник

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