pythonによるzabbixのAPI方法について

Question

pythonでzabbixのAPIを使用し、データーの取得を行いたいのですが、
APIを利用するにあたり、認証トークンを取得、設定など

実際に具体的に何をどのようにすればいいのか、自分なりに以下のサイトなどで
調べても全く分からない状態です。

認証トークンの取得は、SSHでzabbixサーバーに接続して取得するものなのでしょうか？
（最初の段階で、本当に何をどうしたらよいのか分からない状態です。）

https://www.sraoss.co.jp/technology/zabbix/introduction/03-3rdstep/

https://www.zabbix.com/documentation/current/en/manual/api

https://devlog.arksystems.co.jp/2020/07/28/13168/

認証トークンの取得し、pythonでzabbixに接続する方法を教えてください。
（APIは、色々サイトを調べ情報を取得してくるためのURLというようなことは理解できております。）

Answer 1

「zabbix 認証トークン」で調べるといくつか解説サイトがでてきますが、それを参照されていますか？

こことか

こことか

取得方法については両方同じことが書いてありますが、これらでやりかたがわからなければ、また問い合わせください。

Comments

[退会済みユーザー]

回答ありがとうございます。

VScodeで以下のコードを書いて実行してみたのですが、
これでよろしいのでしょうか？

まず、何をすればよいのか、どの様なコードを書けば良いのかもわからない状態です。
ご紹介いただきましたサイト以外にも調べたのですが、user.loginメソッドを利用するということは
どこでも記載されているのですが、その前段階（zabbixサーバーに接続するコードなど、そもそもcurl -s -dのコマンドは、SSHでzabbixに接続、ログインし、zabbixサーバーで実行するのかなど）が分からない状態です。

```
# zabbixサーバーのIP：192.168.1.1

import json
import requests

url = "http://192.168.1.1/zabbix"

res = requests.get(url)
print(res) # 200 OK取得

curl -s -d '{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"user": "Admin",
"password": "testpw"
},
"id": 1,
"auth": null
}' -H "Content-Type: application/json-rpc" http://192.168.1.1/zabbix/api_jsonrpc.php
```

[退会済みユーザー]

すいません。
本当にどなたか教えてください。

[TakaiY]

(あら、コメント投稿したはずなのに消えている)

基本的に間違えています。

curl以下のコマンドは、pythonのコードではなく、コマンドプロンプトから実行するものです。
curlコマンドで検索すれば、それが何をするものなのかわかると思います。WebAPIやサイトとコマンドラインでやりとりするためのコマンドです。

[退会済みユーザー]

コマンドプロンプトで以下コマンドを実行しました。

curl -s -d '{ "jsonrpc": "2.0","method": "user.login","params": { "user": "admin","testpw": "mgrnissuic0n"},"id": 1,"auth": null}' -H "Content-Type: application/json-rpc" http://192.168.1.1/zabbix/api_jsonrpc.php

レスポンスとして以下が返ってきました。書式が間違っていると、エラーです。
{"jsonrpc":"2.0","error":{"code":-32700,"message":"Parse error","data":"Invalid JSON. An error occurred on the server while parsing the JSON text."},"id":null}

一体、どこがちがうのでしょう？？

[退会済みユーザー]

以下の様に変更したらエラーが解消しました。

curl -X POST -H "Content-Type: application/json-rpc" -d "{\"jsonrpc\": \"2.0\",\"method\": \"apiinfo.version\",\"id\": 1,\"auth\": null,\"params\":{}}" http://192.168.1.1/zabbix/api_jsonrpc.php
実行結果メッセージ↓
{"jsonrpc":"2.0","result":"5.0.18","id":1}

’（シングルコーテーション）を”（ダブルコーテーション）に変更して、
JSONデータの”（ダブルコーテーション）をデータとして判断されるように、￥（バックスラッシュ）でエスケープさせました。

その結果、以下のメッセージが表示されました。これでトークンは取得できているのでしょうか？
{"jsonrpc":"2.0","result":"5.0.18","id":1}

ここから、どうしたら良いのでしょうか？

[TakaiY]

直前のコメントのコマンドはどこから取ってきたものですか？
\"method\": \"apiinfo.version\"
となっているので、バージョンの問い合わせですね。
で、答えが、
"result":"5.0.18"
ですから、ちゃんと通信できてますね。 でもこれはトークンではありません。

2つまえのコメントの内容であれば、トークンが返ってくると思うので、そちらで試してみてください。

[退会済みユーザー]

zabbix_server -V
zabbix_server (Zabbix) 5.0.18

\"method\": \"user.login にして
こちらのコマンドを試したのですが、どうしてもエラーになってしまいます。
'''
curl -X POST -d '{\"jsonrpc\": \"2.0\",\"method\": \"user.login\",\"params\": { \"user\": \"admin\",\"password\": \"testpw\"},\"id\": 1,\"auth\": null}' -H "Content-Type: application/json-rpc" http://192.168.1.1/zabbix/api_jsonrpc.php
'''

