監視の追加API（サービス）

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

Active Directory

構文

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&CredSSP=[Yes/FALSE]&username=[USERNAME]&password=[PASSWORD]&timeout=[TIMEOUT]&kerberos=[True/False]

リクエスト パラメーター

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

フィールド 説明
type 追加するサービスのタイプ
値は「ActiveDirectory」を指定してください。
host Active Directoryサービスを実行しているホストの名前
username Active Directoryのユーザー名
password Active Directoryのパスワード
timeout スクリプト実行時のタイムアウト時間（秒）
CredSSP 監視対象のADサーバがプライマリドメインコントローラでなく、Applications Managerサーバドメインとは異なるドメインに存在する場合にCredSSP Authenticationを使用するかどうかを指定
CredSSPを有効にする必要がある場合、値は「Yes」を指定してください。
Kerberos Kerberos認証を有効にするためのオプション
TrueまたはFalseを指定してください。

リクエストサンプル

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=ActiveDirectory&displayname=active_mon&host=app-xp4&username=admin&password=appman&timeout=300&CredSSP=Yes&kerberos=True

Cephストレージ

構文

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&prompt=[Prompt]&userName=[UserName]&password=[Password]&snmptelnetport=[PORT]&mode=[MODE OF MONITORING]&timeout=[TIMEOUT]

リクエスト パラメーター

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

フィールド 説明
type 追加するサービスのタイプ
値は「Ceph Storage」を指定してください。
host Cephサービスを実行しているホストの名前
username Cephストレージ サービスのユーザー名
password Cephストレージ サービスのパスワード
prompt コマンドプロンプト値を指定
デフォルト値は「$」
snmptelnetport Telnet/SSHサービスが動作しているポート番号
Telnetのデフォルトポートは23、SSHのデフォルトポートは22
mode 使用したい監視モードを指定
TrueまたはFalseを指定してください。
timeout Applications ManagerがAPIサービスをホストするサーバーとの接続を確立するために消費したタイムアウト時間
デフォルト値は40ms

リクエストサンプル

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Ceph Storage&displayname=ceph&host=ctl-cephadmin&prompt=$&userName=admin&password=appman&snmptelnetport=22&mode=SSH&timeout=40

DNS監視

構文

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&timeout=[TIMEOUT]&SearchField=[SEARCHFIELD]&TargetAddress=[TARGETADDRESS]&LookupAddress=[LOOKUPADDRESS]&RecordType=[RECORDTYPE]

リクエスト パラメーター

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

フィールド 説明
type 追加するサービスのタイプ
値は「DNSMonitor」を指定してください。
displayname 監視が稼働しているホストの表示名
timeout タイムアウト値（秒）を指定
SearchField 検索フィールドの値を以下から指定
None、Record Name、Address、Additional Name、Target, Admin、Host、Alias、Port、Priority
-none-を指定すると、検索を行いません。
TargetAddress サービス接続用のホスト名かIPアドレス
LookupAddress DNSサーバーで確認するアドレスを指定
RecordType ルックアップ アドレスに対して期待する戻りレコードのタイプを以下から指定
A、AAAA、CNAME、MX、NS、PTR、SOA、SPF、SRV、TXT
-none-を指定すると、検索を行いません。

リクエストサンプル

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=DNSMonitor&displayname=dnstttttt&timeout=15&SearchField=Record Name&TargetAddress=192.168.4.121&LookupAddress=appmanager.com&RecordType=A

FTP/SFTP監視

構文

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&TargetAddress=[TARGETADDRESS]&DownloadFile=[DOWNLOADFILE]&IsSecured=[ISSECURED]&UploadFile=[UPLOADFILE]&RemoteSourceFileName=[REMOTESOURCEFILENAME]&RemoteDestinationFileName=[REMOTEDESTINATIONFILENAME]&LocalSourceFileName=[LOCALSOURCEFILENAME]&LocalDestinationFileName=[LOCALDESTINATIONFILENAME]&timeout=[TIMEOUT]

