AddMonitor API――Webサーバー/サービス

このページでは、AddMonitor APIで、カテゴリ タイプ「Webサーバー/サービス」の監視を追加する方法を説明します。製品では次の監視をサポートします。

Apacheサーバー

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME] &host=[HOST]&port=[PORT]&serverstatusurl=[SERVER_STATUS_URL]&apacheurl=[APACHE_URL]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。

フィールド 説明
type 追加する監視のタイプです。値はApache Serverにしてください。
host Apacheサーバーを実行しているホストの名前です。
port Apacheサーバーが動作するポート番号です。
apacheauth Apacheサーバーで認証を必要とするかを示します。trueかfalseを指定してください。
apacheUserName Apacheサーバーのユーザー名です。こちらは、apacheauthをtrueにしている場合のみ指定します。
apachepassword Apacheサーバーのパスワードです。こちらは、apacheauthをtrueにしている場合のみ指定します。
sslenabled SSLを有効にするか否かを示します。onかoffを指定してください。
serverstatusurl Apacheサーバー ステータスURLを変更可能にするかを示します。trueかfalseにしてください。
apacheurl Apacheサーバー ステータスURLです。例：http://<host-name:portNumber>server-status?auto

リクエスト サンプル

http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=256d041620d0aee9901558b44706dc84&type=Apache Server&displayname=apmapache&host=shakthiprian&port=8080&serverstatusurl=true&apacheurl=ddss

Apache Solr

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&port=[PORT]&SSL=[true/false]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。

フィールド 説明
type 追加するデータベースのタイプです。値はApache Solrにしてください。
displayname Apache Solr監視の表示名です。
host Apache Solrサーバーを実行しているホストの名前です。
port Apache Solrサーバーが動作するポート番号です。
SSL SSLを有効にするか否かを示します。trueかfalseを指定してください。

リクエスト サンプル

http://sudhan-3565:9091/AppManager/xml/AddMonitor?apikey=b74833e8881ec4cd68dcd893f96180bf&type=ApacheSolr&displayname=SolrInstance&host=AMP-W2012S-64-1&port=8983&ssl=false

IISサーバー

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&port=[PORT]sslenable=[true/false]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。

フィールド 説明
type 追加する監視のタイプです。値はIIS Serverにしてください。
host IISを実行しているホストの名前を指します。
port IISが動作するポート番号です。
sslenabled IISでSSLを有効にするかを示します。trueかfalseで指定してください。

リクエスト サンプル

http://prod-server8:9091/AppManager/xml/AddMonitor?apikey=90c166a4646e29315a57eca1d6b88858&type=IIS Server&displayname=apmiis&host=app-xp2&port=80sslenable=true

Nginxサーバー

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPALYNAME]&host=[HOST]&port=[PORT]&sslenable=[true/false]&nginxauth=[true/false]&username=[USER_NAME]&password=[PASS_WORD]&nginxstatusurl=[NGNIX_STATUS_URL]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。

フィールド 説明
type 追加する監視のタイプです。値はNginxにしてください。
host nginxサーバーを実行しているホストの名前です。
port nginxサーバーが動作するポート番号です。
nginxauth nginxサーバーで認証を必要とするかを示します。trueかfalseを指定してください。
username nginxサーバーのユーザー名です。nginxauthをtrueにした場合のみ必要です。
password nginxサーバーのパスワードです。nginxauthをtrueにした場合のみ必要です。
nginxstatusurl nginxサーバー ステータスURLです。trueかfalseで指定します。下記の例のように、値の前にスラッシュ（/）を補ってください。

リクエスト サンプル

http://operation-server9:9091/AppManager/xml/AddMonitor?apikey=a7867d64c831a50f8eb5be8bcfebab34&type=Nginx&displayname=apmnginx&host=deepak&port=8080&sslenable=true&nginxauth=true&username=deepak&password=deepak&nginxstatusurl=/nginx_status

