proxy.update

Description

object proxy.update(object/array proxies)

Cette méthode permet de mettre à jour des proxies existants.

Cette méthode est disponible uniquement pour le type d’utilisateur Super admin. Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir User roles pour plus d’informations.

Paramètres

(object/array) Propriétés du proxy à mettre à jour.

La propriété proxyid doit être définie pour chaque proxy, toutes les autres propriétés sont facultatives. Seules les propriétés transmises seront mises à jour, toutes les autres resteront inchangées.

En plus des propriétés de proxy standard, la méthode accepte les paramètres suivants.

Paramètre Type Description
hosts array Hôtes à surveiller par le proxy.
Si un hôte est déjà surveillé par un autre proxy, il sera réaffecté au proxy actuel.

Les hôtes doivent avoir uniquement la propriété hostid définie.

Valeurs de retour

(object) Renvoie un objet contenant les ID des proxys mis à jour dans la propriété proxyids.

Exemples

Modifier les hôtes surveillés par un proxy

Mettez à jour le proxy afin qu’il surveille les deux hôtes indiqués.

Requête:

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

Réponse :

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

Modifier le statut du proxy

Modifiez le proxy pour en faire un proxy actif et renommez-le en « Active proxy ».

Requête :

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

Réponse :

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

Ajouter un proxy à un groupe de proxys

Mettez à jour le proxy avec l’ID « 5 » et ajoutez-le au groupe de proxys avec l’ID « 1 ».

Requête :

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

Réponse :

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

Voir aussi

Source

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