リクエスト パラメーター

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

フィールド 説明
type 追加するサービスのタイプ
値は「FTPMonitor」を指定してください。
port FTP/SFTPサービスが動作するポート番号
username FTP/SFTPユーザー名
password FTP/SFTPのパスワード
TargetAddress サービス接続用のホスト名かIPアドレス
DownloadFile ダウンロードを有効とするかを指定
YesまたはNoを指定してください。
ファイルダウンロードのシミュレーション中に、FTP/SFTPでのダウンロード（mget）を監視したい場合は、Yesを指定します。
IsSecured 接続をセキュアにするかを指定
YesまたはNoを指定してください。
UploadFile ファイル アップロードを有効とするかを指定
YesまたはNoを指定してください。
ファイルをターゲットアドレスにダウンロードするには、yesを指定します。
RemoteSourceFileName ターゲットアドレスにあるリモートソースファイルを指定　
このパラメーターは「DownloadFile」にyesを指定している場合のみ有効です。
RemoteDesinationFileName ターゲットアドレスにあるリモート宛先ファイルを指定
このパラメーターは「UploadFile」にyesを指定している場合のみ有効です。
LocalSourceFileName ローカルソースファイルを完全パスで指定
名前ファイルはApplications Managerが動作している場所に存在しなくてはなりません。
このパラメーターは「UploadFile」にyesを指定している場合のみ有効です。
LocalDestinationFileName ローカル宛先ファイル名を完全パスで指定
ファイルは、Applications Managerインスタンスが稼働先の指定パスにダウンロードされます。
このパラメーターは「DownloadFile」にyesを指定している場合のみ有効です。
timeout タイムアウト値を指定（秒）
credentialID 使用する認証ID

注:認証IDは、ユーザー名およびパスワードフィールドの代わりとして使用することができます。

リクエストサンプル

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=FTPMonitor&displayname=ladpapitestooooo&port=22&username=admin&password=appman&TargetAddress=sprasadh&DownloadFile=no&IsSecured=yes&UploadFile=no&RemoteSourceFileName=&RemoteDestinationFileName=&LocalSourceFileName=&LocalDestinationFileName=&timeout=15

Hadoop監視

NameNodeとJobTracker/ResourceManagerは、モード（JMXまたはREST API）を統一して追加ください。

構文

1：Hadoop監視をREST APIモードで追加する

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Hadoop&displayname=[DISPLAYNAME]&ModeOfMonitoring=RESTAPI&Version=[1.x/2.x]&NameNodeHost=[NAMENODE HOST]&NameNodeWebPort=[NAMENODE WEBPORT]&NameNodeSSLEnabled=[yes/no]&NameNodeWebAuthType=[SimpleAuth/NoAuth]&NameNodeUserName=[NAMENODE USERNAME]&JobTrackerHost=[JOBTRACKER HOSTNAME]&JobTrackerWebPort=[JOBTRACKER WEBPORT]&JobTrackerSSLEnabled=[yes/no}&JobTrackerWebAuthType=[SimpleAuth/NoAuth]&JobTrackerUserName=[JOBTRACKER USERNAME]

2：Hadoop監視をJMXモードで追加する

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Hadoop&displayname=[DISPLAYNAME]&ModeOfMonitoring=JMX&Version=[1.x/2.x]&NameNodeHost=[NAMENODE HOST]&NameNodeJMXPort=[NAMENODE JMXPORT]&NameNodeUserName=[NAMENODE JMX USERNAME]&NameNodePassWord=[NAMENODE JMX PASSWORD]&NameNodeJNDIPath=[NAMENODE JNDIPATH]&JobTrackereHost=[JOBTRACKER HOSTNAME]&JobTrackerJMXPort=[JOBTRACKER JMXPORT]&JobTrackerUserName=[JOBTRACKER JMX USERNAME]&JObTrackerPassWord=[JOBTRACKER JMX PASSWORD]&JobTrackerJNDIPath=[JOBTRACKER JNDIPATH]