PHP

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&port=[PORT]&serverpath=[SERVER_PATH]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。

フィールド 説明
type 追加する監視のタイプです。値はPHPにしてください。
host PHPを実行しているホストの名前を指します。
port PHPが動作するポート番号です。
serverpath 接続用のパスを指定します。デフォルトの値は/phpstats.phpです。

リクエスト サンプル

http://operation-server9:9091/AppManager/xml/AddMonitor?apikey=90c166a4646e29315a57eca1d6b88858&type=PHP&displayname=apmiis&host=myesuraj&port=80&serverpath=/phpstats.php

リアルブラウザー監視（RBM）

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]
&displayname=[DISPLAY_NAME]&rbmagentID=[RBM_AGENT_ID]&timeout=[TIME_OUT]&scriptname=[SCRIPT_NAME]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。

フィールド 説明
type 追加する監視のタイプです。値はRBMにしてください。
rbmagentID RBMエージェントのIDです。
timeout タイムアウト値を指定します（秒）。
scriptname webscriptの名前です。

リクエスト サンプル

http://prod-server8:9091/AppManager/xml/AddMonitor?apikey=90c166a4646e29315a57eca1d6b88858
&type=RBM&displayname=RBM_test&rbmagentID=10000000&timeout=15&scriptname=newS

URL監視

構文

http://[host]:[port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&timeout=[TIMEOUT]&url=[URL]&urlMethod=[METHOD]&httpCondition=[CONDITION]&httpValue=[RESPONSE_CODE]&checkForContent=[MATCH_CONTENT]&pollInterval=[POLL_INTERVAL]&regex=true&casesensitive=true

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。

フィールド 説明
type 追加する監視のタイプです。値はUrlMonitorにしてください。
displayname 作成する監視の名前です。
timeout タイムアウト値を指定します（秒）。
url 監視するHTTP/HTTPS URLアドレスを指定します。
urlMethod フォームデータ送信のメソッドを指定します。GETにはG、POSTにはPを指定してください。
httpCondition レスポンス エラー コードの条件を指定します。LT、GT、EQ、NE、LE、GEから指定できます（デフォルトはGTです）。
httpValue リソースのアップダウンを判定するのに、どのレスポンス コードを使うか指定します。デフォルトでは200となっています。
requestParams ユーザー名、パスワードなどのリクエスト パラメーターを指定します。
checkForContent コンテンツ マッチ用のキーワードを指定します。
verifyError エラー確認用のキーワードを指定します。
errorIfMatch キーワードを入力し、URLにあるコンテンツとマッチした場合に通知できるようにしてください。メモ：検索では大文字・小文字を区別します。複数キーワードはクオートで囲みます。囲んでいない場合は、複数あるキーワードのどれか1つでもマッチすれば、通知対象となります。
userName URLでフォームベースの認証が必要な場合、ユーザー名を指定してください。
password URLでフォームベースの認証が必要な場合、パスワードを指定してください。
payload フォーム送信メソッドにPOSTを使う場合のペイロード タイプを指定します。FORM、Text、XML、JSONから選択できます。
regex コンテンツ チェックで正規表現を使うか指定します。trueで有効になります。
casesensitive 大文字・小文字を区別してキーワード検索を行うか、指定してください。trueで有効になります。
userAgent URL監視用のユーザー エージェントを設定します（Android版のWebkit Operaをシミュレートする例：Mozilla/5.0 (Linux; Android 9; SH-M06) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.106 Mobile Safari/537.36 OPR/59.1.2926.54067）。
sslVersion URLで使うSSLのバージョンを指定します。SSLv3、TLSv1、TLSv1.1、TLSv1.2から選択できます。デフォルトでは自動になっており、設定は必須ではありません。

リクエスト サンプル

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=90c166a4646e29315a57eca1d6b88858&type=UrlMonitor&displayname=appmanager&timeout=60&url=http://appmanager.com&urlMethod=G&httpCondition=EQ&httpValue=200&requestParams=username=appAdmin%0Apassword=adminPass%0Arole=admin&checkForContent=Applications&verifyError=Exception&errorIfMatch=quit&regex=true&casesensitive=true