'''
curl: (6) Could not resolve host: "2.0","method"
curl: (6) Could not resolve host: "user.login","params"
curl: (3) [globbing] unmatched brace in column 1
curl: (6) Could not resolve host: "user"
curl: (6) Could not resolve host: "root","password"
curl: (3) [globbing] unmatched close brace/bracket in column 15
curl: (6) Could not resolve host: 1,"auth"
curl: (3) [globbing] unmatched close brace/bracket in column 5
{"jsonrpc":"2.0","error":{"code":-32700,"message":"Parse error","data":"Invalid JSON. An error occurred on the server while parsing the JSON text."},"id":null}
'''

[TakaiY]

エラーを見ると、
・ -dオプションの引数である文字列がかたまりとして認識されておらず、途中から引数として認識されてしまっていて、「そんなホストはない(Could not resolve host)」とされている
・「{}」の対応がおかしい([globbing] unmatched brace)と出ている
・最後にJSONデータが壊れていると出てくる
なので、コマンドの文字列がちゃんと認識されていませんね。

2つまえのコメントに「（シングルコーテーション）を”（ダブルコーテーション）に変更し」たらうまくいったのであれば、これについても同様にしてみたらどうでしょうか。

[退会済みユーザー]

{}やエスケープ処理を修正しましたが、ダメです。

curl -X POST -d '{\"jsonrpc\": \"2.0\",\"method\": \"user.login\",\"params\": {{ \"user\": \"admin\",\"password\": \"testpw\"},\"id\": 1,\"auth\": null}' -H \"Content-Type: application/json-rpc\" http://192.168.1.1/zabbix/api_jsonrpc.php

curl: (6) Could not resolve host: "2.0","method"
curl: (6) Could not resolve host: "user.login","params"
curl: (3) [globbing] nested brace in column 2
curl: (6) Could not resolve host: "user"
curl: (6) Could not resolve host: "root","password"
curl: (3) [globbing] unmatched close brace/bracket in column 15
curl: (6) Could not resolve host: 1,"auth"
curl: (3) [globbing] unmatched close brace/bracket in column 5
curl: (6) Could not resolve host: application

[TakaiY]

もういちど書きますね。
「（シングルコーテーション）を”（ダブルコーテーション）に変更し」たらうまくいったのであれば、これについても同様にしてみたらどうでしょうか。

[退会済みユーザー]

「（シングルコーテーション）を”（ダブルコーテーション）に変更してもダメなようです・

実行コマンド↓
curl -X POST -d "{\"jsonrpc\": \"2.0\",\"method\": \"user.login\",\"params\": {{ \"user\": \"admin\",\"password\": \"testpw\"},\"id\": 1,\"auth\": null}" -H \"Content-Type: application/json-rpc\" http://192.168.1.1/zabbix/api_jsonrpc.php

結果↓
curl: (6) Could not resolve host: application

[退会済みユーザー]

コピペではなく、コマンドプロンプトに手で入力し、全てダブルコーテーションにし、エスケープしてみましたがダメです。

curl -X POST -d \"\{\"jsonrpc\":\"2.0\",\"method\":\"user.login\",\"params\":\{\{\"user\":\"admin\",\"password\":\"testpw\"\}\",\"id\":1,\"auth\":null\} -H Content-Type:application/json-rpc http://192.168.1.1/zabbix/api_jsonrpc.php

実行結果
{"jsonrpc":"2.0","error":{"code":-32700,"message":"Parse error","data":"Invalid JSON. An error occurred on the server while parsing the JSON text."},"id":null}

[TakaiY]

「H \"Content-Type: application/json-rpc\"」
ここの、ダブルクオーテーションをエスケープしてはいけません。

H "Content-Type: application/json-rpc"

エスケープするのは、文字列の中にあるダブル/シングルクオーテーションを文字列に含めるためですから。

[退会済みユーザー]

H "Content-Type: application/json-rpc" として実行しましたが、エラーとなってしまいます。

```
curl -X POST -d \"\{\"jsonrpc\":\"2.0\",\"method\":\"user.login\",\"params\":\{\{\"user\":\"admin\",\"password\":\"testpw\"\}\",\"id\":1,\"auth\":null\}\" -H "Content-Type:application/json-rpc" http://192.168.1.1/zabbix/api_jsonrpc.php
```

```
{"jsonrpc":"2.0","error":{"code":-32700,"message":"Parse error","data":"Invalid JSON. An error occurred on the server while parsing the JSON text."},"id":null}
```

[退会済みユーザー]

こちらの記事も確認しましたが、今まで試してきたことが書かれているだけで
他に手がかりになりそうな情報が無いです。とにかく、調べまくっていますが、
どうしてもエラーが解消できない状況が続いております。

https://plaza.rakuten.co.jp/taro3chidayo/diary/202006100000/

[TakaiY]

エラーを見ると、JSONとして間違えているとありますね。

