このページで
connector.update
説明
object connector.update(object/array connectors)
このメソッドは、既存のコネクタを更新することができます。
このメソッドは、Super adminタイプのユーザーのみ利用可能です。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。
パラメーター
(object/array) 更新されるコネクタのプロパティ。
connectoridプロパティはコネクタごとに定義する必要があり、すべてのプロパティはオプションです。 渡されたプロパティのみが更新され、他のプロパティは変更されません。
標準のコネクタプロパティに加えて、このメソッドは次のパラメーターをサポートします。
戻り値
(object) connectoridsプロパティの下にある、更新されたコネクタのIDを含むオブジェクトを返します。
例
HTTP認証タイプの変更
ID "3"のコネクタのHTTP認証タイプをベアラーに変更します。
{
"jsonrpc": "2.0",
"method": "connector.update",
"params": {
"connectorid": 3,
"authtype": 5,
"token": "{$DATA_EXPORT_BEARER_TOKEN}"
},
"id": 1
}
レスポンス:
{
"jsonrpc": "2.0",
"result": {
"connectorids": [
"3"
]
},
"id": 1
}
タグフィルターの更新
ID "5"のコネクタのタグフィルターを変更します。
{
"jsonrpc": "2.0",
"method": "connector.update",
"params": [
{
"connectorid": 5,
"tags_evaltype": 2,
"tags": [
{
"tag": "service",
"operator": 0,
"value": "mysqld"
},
{
"tag": "error",
"operator": 12,
"value": ""
}
]
}
],
"id": 1
}
レスポンス:
{
"jsonrpc": "2.0",
"result": {
"connectorids": [
"5"
]
},
"id": 1
}
ソース
CConnector::update() in ui/include/classes/api/services/CConnector.php.