Webサーバー

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]
&host=[HOST]&port=[PORT]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。

フィールド 説明
type 追加する監視のタイプです。値はWebサーバーにしてください。
host Webサーバーを実行しているホストの名前です。
port Webサーバーが動作するポート番号です。

リクエスト サンプル

http://prod-server8:9091/AppManager/xml/AddMonitor?apikey=90c166a4646e29315a57eca1d6b88858&type=Web Server&displayname=apmweb&host=app-xp2&port=80

SSL証明書監視

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=SSLCertificateMonitor&displayname=[DISPLAY_NAME]&domain=[DOMAIN]&port=[PORT]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。

フィールド 説明
type 追加する監視のタイプです。値はSSLCertificateMonitorにしてください。
host SSL証明書監視を実行しているホストの名前です。
port SSL証明書監視が動作するポート番号です。
domain SSL証明書監視を行うドメイン名を入力してください。
isProxyNeeded サーバーがプロキシ経由でつながっている場合に利用します。次の値を指定できます。
  • isProxyNeeded=true
  • isProxyNeeded=false
ignoreHostNameError SSL証明書名のミスマッチ エラーを無視するかのパラメーターです。次の値を指定できます。
  • ignoreHostNameError=true
  • ignoreHostNameError=false
timeout タイムアウト値を入力してください（秒）。

リクエスト サンプル

http://prod-server8:9091/AppManager/xml/AddMonitor?apikey=bc76b1abb8e9b209824a39d84578a194&type=SSLCertificateMonitor&displayname=SSLCertificateMonitor&domain=www.zoho.com&port=443&timeout=60

Elasticsearch監視

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE] &displayname=[DISPLAY_NAME]&host=[HOST]&port=[PORT]&SSL=[true/false]&DiscoverAllNodes=[Yes/No]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。

フィールド 説明
apikey 「管理」タブのAPIキーの作成で生成したキーを指定します。
type 追加する監視のタイプです。値はElasticSearchClusterにしてください。
displayname Elasticsearch監視の表示名です。
host Elasticsearchサーバーを実行しているホストの名前です。
port Elasticsearchサーバーが動作するポート番号です。
ssl SSLを有効にするか指定します。trueかfalseにしてください。
DiscoverAllNodes Elasticsearchクラスターにあるノードをディスカバリするか指定します。YesかNoにしてください。

リクエスト サンプル

http://localhost:9097/AppManager/xml/AddMonitor?apikey=7c18de184b2c8b1caa8d65790b382f32&type=ElasticSearchCluster&displayname=localhost&host=localhost&port=9200&SSL=FALSE

To discover nodes

http://localhost:9097/AppManager/xml/AddMonitor?apikey=7c18de184b2c8b1caa8d65790b382f32&DiscoverAllNodes=Yes&type=ElasticSearchCluster&host=104.49.30.30&port=9200&ssl=false&displayname=test

HAProxy監視

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=HAProxy&displayname=[DISPLAY_NAME]&host=[HOST]&port=[PORT]&SSL=[true/false]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。

フィールド 説明
apikey 「管理」タブのAPIキーの作成で生成したキーを指定します。
type 追加する監視のタイプです。値はHAProxyにしてください。
displayname HAProxy監視の表示名です。
host HAProxyサーバーを実行しているホストの名前です。
port HAProxyサーバーが動作するポート番号です。
ssl SSLを有効にするか指定します。trueかfalseにしてください。

IBM HTTP Server

翻訳作業中です。本社サイトをご参照ください。

Oracle HTTP Server

翻訳作業中です。本社サイトをご参照ください。