リクエスト パラメーター

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

フィールド 説明
ModeOfMonitoring Hadoop監視でデータ収集を行うモード

次から指定できます。

  • RESTAPI
  • JMX
Version Hadoopのバージョン

次から指定できます。

  • 1.x
  • 2.x
NameNodeHost Namenodeのホスト名
NameNodeWebPort NamenodeのWebポート
NameNodeJMXPort NamenodeのJMXポート
NameNodeSSLEnabled NameNodeのWebポートでSSLを有効にするかを指定

次から指定できます。

  • yes
  • no
NameNodeWebAuthType NameNodeのWebで使う認証タイプ

次から指定できます。

  • NoAuth
  • SimpleAuth
NameNodeUserName
  • NameNodeで、シンプルな認証を使用している場合、Webアクセスのユーザー名を指定します。
  • NameNodeで、監視にJMXモードを選択している場合、JMXアクセスのユーザー名を指定します。
NameNodePassWord NameNodeにJMXでアクセスする際のパスワードを指定
NameNodeJNDIPath NamenodeのJNDIパス
JobTrackerHost Jobtrackerのホスト名
JobTrackerWebPort JobtrackerのWebポート
JobTrackerJMXPort JobtrackerのJMXポート
JobTrackerSSLEnabled JobTrackerのWebポートでSSLを有効にするかを指定

次から指定できます。

  • yes
  • no
JobTrackerWebAuthType JobTracker Webで使う認証タイプ

次から指定できます。

  • NoAuth
  • SimpleAuth
JobTrackerUserName
  • JobTrackerでシンプル認証を選んだ際の、Webアクセス用ユーザー名を指定
  • JobTrackerでJMXモードでの監視を選んだ際の、JMXアクセス用ユーザー名を指定
JobTrackerPassWord JobTrackerにJMXでアクセスする際のパスワード
JobTrackerJNDIPath JobTrackerのJNDIパス

リクエストサンプル

1：Hadoop監視をREST APIモードで追加する

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Hadoop&displayname=Hadoop&ModeOfMonitoring=RESTAPI&Version=1.x&NameNodeHost=naga-2385&NameNodeWebPort=50070&NameNodeSSLEnabled=no&NameNodeWebAuthType=SimpleAuth&NameNodeUserName=admin&JobTrackerHost=naga-2385&JobTrackerWebPort=50030&JobTrackerSSLEnabled=no&JobTrackerWebAuthType=SimpleAuth&JobTrackerUserName=jtadmin

2：Hadoop監視をJMXモードで追加する

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Hadoop&displayname=Hadoop&ModeOfMonitoring=JMX&Version=1.x&NameNodeHost=naga-2385&NameNodeJMXPort=8004&NameNodeUserName=nnadmin&NameNodePassWord=nnappman&NameNodeJNDIPath=/jmxrmi&JobTrackerHost=naga-2385&JobTrackerJMXPort=8004&JobTrackerUserName=jtadmin&JobTrackerPassWord=jtappman&JobTrackerJNDIPath=/jmxrmi

JMXアプリケーション

構文

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&jndiurl=[JNDIURL]

リクエスト パラメーター

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

フィールド 説明
type 追加するサービスのタイプ　値は「JMX Applications」を指定してください。
host 監視が稼働しているホストの名前を指定
port RMIアダプターが動作するポート番号
jndiurl JNDI名例：/jmxrmi

リクエストサンプル

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=JMX Applications&displayname=apmjmxapp&host=app-xp2&port=1099&jndiurl=/jmxrmi

LDAPサーバー