ちょっと見たところでは、 params の後 「{ 」が 2つありますが、ここは 1つでしょう。

他は見てませんが、あらためて確認するか、作りなおしてみては。

[退会済みユーザー]

params の後 「{ 」が 2つありますが、ここは 1つでしょう。を修正しましたが、やはりエラーとなってしまいます。

'
curl -X POST -d \"\{\"jsonrpc\":\"2.0\",\"method\":\"user.login\",\"params\":\{\"user\":\"admin\",\"password\":\"testpw\"\}\",\"id\":1,\"auth\":null\}\" -H "Content-Type:application/json-rpc" http://192.168.1.1/zabbix/api_jsonrpc.php
'

```
{"jsonrpc":"2.0","error":{"code":-32700,"message":"Parse error","data":"Invalid JSON. An error occurred on the server while parsing the JSON text."},"id":null}
```

[TakaiY]

「あらためて確認」してるのでしょうか。

testpw\"\}\",

少なくともこの最後にある \" は不要です。

あと、以前メソッドは間違えていたけれども通信はできたもの

"{\"jsonrpc\": \"2.0\",\"method\": \"apiinfo.version\",\"id\": 1,\"auth\": null,\"params\":{}}"

今回のもの

\"\{\"jsonrpc\":\"2.0\",\"method\":\"user.login\",\"params\":\{\"user\":\"admin\",\"password\":\"testpw\"\}\",\"id\":1,\"auth\":null\}\"

くらべてみると、いつからついているのかわかりませんが、 {}の前に\が入っています。
取り除いてみては？

[退会済みユーザー]

ご指摘ありがとうございます。
以下2点を対応しましたが、やはりエラーとなってしまいます。。。

testpw\"\}\",　→　\" は不要です

{}の前に\が入っています。　→　取り除いてみては？

'''
curl -X POST -d '{\"jsonrpc\":\"2.0\",\"method\":\"user.login\",\"params\":{\"user\":\"admin\",\"password\":\"testpw\"},\"id\":1,\"auth\":null}' -H "Content-Type:application/json-rpc" http://192.168.1.1/zabbix/api_jsonrpc.php
'''

'''
{"jsonrpc":"2.0","error":{"code":-32700,"message":"Parse error","data":"Invalid JSON. An error occurred on the server while parsing the JSON text."},"id":null}
'''

[TakaiY]

-d のオプションを「'」で囲っているとはじかれるということで「"」に変更したのではなかったでしょうか？
-d '{\"js
":null}' -H
「'」になってます。

「'」でうまくいくのであれば、"の前の\は不要です。 「"」でやるなら\は必要です。

[退会済みユーザー]

何度も申し訳ありません。

-d \"{ }\" の形に戻しました。

実行してみると、今度は、違うエラーが表示されました。

‘‘‘
curl -X POST -d "\{\"jsonrpc\":\"2.0\",\"method\":\"user.login\",\"params\":\{\"user\":\"admin\",\"password\":\"testpw\"\}\}",\"id\":1,\"auth\":null\}" -H "Content-Type:application/json-rpc" http://192.168.1.1/zabbix/api_jsonrpc.php
’’’

’’’
curl: no URL specified!
curl: try 'curl --help' for more information
’’’

[TakaiY]

{}の前の\が復活してますね。
他のところもちゃんと確認ください。

途中の文字列がおかしくなっていて最後のURLが判別できなくなっているために起きているエラーです。

[TakaiY]

・元のコマンドを用意する
・-dオプション引数の中にある「"」の前に\を付ける
・-dオプションの引数を囲む「'」を「"」に変更する。\は付けない
だけだと思いますが。

[退会済みユーザー]

ご指摘いただきました下記3つを確認し、実行しましたが、どうしてもエラーとなってしまいます。
・元のコマンドを用意する
・-dオプション引数の中にある「"」の前に\を付ける
・-dオプションの引数を囲む「'」を「"」に変更する。\は付けない

'''
curl -X POST -d "{\"jsonrpc\":\"2.0\",\"method\":\"user.login\",\"params\":{\"user\":\"admin\",\"password\":\"testpw\"}",\"id\":1,\"auth\":null} -H "Content-Type:application/json-rpc" http://192.168.1.1/zabbix/api_jsonrpc.php
'''

'''
{"jsonrpc":"2.0","error":{"code":-32602,"message":"Invalid params.","data":"Incorrect user name or password or account is temporarily blocked."},"id":1}
'''

[TakaiY]

エラーの中身見てますか？

"Incorrect user name or password or account is temporarily blocked."
今度は「ユーザ名とパスワードが違う、もしくは、アカウントがブロックされている」と言われてます。 確認ください。

まあ、コマンドは通るようになったってことなので、進みましたね。

[退会済みユーザー]

一応、user:admin passwrod:testpw でSSH接続可能なこと、ルート権限があることを確認しました。

[退会済みユーザー]

できました！！
トークンの取得が無事できました。

実行コマンド
’’’
curl -X POST -d "{\"jsonrpc\":\"2.0\",\"method\":\"user.login\",\"params\":{\"user\":\"root\",\"password\":\"testpw\"},\"id\":1,\"auth\":null}" -H "Content-Type:application/json-rpc" http://192.168.1.1/zabbix/api_jsonrpc.php

'''

お付き合いいただき、本当にありがとうございました。