hostinterface.update
説明
object hostinterface.update(object/array hostInterfaces)
このメソッドを使用すると、既存のホストインターフェースを更新できます。
このメソッドは、Admin および Super admin のユーザータイプでのみ利用できます。メソッドの呼び出し権限は、ユーザーロール設定で取り消すことができます。詳細は User roles を参照してください。
パラメータ
更新する(object/array)のホストインターフェースのプロパティです。
各ホストインターフェースにはinterfaceidプロパティを定義する必要があり、その他のプロパティはすべて任意です。指定されたプロパティのみが更新され、その他は変更されません。
戻り値
(object) interfaceidsプロパティの下で更新されたホストインターフェイスのIDを含むオブジェクトを返します。
例
ホストインターフェースのポートの変更
ホストインターフェースのポートを変更します。
{
"jsonrpc": "2.0",
"method": "hostinterface.update",
"params": {
"interfaceid": "30048",
"port": "10055"
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": {
"interfaceids": [
"30048"
]
},
"id": 1
}複数のホストインターフェースのポートを変更する
複数のホストインターフェースのポートを変更します。
{
"jsonrpc": "2.0",
"method": "hostinterface.update",
"params": [
{
"interfaceid": "30049",
"port": "10055"
},
{
"interfaceid": "30050",
"port": "10055"
},
{
"interfaceid": "30051",
"port": "10055"
}
],
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": {
"interfaceids": [
"30049",
"30050",
"30051"
]
},
"id": 1
}ソース
CHostInterface::update() in ui/include/classes/api/services/CHostInterface.php.