構文

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&username=[USERNAME]&timeout=[TIMEOUT]&LDAPServer=[LDAPSERVER]&LDAPServerPort=[LDAPSERVERPORT]&MatchingAttribute=[MATCHINGATTRIBUTE]&FilterCondition=[FILTERCONDITION]&IsSecured=[ISSECURED]&SearchFilter=[SEARCHFILTER]&SearchResult=[SEARCHRESULT]&SearchBase=[SEARCHBASE]&password=[PASSWORD]

リクエスト パラメーター

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

フィールド 説明
type 追加するサービスのタイプ　値は「LDAP Server」を指定してください。
username LDAPサーバーのユーザー名
timeout タイムアウト値を指定（秒）
LDAPServer LDAP Serverの名前
LDAPServerPort LDAPサーバーが動作するポートを指定
MatchingAttribute マッチさせる属性cn、uid、sn、displayname、givenname、objectclass、dc、ouから指定
FilterCondition フィルター条件の値equals、contains、notequalsから指定
IsSecured 接続をセキュアにするかを指定。
yesかnoで指定してください。
SearchFilter 検索フィルターの値　（任意項目）
SearchResult 検索結果にマッチさせる文字列
SearchBase 検索ベースの値
※LDAP監視の追加時は必須です。
password LDAPサーバーのパスワード

リクエストサンプル

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=LDAP Server&displayname=ldap_serverqqqq&username=cn=admin,cn=users,dc=pmp,dc=com&timeout=10&LDAPServer=pmp-2k8s&LDAPServerPort=389&MatchingAttribute=cn&FilterCondition=equals&IsSecured=no&SearchFilter=&SearchResult=&SearchBase=&Password=appman

 

ping監視/ping監視（EUM）

構文

ping監視

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Ping Monitor (Non EUM)&displayname=[DISPLAYNAME]&host=[HOST]&timeout=[TIMEOUT]

ping監視（EUM）

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Ping Monitor&displayname=[DISPLAYNAME]&host=[HOST]&timeout=[TIMEOUT]&eumAgents=[AGENTNAME]&runOnServer=[RUNONSERVER]

リクエスト パラメーター

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

フィールド 説明
type 追加するサービスのタイプ　値は「Ping Monitor (EUM)」か「Ping Monitor」（EUM以外）を指定してください。
displayname 監視の表示名
host 監視が稼働しているホストを指定
timeout タイムアウト値を指定（秒）
eumAgents EUMエージェントの表示名（複数可）
カンマで区切ることが可能です。
runOnServer 監視を作成する必要があるかどうかを指定
TrueまたはFalseを指定してください。

リクエストサンプル

ping監視

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Ping Monitor (Non EUM)&displayname=apmping&host=apm-host&timeout=5

ping監視（EUM）

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Ping Monitor&displayname=apmping&host=apm-host&timeout=5&eumAgents=apm-eum-w7&runOnServer=true

サービス監視

構文

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&timeout=[TIMEOUT]

リクエスト パラメーター

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

フィールド 説明
type 追加するサービスのタイプ
値は「サービス監視」を指定してください。
host 監視が稼働しているホストを指定
timeout タイムアウト値を指定（秒）
port サービスを実行しているポート番号を指定

リクエストサンプル

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Service Monitoring&displayname=apmservice&host=apm-host&port=9090&timeout=3

SNMP/ネットワーク装置

構文

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&snmpCommunityString=[SNMPCOMMUNITYSTRING]&timeout=[TIMEOUT]

リクエスト パラメーター

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

フィールド 説明
type 追加するサービスのタイプ
値は「SNMP/Network Device」を指定してください。
host 監視が稼働しているホストを指定
port SNMPを実行しているポート番号
snmpCommunityString SNMPコミュニティ文字列値を指定
デフォルトはpublic
timeout タイムアウト値を指定（秒）

リクエストサンプル

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=SNMP/Network Device&displayname=apmsnmp&host=sprasadh&port=161&snmpCommunityString=public&timeout=5

Telnet / Telnet (EUM)

構文