Webサービス

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=Web Service&displayname=[DISPLAY_NAME]&WSDLUrl=[WSDL_URL]&endPointUrl=[END_POINT_URL]&resFulWebservice=[true/false]&haid=[MONITOR_GROUP_ID]&username=[USER_NAME]&password=[PASS_WORD]&customHeaders=[CUSTOM_HEADER]&authToken=[AUTH_TOKEN]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。

フィールド 説明
WSDLUrl 監視するWSDL URLを指定します。
endPointUrl 監視するエンド ポイントURLを指定します。
resFulWebサービス REST準拠のWebサービスを有効化するのに使います。
haid 監視グループのIDです。
username Webサービス実行に必要な、ユーザー名を指定します。
password Webサービス実行に必要な、パスワードを指定します。
customHeaders 操作の実行の際は、当社の標準ヘッダーも、お客さまカスタム ヘッダーも利用できます。
authToken 必要に応じて認証トークンを指定してください。

リクエスト サンプル

http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=d0588c8b72c6e76713ac55c66e8d&type=Web Service&displayname=apmservice&WSDLUrl=http://www.dataaccess.com/webservicesserver/numberconversion.wso?WSDL&endPointUrl=http://www.dataaccess.com/webservicesserver/numberconversion.wso&timeout=30&resFulWebservice=true&haid=10001&username=user&password=pass123&customHeaders=test&authToken=authtoken

Nginx Plus

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=NginxPlus&displayname=[DISPLAY_NAME]&host=[HOST_NAME]&port=[PORT_NUMBER]&SSL=[true/false]&username=[USER_NAME]&password=[PASS_WORD]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。

フィールド 説明
type 追加するサービスのタイプです。値はNginxPlusにしてください。
host NGNIX Plusを実行しているホストの名前です。
ssl SSLを有効にするか指定します。trueかfalseにしてください。
port NGNIX Plusが動作するポート番号です。
username NGNIX Plusへのアクセス権限があるユーザーの名前を指定します（任意項目）。
password NGNIX Plusへのアクセス権限を持つユーザーのパスワードを指定してください（任意項目）。

リクエスト サンプル

http://localhost:9092/AppManager/xml/AddMonitor?apikey=961280ec3cd4c76b39c1c9fbd871c5b0&type=NginxPlus&displayname=FromAPI&host=demo.nginx.com&port=443&ssl=true&username=test&Password=test

ServiceDesk Plus監視

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&hostname=[HOST]&port=[PORT]&SSL=[true/false]&restapiKey=[API_KEY]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。

フィールド 説明
hostname ServiceDesk Plusを実行しているホストの名前かIPアドレスです（MSP向け含む）。
port ServiceDesk Plusの実行ポートです（MSP向け含む）。
SSL If Enabaled ServiceDesk PlusでSSLを有効にするか指定してください（MSP向け含む）。
restapiKey ServiceDesk Plusで新規APIキーを作成するには、次の手順に従ってください。
  • ServiceDesk Plusにログインします。
  • トップ パネルのパーソナライズ タブに移動してください。
  • APIキーの生成をクリックします。無期限の選択も、期日の指定も可能です。
  • 無期限を選択した場合、新規キーの作成までApplications Managerは同じキーを利用し続けます。
  • 期限をセットした場合、有効期限が切れたのち、データ収集の再開には手動でキーを更新する必要があります。
  • 生成をクリックします。
  • 作成されたAPIキーをコピーして、Applications Managerでご利用ください。

リクエスト サンプル

http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=5b43655d12396a7917e5d5b036ced3aa&type=SDPMonitor&displayname=satya_sdp&hostname=app-1&port=8081&ssl=false&restapiKey=5B7ADE19-1234-4556-9F54-07FAF42D2C29

OpManager監視

翻訳作業中です。本社サイトをご参照ください。

ADManager Plus監視

翻訳作業中です。本社サイトをご参照ください。

REST API監視

翻訳作業中です。本社サイトをご参照ください。

Webページ分析

翻訳作業中です。本社サイトをご参照ください。