hostinterface.update

説明

object hostinterface.update(object/array hostInterfaces)

このメソッドは、既存のホストインターフェースを更新することができます。

このメソッドは、AdminおよびSuper adminタイプのユーザーのみ利用可能です。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。

パラメータ

(object/array) ホストインターフェースのプロパティが更新されます。

interfaceidプロパティは、ホストインターフェイスごとに定義する必要があり、他のすべてのプロパティはオプションです。指定されたプロパティのみが更新され、他のプロパティは変更されません。

戻り値

(object) interfaceidsプロパティの下で更新されたホストインターフェイスのIDを含むオブジェクトを返します。

例

ホストインターフェースポートの変更

ホストインターフェースのポートを変更します。

リクエスト:

{
           "jsonrpc": "2.0",
           "method": "hostinterface.update",
           "params": {
               "interfaceid": "30048",
               "port": "30050"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

レスポンス:

{
           "jsonrpc": "2.0",
           "result": {
               "interfaceids": [
                   "30048"
               ]
           },
           "id": 1
       }

ソース

CHostInterface::update() in ui/include/classes/api/services/CHostInterface.php.

Documentation

hostinterface.update

説明

パラメータ

戻り値

例

ホストインターフェースポートの変更

ソース