Telnet:

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Telnet&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&timeout=[TIMEOUT]

Telnet(EUM):

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Telnet (EUM)&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&timeout=[TIMEOUT]&eumAgents=[AGENTNAME]&runOnServer=[RUNONSERVER]

リクエスト パラメーター

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

フィールド 説明
type 追加するサービスのタイプ
値は「telnet」を指定してください。
host 監視を実行しているホストの名前を指定
timeout タイムアウト値を指定（秒）
port Telnetを実行しているポート番号を指定
eumAgents EUMエージェントの表示名（複数可）
カンマで区切ることが可能です。
runOnServer 監視を作成する必要があるかどうかを指定
TrueまたはFalseを指定してください。

リクエストサンプル

Telnet:

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Telnet&displayname=apmtelnet&host=smrithil&port=23&timeout=2

Telnet(EUM):

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Telnet (EUM)&displayname=apmtelnet&host=smrithil&port=23&timeout=2&eumAgents=apm-eum-w7&runOnServer=true

Oracle Coherence

構文

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[apikey]&type=Coherence&displayname=[Displayname]&HostName=[HostName]&Port=[Port]&PortAdd=[AdditionalPort]&UserName=[UserName]&Password=[Password]&JNDIPath=/jmxrmi

リクエスト パラメーター

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

フィールド 説明
apikey Oracle Coherence監視の作成に使うAPIキーを指定
type 追加するデータベースのタイプ
値は「coherence」を指定してください。
displayname Oracle Coherence監視の表示名
hostname Oracle Coherenceを実行しているホストの名前
port Oracleが動作するポート番号
PortAdd 任意のマシンで動作しているOracle Coherenceの追加ポート（任意項目）
username Oracle Coherenceデータベースへのアクセス権限があるユーザーの名前を指定
password Oracle Coherenceデータベースへのアクセス権限を持つユーザーのパスワードを指定
JNDIPath 利用するJNDIパス
デフォルト値は/jmxrmiです（任意項目）。

リクエストサンプル

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Coherence&displayname=Coherence_API&HostName=it360-m4600-1&Port=1099&PortAdd=1095&UserName=admin&Password=appman&JNDIPath=/jmxrmi

Apache ZooKeeper

構文

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Zookeeper&displayname=Zookeeper&host=[Host Name]&port=[Port Number]&discoverclusternodes=[non mandatory column, if given the value should be 'Yes']&authReq=[non mandatory column, if given the value should be 'true']&username=[username]&password=[password]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。

フィールド 説明
type 追加するサービスのタイプ
値は「Zookeeper」を指定してください。
host ZooKeeperを実行しているホストの名前
port ZooKeeperが動作するポート番号
username ZooKeeperへのアクセス権限のあるユーザーの名前
password ZooKeeperへのアクセス権限のあるユーザーのパスワード
discoverclusternodes クラスターノードのディスカバリが必要かを指定
YesまたはNoを指定してください。（任意項目）
authReq 認証が必要かを指定
TrueまたはFalseを指定してください。

リクエストサンプル

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Zookeeper&displayname=Zookeeper&host=172.20.7.36&port=7199&username=admin&password=appman

Apache Spark

構文

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&SSL=[TRUE/FALSE]&DiscoverAllNodes=[YES/NO]

リクエスト パラメーター

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

フィールド 説明
apikey ［設定］タブ→［API キーの生成］オプションから生成されたキー
type 追加する監視タイプ
値は「ApacheSparkMaster」を指定してください。
displayname Apache Spark監視の表示名
host Apache Sparkサーバーが実行されているホストの名前
port Apache Sparkサーバーが実行されているポート
ssl SSLを有効にするかどうかを指定
値はtrueまたはfalseから選択してください。
DiscoverAllNodes すべてのワーカーノードを検出するかを指定

リクエストサンプル

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=ApacheSparkMaster&displayname=Spark&host=172.20.7.36&port=7199&SSL=true&DiscoverAllNodes=yes

