proxy.update

Описание

object proxy.update(объект/массив proxies)

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

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

Параметры

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

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

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

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

Для узлов сети должно быть определено только свойство hostid.

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

(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.