監視追加APIでデータベースサーバーを追加
このページでは、AddMonitor APIで、カテゴリタイプ「データベース サーバー」の監視を追加する方法を説明します。サポート対象は次のデータベースです。
- IBM Db2
- IBM Informix
- memcached
- MS SQL
- MySQL
- Oracle
- Oracle NoSQL
- PostgreSQL
- Sybase
- SAP HANA
- Cassandra
- Redis
- MongoDB
- Couchbase
- HBase
- Neo4j
- SQL Anywhere
IBM Db2
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]
&username=[USER_NAME]&host=[HOST]&password=[PASS_WORD]&port=[PORT]&instance=[INSTANCE]
APIリクエストにかかわるパラメーターを下に記します。あわせて、共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加するデータベースのタイプです。値はDB2にしてください。 |
| username | Db2データベースへのアクセス権限があるユーザーの名前を指定します。 |
| host | Db2を実行しているホストの名前です。 |
| password | Db2データベースへのアクセス権限を持つユーザーのパスワードを指定してください。 |
| port | Db2が動作するポート番号です。 |
| instance | データベースのインスタンス名です。 |
リクエスト サンプル
http://prod-server1:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5
&type=db2&displayname=appmanagerdb2&username=db2admin&host=app-xp4&password=admin&port=50000&instance=SAMPLEDB
IBM Informix
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=type&displayname=[DISPLAY_NAME]&host=[HOST]&port=[PORT]&informixserver=[データベース サーバーNAME]&username=[USER_NAME]&password=[PASS_WORD]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。あわせて、共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加するデータベースのタイプです。値はInformixにしてください。 |
| username | Informixデータベースへのアクセス権限があるユーザーの名前を指定します。 |
| host | Informixデータベースを実行しているホストの名前です。 |
| password | Informixデータベースへのアクセス権限を持つユーザーのパスワードを指定してください。 |
| port | Informixデータベースが動作するポート番号です。 |
| instance | データベースのインスタンス名です。 |
| informixserver | Informix Serverを指定します。デフォルトでは、ol_machinenameです。 |
リクエスト サンプル
http://prod-server1:9090/AppManager/xml/AddMonitor?apikey=f5297a51be2f6f962a5cdbd68521ee61&type=Informix&displayname=test&hostname=app-win7-64-1&port=9088&username=informix&password=informix&informixserver=ol_informix1210
memcached
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]
&displayname=[DISPLAY_NAME]&host=[HOST]&port=[PORT]&Transaction=[TRANSACTION]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。あわせて、共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加するデータベースのタイプです。値はMemcachedにしてください。 |
| host | memcachedサーバーを実行しているホストの名前です。 |
| port | memcachedサーバーが動作するポート番号です。 |
| トランザクション | トランザクション テストが有効か否かを表します。yesかnoを指定してください。 |
リクエスト サンプル
http://prod-server4:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98
&type=Memcached&displayname=mem_test&host=app-linux2&port=11211&Transaction=yes
MS SQL
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME] &username=[USER_NAME]&host=[HOST]&password=[PASS_WORD]&port=[PORT]&namedInstance=[true/false]&instance=[INSTANCE]&authentication=[AUTHENTICATION]&encryption=[true/false]&kerberos=[true/false]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。あわせて、共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加するデータベースのタイプです。値はms sqlにしてください。 |
| username | MS SQL Serverへのアクセス権限があるユーザーの名前を指定します。 |
| host | MS SQLを実行しているホストの名前です。 |
| password | MS SQL Serverへのアクセス権限を持つユーザーのパスワードを指定してください。 |
| port | MS SQLが動作するポート番号です。 |
| instance | データベースのインスタンス名です。このフィールドの設定は必須ではありません。 |
| authentication | 認証タイプ。値はSQLかWindowsにしてください。 |
| namedIntance | SQL Serverが名前付きインスタンスかを示します。この値はtrueにします。 |
| encryption | サーバーで暗号を強制しているかを示します。この値はtrueにします。 |
| kerberos | サーバーでKerberos認証が有効かを示します（trueかfalse）。 |
リクエスト サンプル
http://prod-server7:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=mssql&displayname=appmanagermssql&username=sa&host=app-xp2&password=Advent1&port=1433&namedInstance=true&instance=MSSQLSERVER&authentication=SQL&encryption=true&kerberos=true
MySQL
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&username=[USER_NAME]&host=[HOST]&password=[PASS_WORD]&port=[PORT]&instance=[INSTANCE]&authentication=[AUTHENTICATION]&useSSL=[true/false]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。あわせて、共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加するデータベースのタイプです。値はmysqlにしてください。 |
| username | MySQLサーバーへのアクセス権限があるユーザーの名前を指定します。 |
| host | MySQLを実行しているホストの名前です。 |
| password | MySQLサーバーへのアクセス権限を持つユーザーのパスワードを指定してください。 |
| port | MySQLが動作するポート番号です。 |
| instance | データベースのインスタンス名です。このフィールドの設定は必須ではありません。 |
| authentication | 認証タイプを示します。SQLを指定してください。 |
| useSSL | このオプションを有効にすると、クライアント側認証とサーバー側認証の双方向が強制適用となります。この項目の指定は必須ではありません。 |
リクエスト サンプル
http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=mysql&displayname=appmanagermysql&username=root&host=
shakthiprian&password=appmanager&port=13329&instance=mysql&authentication=SQL&useSSL=true
Oracle
構文
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。あわせて、共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加するデータベースのタイプです。値はoracleにしてください。 |
| username | Oracle Databaseへのアクセス権限があるユーザーの名前を指定します。 |
| host | Oracleを実行しているホストの名前です。 |
| password | Oracle Databaseへのアクセス権限を持つユーザーのパスワードを指定してください。 |
| port | Oracleが動作するポート番号です。 |
| instance | データベースのインスタンス名です。このフィールドの設定は必須ではありません。 |
| SSLEnabled | SSL有効であればtrue、無効であればfalseにします。 |
リクエスト サンプル
Oracle NoSQL
構文
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。あわせて、共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| apikey | Oracle Coherence監視の作成に使うAPIキーを指定します。 |
| type | 追加するデータベースのタイプです。値はcoherenceにしてください。 |
| displayname | Oracle Coherence監視の表示名です。 |
| hostname | Oracle Coherenceを実行しているホストの名前です。 |
| port | Oracleが動作するポート番号です。 |
| username | Oracle Coherenceデータベースへのアクセス権限があるユーザーの名前を指定します。 |
| password | Oracle Coherenceデータベースへのアクセス権限を持つユーザーのパスワードを指定してください。 |
| JNDIPath | 利用するJNDIパスを指定してください。 |
リクエスト サンプル
PostgreSQL
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]
&displayname=[DISPLAY_NAME]&host=[HOST]&port=[PORT]&username=[USER_NAME]&password=[PASS_WORD]&instance=[INSTANCE]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。あわせて、共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加するデータベースのタイプです。値はPostgreSQLにしてください。 |
| host | PostgreSQLを実行しているホストの名前です。 |
| port | PostgreSQLが動作するポート番号です。 |
| username | PostgreSQLデータベースへのアクセス権限があるユーザーの名前を指定します。 |
| password | PostgreSQLデータベースへのアクセス権限を持つユーザーのパスワードを指定してください。 |
| instance | データベースのインスタンス名です。このフィールドの設定は必須ではありません。 |
|
SSLEnabled |
SSL有効であればtrue、無効であればfalseにします。 |
リクエスト サンプル
http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98
&type=PostgreSQL&displayname=postSQL&host=app-xp2&port=5432&username=postgres&password=postgres&instance=postgres&SSLEnabled=false
Sybase
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]
&username=[USER_NAME]&host=[HOST]&password=[PASS_WORD]&port=[PORT]&instance=[INSTANCE]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。あわせて、共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加するデータベースのタイプです。値はsybaseにしてください。 |
| host | Sybaseを実行しているホストの名前です。 |
| port | Sybaseが動作するポート番号です。 |
| username | Sybaseデータベースへのアクセス権限があるユーザーの名前を指定します。 |
| password | Sybaseデータベースへのアクセス権限を持つユーザーのパスワードを指定してください。 |
| instance | データベースのインスタンス名です。このフィールドの設定は必須ではありません。 |
リクエスト サンプル
http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5
&type=sybase&displayname=appmanagersybase&username=sa&host=app-xp3&password=&port=5000&instance=master
SAP HANA
構文
オンプレミス システムを監視するには
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=SapHana&displayname=[DISPLAY_NAME]&host=[HOST]&isOndemand=false&port=[PORT]&dbuser=[DB_USERNAME]&dbPassword=[DB_PASSWORD]&instance=[INSTANCE]
オンデマンド システムを監視するには
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=SapHana&displayname=[DISPLAY_NAME]&host=[HOST]&isOndemand=true&accountName=[ACCOUNT_NAME]&username=[USER_NAME]&password=[ACCOUNT_PASSWORD]&dbuser=[DB_USERNAME]&dbPassword=[DB_PASSWORD]&instance=[INSTANCE]
リクエスト パラメーター説明
| フィールド | 説明 |
|---|---|
| host | ホスト名かLanscapeのホスト名を指定します。 |
| port | インデックス サーバーのSQLポートです。デフォルトは30015となっています（オンプレミス構成でのみ必要）。 |
| isOndemand | オンデマンド構成ではtrue、オンプレミス構成ではfalseにしてください。 |
| accountName | クラウド アカウント名です（オンデマンド構成でのみ必要）。 |
| username | クラウド アカウントのユーザー名です（オンデマンド構成でのみ必要）。 |
| password | クラウド アカウントのパスワードを指定します（オンデマンド構成でのみ必要）。 |
| dbUser | データベースのユーザー名を指定します。 |
| dbPassword | データベースのパスワードを指定します。 |
| nstance | インスタンス名を指定してください。 |
リクエスト サンプル
http://app-support-w7:9090/AppManager/xml/AddMonitor?apikey=151c7e98b0f2a3cbc44fbd56ec66a6c9&displayname=RestHana&type=SapHana&host=hanatrial.ondemand.com&
isOndemand=true&accountName=s0004447540trial&username=s0004447540&password=Zoho@123&dbUser=SYSTEM&
dbPassword=Zoho@1234&instance=mdchana
HBase
構文
http://[hostname]:[port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=HBase&displayname=[DISPLAY_NAME]&HostName=[HOST_NAME]&port=[PORT]&username=[USER_NAME]&password=[PASS_WORD]&JNDIPath=/jmxrmi
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| apikey | HBase監視の作成に使うAPIキーを指定します。 |
| type | 追加するデータベースのタイプです。値はHBaseにしてください。 |
| displayname | HBase監視の表示名です。 |
| hostname | HBaseを実行しているホストの名前です。 |
| port | HBaseが動作するポート番号です。 |
| username | HBaseデータベースへのアクセス権限があるユーザーの名前を指定します。 |
| password | HBaseデータベースへのアクセス権限を持つユーザーのパスワードを指定してください。 |
| JNDIPath | 利用するJNDIパスを指定してください。 |
リクエスト サンプル
http://Prod-server7:9010/AppManager/xml/AddMonitor?apikey=0b719d6a4a564c8be86fbc60d3f0b996&type=HBase&displayname=HBase&HostName=APP-W8-AIO-5&Port=5000&username=admin&Password=Abc@123&JNDIPath=/jmxrmi
Cassandra
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=Cassandra&displayname=Cassandra&host=[HOST_NAME]&port=[PORT_NUMBER]&discoverclusternodes=[Yes/No:NOT_MANDATORY_FOR_Yes]&authRequired=[true/false::NOT_MANDATORY_FOR_true]&username=[USER_NAME]&password=[PASS_WORD]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。あわせて、共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加するデータベースのタイプです。値はCassandraにしてください。 |
| host | Cassandraデータベースを実行しているホストの名前です。 |
| port | Cassandraデータベースが動作するポート番号です。 |
| username | Cassandraデータベースへのアクセス権限があるユーザーの名前を指定します。 |
| password | Cassandraデータベースへのアクセス権限を持つユーザーのパスワードを指定してください。 |
| discoverclusternodes | クラスター ノードのディスカバリが必要かを指定します。値はYESかNOです（任意項目）。 |
| authRequired | 認証が必要か指定します。値はtrueかfalseです。 |
リクエスト サンプル
http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=849c51ce33436587873a08d69d5447fc&type=Cassandra&displayname=Cassandra&host=172.20.7.36&port=7199&
username=&password=123
Redis
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=Redis&displayname=Redis&host=[HOST_NAME]&port=[PORT_NUMBER]&discoverclusternodes=[Yes/No:NOT_MANDATORY_FOR_Yes]&authRequired=[true/false::NOT_MANDATORY_FOR_true]&password=[PASS_WORD]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。あわせて、共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加するデータベースのタイプです。値はRedisにしてください。 |
| host | Redisを実行しているホストの名前です。 |
| port | Redisが動作するポート番号です。 |
| username | Redisデータベースへのアクセス権限があるユーザーの名前を指定します。 |
| password | Redisデータベースへのアクセス権限を持つユーザーのパスワードを指定してください。 |
| discoverclusternodes | クラスター ノードのディスカバリが必要かを指定します。値はYESかNOです（任意項目）。 |
| authRequired | 認証が必要か指定します。値はtrueかfalseです。 |
リクエスト サンプル
http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=849c51ce33436587873a08d69d5447fc&type=Redis&displayname=Redis&host=172.20.6.200&port=6379&password=123
MongoDB
構文
http://[Host]:[Port]/http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=MongoDB&displayname=MongoDB&host=[HOST_NAME]&port=[PORT_NUMBER]&discoverchildren=[Yes/No:NOT_MANDATORY_FOR_Yes]&authRequired=[true/false::NOT_MANDATORY_FOR_true]&username=[USER_NAME]&password=[PASS_WORD]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。あわせて、共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加するデータベースのタイプです。値はMongoDBにしてください。 |
| host | MongoDBを実行しているホストの名前です。 |
| port | MongoDBが動作するポート番号です。 |
| username | Mongoデータベースへのアクセス権限があるユーザーの名前を指定します。 |
| password | Mongoデータベースへのアクセス権限を持つユーザーのパスワードを指定してください。 |
| discoverclusternodes | クラスター ノードのディスカバリが必要かを指定します。値はYESかNOです（任意項目）。 |
| authRequired | 認証が必要か指定します。値はtrueかfalseです。 |
| discoverchildren | 値はtrueかfalseです。 |
リクエスト サンプル
http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=849c51ce33436587873a08d69d5447fc&type=MongoDB&displayname=MongoDB&host=172.20.6.200&port=6379&password=123
Couchbase
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]
&host=[HOST]&port=[PORT]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。あわせて、共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加するデータベースのタイプです。値はCouchbaseにしてください。 |
| displayname | Couchbaseデータベースの表示名です。 |
| host | Couchbaseを実行しているホストの名前です。 |
| port | Couchbaseが動作するポート番号です。 |
リクエスト サンプル
http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=3a45dc93b4eb6d7fbefe550e4a2a7c6c&type=Couchbase&displayname=Couchmonitoring&host=app-win7-64-4.csez.zohocorpin.com&port=8091">http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=3a45dc93b4eb6d7fbefe550e4a2a7c6c&type=Couchbase&displayname=Couchmonitoring&host=app-win7-64-4.csez.zohocorpin.com&port=8091
Neo4j
構文
http://[Host]:[PORT]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=Neo4j&displayname=[DISPLAY_NAME]&HostName=[Host]&port=[PORT]&username=[USER_NAME]&password=[PASS_WORD]&DiscoverNode=yes/no
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。あわせて、共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加するデータベースのタイプです。値はNeo4jにしてください。 |
| HostName | Neo4jを実行しているホストの名前です。 |
| Port | bolt Neo4jを実行しているポートの番号です。 |
| UserName | Neo4jデータベースへのアクセス権限があるユーザーの名前を指定します。 |
| Password | Neo4jデータベースへのアクセス権限があるユーザーのパスワードを指定します。 |
| DiscoverNode | クラスター ノードのディスカバリが必要かを指定します。値はYESかNOです（任意項目）。 |
リクエスト サンプル
http://localhost:9090/AppManager/xml/AddMonitor?apikey=21ca68ece3dfc1bab0fa100b2c4f90cb&type=Neo4j&displayname=DISPLAYNAME&HostName=app-w8-aio-5&Port=7687&username=[USER_NAME]eo4j&Password=admin&DiscoverNode=yes
SQL Anywhere
構文：
http://[Host]:[port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&username=[USER_ID]&host=[HOST]&password=[PASS_WORD]&port=[PORT]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。あわせて、共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加するデータベースのタイプです。値はSQLAnywhere-DB-serverにしてください。 |
| displayname | 監視の表示名です。 |
| username | SQL Anywhereデータベースへのアクセス権限があるユーザーの名前を指定します。 |
| host | SQL Anywhereサーバーを実行しているホストの名前です。 |
| password | SQL Anywhereデータベースへのアクセス権限を持つユーザーのパスワードを指定してください。 |
| port | SQL Anywhereが稼働しているポート番号を指します。デフォルト ポートは2638です。 |
リクエスト サンプル
http://localhost:9096/AppManager/xml/AddMonitor?apikey=94e214da57134e2c57ce7c7ec4b523a8&type=SQLAnywhere-DB-server&displayname=sqlanywhere-demo&username=dba&host=hostname&password=sql&port=2638