[comment]: # ({3a2a8d58-3a2a8d58})
# script.execute
[comment]: # ({/3a2a8d58-3a2a8d58})
[comment]: # ({ac5defee-60a9dbe3})
### 説明
`object script.execute(object parameters)`
このメソッドでは、ホストまたはイベントでスクリプトを実行できます。ただし、URLタイプのスクリプトは除きます。これらは実行できません。
::: noteclassic
このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。詳細は[ユーザーロール](/manual/web_interface/frontend_sections/users/user_roles)を参照してください。
:::
[comment]: # ({/ac5defee-60a9dbe3})
[comment]: # ({4a3ef91f-e4fa8ac7})
### パラメータ
`(object)` 実行するスクリプトのID、およびホストのIDまたはイベントのIDとmanualinput値を含むパラメータです。
|パラメータ|[Type](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|scriptid|ID|実行する[script](/manual/api/reference/script/object#script)のID。
[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):
- *required*|
|hostid|ID|スクリプトを実行する[ホスト](/manual/api/reference/host/object#host)のID。
[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):
- `eventid` が設定されていない場合は *required*|
|eventid|ID|スクリプトを実行する[event](/manual/api/reference/event/object#event)のID。
[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):
- `hostid` が設定されていない場合は *required*|
|manualinput|string|{MANUALINPUT} マクロを置換してスクリプトを実行するための、ユーザー指定の値。|
[comment]: # ({/4a3ef91f-e4fa8ac7})
[comment]: # ({abb1babb-dde54e60})
### 戻り値
`(object)` スクリプト実行の結果を返します。
|プロパティ|[型](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|response|string|スクリプトが正常に実行されたかどうか。
指定可能な値 - `success`。|
|value|string|スクリプトの出力。|
|debug|object|webhookスクリプトが実行された場合は、[debug](/manual/api/reference/script/object#debug) オブジェクトを含みます。その他のスクリプトタイプでは、空のオブジェクトを含みます。|
[comment]: # ({/abb1babb-dde54e60})
[comment]: # ({b41637d2-b41637d2})
### 例
[comment]: # ({/b41637d2-b41637d2})
[comment]: # ({89444531-03cb1cf3})
#### webhookスクリプトの実行
外部サービスにHTTPリクエストを送信するwebhookスクリプトを実行します。
[リクエスト](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "script.execute",
"params": {
"scriptid": "4",
"hostid": "30079"
},
"id": 1
}
```
レスポンス:
```json
{
"jsonrpc": "2.0",
"result": {
"response": "success",
"value": "{\"status\":\"sent\",\"timestamp\":\"1611235391\"}",
"debug": {
"logs": [
{
"level": 3,
"ms": 480,
"message": "[Webhook Script] HTTP status: 200."
}
],
"ms": 495
}
},
"id": 1
}
```
[comment]: # ({/89444531-03cb1cf3})
[comment]: # ({fc7b2309-baebff97})
#### カスタムスクリプトの実行
ホストで "ping" スクリプトを実行します。
[リクエスト](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "script.execute",
"params": {
"scriptid": "1",
"hostid": "30079"
},
"id": 1
}
```
レスポンス:
```json
{
"jsonrpc": "2.0",
"result": {
"response": "success",
"value": "PING 127.0.0.1 (127.0.0.1) 56(84) bytes of data.\n64 bytes from 127.0.0.1: icmp_req=1 ttl=64 time=0.074 ms\n64 bytes from 127.0.0.1: icmp_req=2 ttl=64 time=0.030 ms\n64 bytes from 127.0.0.1: icmp_req=3 ttl=64 time=0.030 ms\n\n--- 127.0.0.1 ping statistics ---\n3 packets transmitted, 3 received, 0% packet loss, time 1998ms\nrtt min/avg/max/mdev = 0.030/0.044/0.074/0.022 ms\n",
"debug": []
},
"id": 1
}
```
[comment]: # ({/fc7b2309-baebff97})
[comment]: # ({7ff793a4-dae60a2d})
#### 手動入力を使用してカスタムスクリプトを実行する
ホスト上で、コマンド `ping -c {MANUALINPUT} {HOST.CONN}; case $? in [01]) true;; *) false;; esac` を使用して "ping" スクリプトを実行します。
[リクエスト](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "script.execute",
"params": {
"scriptid": "7",
"hostid": "30079",
"manualinput": "2"
},
"id": 1
}
```
レスポンス:
```json
{
"jsonrpc": "2.0",
"result": {
"response": "success",
"value": "PING 127.0.0.1 (127.0.0.1) 56(84) bytes of data.\n64 bytes from 127.0.0.1: icmp_seq=1 ttl=64 time=0.051 ms\n64 bytes from 127.0.0.1: icmp_seq=2 ttl=64 time=0.025 ms\n\n--- 127.0.0.1 ping statistics ---\n2 packets transmitted, 2 received, 0% packet loss, time 1021ms\nrtt min/avg/max/mdev = 0.025/0.038/0.051/0.013 ms\n",
"debug": []
},
"id": 1
}
```
[comment]: # ({/7ff793a4-dae60a2d})
[comment]: # ({e7dc45a5-e7dc45a5})
### ソース
CScript::execute() in *ui/include/classes/api/services/CScript.php*.
[comment]: # ({/e7dc45a5-e7dc45a5})