proxy.update

Описание

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

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

Параметры

(объект/массив) Свойства прокси, которые будут обновлены.

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

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

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

У узлов сети должно быть задано свойство hostid.
interface объект Интерфейс узла сети, который заменит существующий интерфейс у пассивного прокси.

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

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

Примеры

Изменение узлов сети наблюдаемых через прокси

Обновление прокси для наблюдения за двумя заданными узлами сети.

Запрос:

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

Ответ:

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

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

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

Запрос:

{
    "jsonrpc": "2.0",
    "method": "proxy.update",
    "params": {
        "proxyid": "10293",
        "host": "Active proxy",
        "status": "5"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Ответ:

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

Смотрите также

Исходный код

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