Istio

構文

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAY NAME]&username=[USERNAME]&password=[PASSWORD]&namespace=[NAMESPACE]&Hostname=[HOSTNAME]&port=[PORT]

リクエスト パラメーター

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

フィールド 説明
apikey ［設定］タブ→［API キーの生成］オプションから生成されたキー
type 追加する監視タイプ
値は「Istio」を指定してください。
displayname Istio監視の表示名
Hostname Istioサーバーが実行されているホスト名
port Istioサーバーが実行されているポート
username Istioサーバーのユーザー名
password Istioサーバーのパスワード
namespace Istioサーバーの名前空間

リクエストサンプル

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Istio&displayname=imasterrestapi&username=admin&password=appman&namespace=istio-system&Hostname=imaster&port=9922

Network Policy Server (Radius Server)

構文

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=NetworkPolicyServer&displayname=[DISPLAYNAME]&host=[HOST]&UserName=[USERNAME]&Password=[PASSWORD]&Roles=[ROLES]

リクエスト パラメーター

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

フィールド 説明
apikey ［設定］タブ→［API キーの生成］オプションから生成されたキー
type 追加する監視のタイプ
値は「NetworkPolicyServer」を指定してください。
displayname ネットワークポリシーサーバー(Radiusサーバー)の表示名
host ネットワークポリシーサーバー(Radiusサーバー)が実行されているホストの名前
UserName ネットワークポリシーサーバー(Radiusサーバー)のユーザー名
Password ネットワークポリシーサーバー(Radiusサーバー)のパスワード
Roles コンマで区切られたネットワークポリシーサーバー(Radiusサーバー)の役割
設定可能な値は以下の2つです。
  • RadiusServer
  • RadiusProxy

リクエストサンプル

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=NetworkPolicyServer&displayname=NPSAPI&host=183.51.13.6&UserName=APM\admin&Password=appman&Roles=RadiusServer,RadiusProxy

UDPポート

構文

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&timeout=[TIMEOUT]&command=[COMMAND]&search=[VALUE]

リクエスト パラメーター

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

フィールド 説明
type 追加する監視のタイプ
値は「UDP Port」を指定してください。
host サービスが実行されているホスト名
port 指定されたホストがリッスン状態のUDPポート
timeout コマンド実行後、サーバーからの応答待機時間
command UDPポート経由で実行するコマンド

注:テキスト形式のコマンドタイプのみサポートします。
search コマンドの実行後にサーバーの応答で検索される値
複数の値の場合は、値を角かっこで囲み、カンマで区切ります。例：["値1","値2","値3"]

リクエストサンプル

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=UDP Port&displayname=UDP&host=localhost&port=13&timeout=5&command=test&search=["value"]

Hazelcast

構文

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[apikey]&type=Hazelcast&displayname=[Displayname]&HostName=[HostName]&Port=[Port]&PortAdd=[AdditionalPort]&username=[UserName]&password=[Password]&JNDIPath=/jmxrmi

リクエスト パラメーター

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

フィールド 説明
Apikey Hazelcast監視を作成するためのAPIキー
type 追加するデータベースのタイプ
値は「Hazelcast」を指定してください。
displayname Hazelcast監視の表示名
HostName Hazelcastが実行されているホストの名前
Port Hazelcastが実行されているポート番号
PortAdd 任意のマシンで動作するHazelcastの追加ポート（任意項目）
username Hazelcastデータベースへのアクセス権限を持つユーザーの名前
password Hazelcastデータベースへのアクセス権限を持つユーザーのパスワード
JNDIPath 使用するJNDIパス
デフォルト値は/jmxrmiです。（任意項目）

リクエストサンプル

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Hazelcast&displayname=Hcast&HostName=it360-m4600-1&Port=5000&PortAdd=1095&username=admin&password=appman&JNDIPath=/jmxrmi