connector.create
説明
object connector.create(object/array connectors)
このメソッドを使用すると、新しいコネクタオブジェクトを作成できます。
このメソッドは、Super admin ユーザータイプでのみ利用できます。メソッドの呼び出し権限は、ユーザーロール設定で取り消すことができます。 詳細は User roles を参照してください。
パラメータ
(object/array) 作成するコネクタオブジェクト。
標準のコネクタプロパティに加えて、このメソッドは以下のパラメータを受け付けます。
| パラメータ | Type | 説明 |
|---|---|---|
| tags | array | コネクタのtag filter。 |
戻り値
(object) connectoridsプロパティの下に作成されたコネクタのIDを含むオブジェクトを返します。返されるIDの順序は、渡されたコネクタの順序と一致します。
例
コネクタの作成
タグフィルターを使用してトリガーイベントをエクスポートするためのコネクタを作成します。HTTP認証はBearerトークンを使用して実行されます。
{
"jsonrpc": "2.0",
"method": "connector.create",
"params": [
{
"name": "Export of events",
"data_type": 1,
"url": "{$DATA_EXPORT_URL}",
"authtype": 5,
"token": "{$DATA_EXPORT_BEARER_TOKEN}",
"tags": [
{
"tag": "service",
"operator": 0,
"value": "mysqld"
}
]
}
],
"id": 1
}
レスポンス:
{
"jsonrpc": "2.0",
"result": {
"connectorid": [
"3"
]
},
"id": 1
}
ソース
CConnector::create() in ui/include/classes/api/services/CConnector.php.