proxy.update

Описание

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

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

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

Параметры

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

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

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

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

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

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

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

Примеры

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

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

Запрос:

{
    "jsonrpc": "2.0",
    "method": "proxy.update",
    "params": {
        "proxyid": "10293",
        "hosts": [
            {
                "hostid": "10294"
            },
            {
                "hostid": "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
}

Add a proxy to a proxy group

Update proxy with ID "5" and add it to proxy group with ID "1".

Request:

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

Response:

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

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

Источник

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