添加监视器 API- 数据库服务器

本节说明如何使用AddMonitor API添加类别类型数据库服务器的监视器。支持以下数据库：

IBM DB2

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port=[PORT]&instance=[INSTANCE]&useSSL=[true/false]

请求参数

API请求中涉及的参数如下所述。另外，请参阅常见的请求参数列表。

字段 描述
type 要添加的数据库的类型。值应为db2。
username 有权访问DB2数据库的用户的用户名。
host 运行DB2的主机的名称。
password 有权访问DB2数据库的用户的密码。
port DB2运行所在的端口号。
instance 数据库/实例名称。
useSSL 指示是否为DB2服务器启用了SSL。 (trueorfalse)

示例请求

http://prod-server1:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5
&type=db2&displayname=appmanagerdb2&username=db2admin&host=app-xp4&password=admin&port=50000&instance=SAMPLEDB&useSSL=true

IBM Informix

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=type&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&informixserver=[DATABASE SERVER NAME]&username=[USERNAME]&password=[PASSWORD]

请求参数

API请求中涉及的参数如下所述。另外，请参阅常见的请求参数列表.

字段 描述
type 要添加的数据库的类型。值应为Informix。
username 有权访问Informix数据库的用户的用户名。
host 运行Informix数据库的主机的名称。
password 有权访问Informix数据库的用户的密码。
port Informix数据库运行所在的端口号。
instance 数据库/实例名称。
informixserver 您的Informix服务器的名称。默认情况下，名称将为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=[APIKEY]&type=[TYPE]
&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&Transaction=[TRANSACTION]

请求参数

API请求中涉及的参数如下所述。另外，请参阅常见的请求参数列表.

字段 描述
type 要添加的数据库的类型。值应为Memcached.
host 运行Memcached服务器的主机的名称。
port Memcached服务器运行所在的端口号。
Transaction 表示是否启用事务测试。值应为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=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME] &username=[USERNAME]&host=[HOST]&password=[PASSWORD]&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=MS SQL&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=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&username=[USERNAME]&host=[HOST]&password=[PASSWORD]&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

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port=[PORT]&instance=[INSTANCE]&SSLEnabled=[isSSLEnabled]&discoverPDB=[DiscoverPDB]&oracleSocketTimeout=[SocketReadTimeout]&oracleQueryTimeout=[QueryExecutionTimeout]

请求参数

API请求中涉及的参数如下所述。另外，请参阅常见的请求参数列表.

字段 描述
type 要添加的数据库的类型。值应为oracle.
username 有权访问Oracle数据库的用户名。
host Oracle在其中运行的主机的名称。
password 有权访问Oracle数据库的用户的密码。
port Oracle运行所在的端口号。
instance 数据库/实例名称。这是可选字段。
SSLEnabled 如果启用了SSL，则为true，否则为false。
discoverPDB 启用发现和监控可插拔数据库的选项。（yes或no）
oracleSocketTimeout 用于数据库连接的套接字读取超时值。默认值为300秒。
oracleQueryTimeout 数据收集查询执行期间的查询执行超时值。默认值为60秒。

示例请求

http://prod-server7:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=oracle&displayname=appmanageroracle&username=rajesh&host=swissql-xp1&password=rajesh&port=1521&instance=orcl&SSLEnabled=false&discoverPDB=yes&oracleSocketTimeout=300&oracleQueryTimeout=60

Oracle NoSQL

语法

http://[hostname]:[port]/AppManager/xml/AddMonitor?apikey=[apikey]&type=OracleNoSQL&displayname=[Displayname]&HostName=[HostName]&Port=[Port]&UserName=[UserName]&Password=[Password]&JNDIPath=/jmxrmi

请求参数

API请求中涉及的参数如下所述。另外，请参阅常见的请求参数列表.

字段 描述
apikey 创建 Oracle coherence 监视器的API密钥
type 要添加的数据库的类型。值应为coherence.
displayname Oracle coherence监视器的显示名称
hostname 运行Oracle coherence的主机的名称。
port Oracle运行所在的端口号。
username 有权访问Oracle coherence数据库的用户名。
password 有权访问Oracle coherence数据库的用户的密码。
JNDIPath 要使用的JNDI路径

示例请求

http://Prod-server7:9010/AppManager/xml/AddMonitor?apikey=0b719d6a4a564c8be86fbc60d3f0b996&type=OracleNoSQL&displayname=OracleNoSQL&HostName=APP-W8-AIO-5&Port=5000&UserName=admin&Password=Abc@123&JNDIPath=/jmxrmi

PostgreSQL

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]
&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&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=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&username=[USERNAME]&host=[HOST]&password=[PASSWORD]&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=[APIKEY]&type=SapHana&displayname=[DISPLAYNAME]&host=[HOST]&isOndemand=false&port=[PORT]&dbuser=[DB_USERNAME]&dbPassword=[DB_PASSWORD]&instance=[INSTANCE]

监控 OnDemand 系统:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=SapHana&displayname=[DISPLAYNAME]&host=[HOST]&isOndemand=true&accountName=[ACCOUNT_NAME]&username=[USER_NAME]&password=[ACCOUNT_PASSWORD]&dbuser=[DB_USERNAME]&dbPassword=[DB_PASSWORD]&instance=[INSTANCE]

请求参数

字段 描述
Host 主机名称/ Landscape 参考此处
Port IndexServer SQL端口。默认值30015。[仅内部安装需要]
isOndemand 对于Ondemand设置，该值为true；对于内部部署，该值为false。
accountName Ondemand CLoud帐户名。[仅适用于Ondemand设置]
username 云帐户的用户名。[仅适用于Ondemand设置]
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=[apikey]&type=HBase&displayname=[Displayname]&HostName=[HostName]&Port=[Port]&UserName=[UserName]&Password=[Password]&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=[APIKEY]&type=Cassandra&displayname=Cassandra&host=[Host Name]&port=[Port Number]&discoverclusternodes=[non mandatory column, if given the value should be 'Yes']&authRequired=[non mandatory column, if given the value should be 'true']&username=[username]&password=[password]

请求参数

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=[APIKEY]&type=Redis&displayname=Redis&host=[Host Name]&port=[Port Number]&discoverclusternodes=[non mandatory column, if given the value should be 'Yes']&authRequired=[non mandatory column, if given the value should be 'true']&password=[password]

请求参数

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=[APIKEY]&type=MongoDB&displayname=MongoDB&host=[Host Name]&port=[Port Number]&discoverchildren=[non mandatory column, if given the value should be 'Yes']&authRequired=[non mandatory column, if given the value should be 'true']&username=[username]&password=[password]

请求参数

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=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&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=[DISPLAYNAME]&HostName=[Host]&Port=[Port]&UserName=[UserName]&Password=[Password]&DiscoverNode=yes/no

请求参数

API请求中涉及的参数如下所述。另外，请参阅常见的请求参数列表.

字段 描述
type 要添加的数据库的类型。值应为Neo4j.
HostName Neo4j在其中运行的主机的名称。
Port 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=neo4j&Password=admin&DiscoverNode=yes

SQL Anywhere

语法

http://[Host]:[port]/AppManager/xml/AddMonitor?apikey=[Key]&type=[type]&displayname=[DisplayName]&username=[userid]&host=[Host]&Password=[password]&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