AddMonitor API――クラウド アプリ
このページでは、AddMonitor APIで、カテゴリ タイプ クラウド アプリの監視を追加する方法を説明します。サポート対象は次の監視です。
- Amazon
- Windows Azure
- OpenStack
- Amazon SNS
- Microsoft Azure
- Oracle Cloud Infrastructure
- Google Cloud Platform
- Microsoft 365
Amazon
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&accessKey=[ACCESS_KEY]&SecretAccessKey=[SECRET_ACCESS_KEY]&displayname=[DISPLAY_NAME]&AccountType=[ACCOUNT_TYPE]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。AddMonitor APIに共通のリクエスト パラメーターも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加する監視のタイプです。Amazonを指定してください。 |
| accessKey | APIアクセスに使うAWSのアクセス キーIDです。 |
| SecretAccessKey | AWSのシークレット アクセス キーです。 |
| AccountType | アカウント タイプを指定します。次から選択してください。
|
| AmazonServices | 監視するAWS機能を次から指定します。
|
リクエスト サンプル
http://localhost:9090/AppManager/xml/AddMonitor?apikey=897cc23e5ca9b0f9a0c3838343517734&accessKey=AKIAIPQGJCIKOQK6KRGQ&type=Amazon&SecretAccessKey=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&displayname=test&AccountType=AwsGlobal
Windows Azure
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=WindowsAzure&displayname=[DISPLAY_NAME]&SubscriptionID=[SUBSCRIPTION_ID]&AccountName=[AccountName]&AccountKey=[AccountKey]&timeout=[TIMEOUT]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。AddMonitor APIに共通のリクエスト パラメーターも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加する監視のタイプです。WindowsAzureを指定してください。 |
| SubscriptionID | Windows AzureサブスクリプションIDを入力してください。
(メモ：サブスクリプションIDは、AzureポータルにWindows Live IDでサインインして入手できます。ホステッド サービスをクリックして、ストレージとCDN、ストレージ アカウントと移動してください。 |
| AccountName | Windows Azureストレージ アカウントのアカウント名を入力してください。 |
| AccountKey | Windows Azureストレージ アカウントのアカウント キーを入力してください。 |
| Timeout | タイムアウト間隔を指定します（秒）。 |
リクエスト サンプル
http://prod-server2:9098/AppManager/xml/AddMonitor?apikey=f664b86118740af22c6ac7af7f86c06f&type=WindowsAzure&displayname=azure&SubscriptionID=deepak-1470&AccountName=1888&AccountKey=deepak&Timeout=30
OpenStack
構文
http://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=OpenStack&displayname=[DISPLAY_NAME]&baseAuthURL=[IDENTITY_URL]&tenantName=[PROJECT_NAME]&username=[USENAME]&password=[PASS_WORD]&isProxyRequired=[true/false]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。AddMonitor APIに共通のリクエスト パラメーターも参照ください。
| フィールド | 説明 |
|---|---|
| apikey | Applications ManagerのAPIキーです。管理 > REST APIで確認できます。 |
| displayname | OpenStack監視の表示名です。 |
| type | 追加する監視のタイプです。「OpenStack」を指定します。 |
| baseAuthURL | OpenStackのベース認証URLです。例：http://controller:5000 |
| tenantName | OpenStackアカウントのユーザーに関連付いたプロジェクト名を入力します。 |
| username | OpenStackアカウントのユーザー名です。 |
| password | OpenStackアカウントのパスワードです。 |
| IsProxyRequired | true/falseで指定します。 |
リクエスト サンプル
http://prod-server2:9098/AppManager/xml/AddMonitor?apikey=37e05e898e97f63b66aec9fbd10b9d3c&type=OpenStack&displayname=OpenStack_API&baseAuthURL=http://controller:5000&tenantName=Venus&username=admin&password=Abc@123&isProxyRequired=false
エラー対応
4601：認証URLは空白にできません。
4602：テナント名は空白にできません。
Amazon SNS
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&accessKey=[ACCESS_KEY]&SecretAccessKey=[SECRET_ACCESS_KEY]&displayname=[DISPLAY_NAME]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。AddMonitor APIに共通のリクエスト パラメーターも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加する監視のタイプです。値はAmazonにしてください。 |
| accesskey | APIアクセスに使うAWSのアクセス キーIDです。 |
| secretaccesskey | AWSのシークレット アクセス キーです。シークレット キーは、英数字40桁です。 |
| displayname | Amazonサーバー監視の表示名です。 |
Microsoft Azure
Microsoft Azure監視をモード1で追加する（ADアプリケーションとサービス プリンシパル）
構文
http://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=MicrosoftAzure&displayname=[DISPLAY_NAME]&SubscriptionID=[SUBSCRIPTION_ID]&AzureServices=[SERVICES]&DiscoveryMode=[DISCOVERY_MODE]&ClientID=[CLIENT_ID]&TenantID=[TENANT_ID]&AppKey=[APP_KEY]
リクエスト パラメーター
このAPIリクエストで使うパラメーターを下で説明します。APIでの監視の追加に共通のリクエスト パラメーターのリストも確認ください。
| フィールド | 説明 |
|---|---|
| type | 追加する監視のタイプを指定します。値は「MicrosoftAzure」にしてください。 |
| displayname | 監視に希望する名前を付けます。 |
| SubscriptionID | 監視するAzureのサブスクリプションIDです。 |
| AzureServices | 監視するAzureサービスを次から指定してください。
カンマ区切りで複数指定可能です。
|
| DiscoveryMode | リソースディスカバリのモードを指定します。「AzureSPApp」を指定してください。 |
| ClientID | Azureポータルで作成したADアプリケーションのクライアントIDを指定します。 |
| TenantID | Azure Active directoryのテナントID（ディレクトリID）です。 |
| AppKey | Azureポータルで作成したADアプリケーションのパスワードを指定します。 |
リクエスト サンプル
http://apm-k12r2-2:9900/AppManager/xml/AddMonitor?apikey=e820f56394ac554ec4efebc3fa9dd4f0&type=MicrosoftAzure&displayname=AzureRestAPI&SubscriptionID=790a1f5f-c756-481b-ae8d-0471c6fbb678&AzureServices=VirtualMachines,StorageAccounts,SQLDatabases&DiscoveryMode=AzureSPApp&ClientID=66e1857a-aea5-466a-9007-b0c6cf23e866&TenantID=322392c9-4095-4ad7-9571-b131b85cf2b0&AppKey=856uwpSpCF6/PXTdqYREo8TJt3NrcxOLChBIO2eHHJo=
Microsoft Azure監視をモード2で追加する（Azure組織アカウント）
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=MicrosoftAzure&displayname=[DISPLAYNAME]&SubscriptionID=[SUBSCRIPTIONID]&AzureServices=[SERVICES]&DiscoveryMode=[DISCOVERYMODE]&AzureOrgUserName=[USEREMAILOFORGANIZATIONALACCOUNT]&AzureOrgPassword=[PASSWORDOFORGANIZATIONALACCOUNT]
リクエスト パラメーター
このAPIリクエストで使うパラメーターを下で説明します。APIでの監視の追加に共通のリクエスト パラメーターのリストも確認ください。
| フィールド | 説明 |
|---|---|
| type | 追加する監視のタイプを指定します。値は「MicrosoftAzure」にしてください。 |
| displayname | 監視に希望する名前を付けます。 |
| SubscriptionID | 監視するAzureのサブスクリプションIDです。 |
| AzureServices | 監視するAzureサービスを次から指定してください。
カンマ区切りで複数指定可能です。
|
| DiscoveryMode | リソースディスカバリのモードを指定します。「AzureOrgAccount」としてください。 |
| AzureOrgUserName | Azureポータルで作成した組織アカウントです。 |
| AzureOrgPassword | 組織アカウントのパスワードです。 |
リクエスト サンプル
http://apm-k12r2-2:9900/AppManager/xml/AddMonitor?apikey=e820f56394ac554ec4efebc3fa9dd4f0&type=MicrosoftAzure&displayname=AzureRestAPI&SubscriptionID=78da1f5f-c756-481b-aeff-0471c6fbb262&AzureServices=VirtualMachines,StorageAccounts,SQLDatabases&DiscoveryMode=AzureOrgAccount&AzureOrgUserName=apmou@apmoutlook.onmicrosoft.com&AzureOrgPassword=Abc123
Microsoft Azure監視をモード3で追加する(OAuth Mode):
構文
http://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=MicrosoftAzure&displayname=[DISPLAYNAME]&SubscriptionID=[SUBSCRIPTIONID]&AzureServices=[SERVICES]&DiscoveryMode=[DISCOVERYMODE]&OAuthVal=[OAUTHVALUE]
リクエスト パラメーター
このAPIリクエストで使うパラメーターを下で説明します。APIでの監視の追加に共通のリクエスト パラメーターのリストも確認ください。
| フィールド | 説明 |
|---|---|
| type | 追加する監視のタイプを指定します。値は「MicrosoftAzure」にしてください。 |
| displayname | 監視に希望する名前を付けます。 |
| SubscriptionID | 監視するAzureのサブスクリプションIDです。 |
| AzureServices | 監視するAzureサービスを次から指定してください。
カンマ区切りで複数指定可能です。
|
| DiscoveryMode | リソースディスカバリのモードを指定します。「AzureOAuth」を指定してください。 |
| OAuthVal | OAuth値を指定します。 |
リクエスト サンプル
http://prod-server:9900/AppManager/xml/AddMonitor?apikey=e820f56394ac554ec4efebc3fa9dd4f0&type=MicrosoftAzure&displayname=AzureOAuthRestAPI&SubscriptionID=790a1f5f-c756-481b-ae8d-0471c6fbb678&AzureServices=VirtualMachines,StorageAccounts,SQLDatabases&DiscoveryMode=AzureOAuth&OAuthVal=10000000
Oracle Cloud Infrastructure
構文
http://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=OracleCloud&displayname=[DISPLAY_NAME]&TenancyOCID=[Tenancy_OCID]&UserID=[User_OCID]&OracleServices=[Oracle_Services]&PEMFilePath=[PEM_File_Path]&Fingerprint=[Finger_print]&RegionsToMonitor=[Regions_To_Monitor]&stopdiscovery=[Stop_Discovery_Option]&ActionOnTerminatedResources=[Action]&advancedsettings=[Advanced_Settings]&servicesToNotDiscover=[Services_To_Not_Discover]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。AddMonitor APIに共通のリクエスト パラメーターも参照ください。
| フィールド | 説明 |
|---|---|
| displayname | Oracle Cloud監視の名前です。 |
| type | 追加する監視のタイプです。値はOracleCloudにしてください。 |
| TenancyOCID | Oracle Cloudのテナンシ識別子です。 |
| UserID | Oracle Cloudのユーザー識別子です。 |
| OracleServices | 監視するサービスのタイプです。Compute、Database、Storageがあります。 |
| PEMFilePath | 秘密鍵のあるファイルのパスを指定します。 |
| Fingerprint | Oracle Cloudコンソールに公開鍵をアップロードすると入手できます。 |
| Regions to monitor | 監視するリージョンのリストです。 |
| stopdiscovery | 特定サービスを指定し、そのリソースのディスカバリを停止します。 |
| ActionOnTerminatedResources | 停止リソースで実行するアクションを指定します。 |
| advancedsettings | 追加設定を有効にします。 |
| servicesToNotDiscover | ディスカバリを有効にしないサービスを指定します。Compute、Database、Storageがあります。 |
リクエスト サンプル
http://localhost:9600/AppManager/xml/AddMonitor? apikey=1d9d98ce3273afd265400c3ef7b78678&type=OracleCloud&displayname=oraclecloudrest&TenancyOCID=ocid1.tenancy.oc1..aaaaaaaagltesttesttesttest26h5ksdo6fgbvbcmj377dnoka73rq&UserID=ocid1.user.oc1..aaaaaaaabz2skyed3j3kwxsgqtesttesttesttestoczno4ew2ov7rr57wnuza&OracleServices=Compute,Storage,Database&PEMFilePath=C:\Users\karthik-8095\.oci\oci_api_key.pem&Fingerprint=ea;e1:f8:68:a1:7f:ds:df:as:sd:d7:62:9e:53:f0:1f&RegionsToMonitor=eu-frankfurt-1,us-ashburn-1&stopdiscovery=False&ActionOnTerminatedResources=Unmanage&advancedsettings=False&servicesToNotDiscover=Compute
Google Cloud Platform
構文
http://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=GoogleCloudPlatform&displayname=[DISPLAY_NAME]&GCPServices=[GCP_Services]&ProjectID=[Project_ID]&provider=[OAuth_Provider_Name]&advancedsettings=[true/false]&deletedresourceaction=[Alert/Stop/Unmanage/Delete]&stopdiscovery=[true/false]&servicestostopdiscovery=[False/GCP_Services]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。AddMonitor APIに共通のリクエスト パラメーターも参照ください。
| フィールド | 説明 |
|---|---|
| displayname | 監視の表示名です。 |
| type | 追加する監視のタイプです。値はGoogleCloudPlatformにしてください。 |
| GCPServices | Compute、Storage、Filestoreなどのサービスです。ComputeEngine、CloudStorage、CloudFilestoreで指定してください。 |
| ProjectID | 監視するプロジェクトの一意のIDです。 |
| provider | Applications Managerに作成するOAuthプロバイダー（IdP）の名前です。 |
| advancedsettings | 追加設定を有効にします。値はtrueかfalseで指定してください。 |
| deletedresourceaction | GCPコンソールでリソースを削除したときに実行するアクションを指定します。未指定の場合、デフォルトで「Alert」になります。Alert、Stop、Unmanage、Deleteから指定してください。 |
| stopdiscovery | 選択したサービスのうち、ディスカバリしないリソースを指します。値はtrueかfalseで指定してください。 |
| servicestostopdiscovery | ディスカバリを行わないリソース用サービスを指定します。ComputeEngine、CloudStorage、CloudFilestoreを指定できます。利用しない場合はFalseにしてください。 |
リクエスト サンプル
http://localhost:9591/AppManager/xml/AddMonitor?apikey=0da3949052acdcda12fa00200ae1170e&type=GoogleCloudPlatform&displayname=GCP&GCPServices=ComputeEngine,CloudStorage,CloudFilestore&ProjectID=black-agility-235006&provider=gcp&advancedsettings=True&deletedresourceaction=Stop&stopdiscovery=False&servicestostopdiscovery=False
Microsoft 365
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&Office365TenantName=[OFFICE365TENANTNAME]&Office365Useremail=[ADMINEMAIL]&Office365password=[PASS_WORD]&Office365Services=[OFFICE365SERVICES]&displayname=[DISPLAY_NAME]&timeout=[TIMEOUT]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。AddMonitor APIに共通のリクエスト パラメーターも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加する監視のタイプです。値はWindowsAzureにしてください。 |
| Office365TenantName | Microsoft 365サブスクリプションで使うテナント名です。 |
| Office365Useremail | Microsoft 365で管理者権限のあるユーザーのメールを指定してください。 |
| Office365Password | Microsoft 365ユーザー アカウントのパスワードを指定します. |
| Office365サービス | 監視を要するサービスを指定します。「ExchangeOnline、SharepointOnline、SkypeForBusinessOnline」をサポートしています。 |
| timeout | タイムアウト間隔を指定します（秒）。 |
リクエスト サンプル
http://prod-server2:9098/AppManager/xml/AddMonitor?apikey=4c362569ccc528be78fafdcc2317bc5c&type=Office365&Office365TenantName=appmanager&Office365Useremail=apm@appmanager.onmicrcosoft.com&Office365Password=test123&Office365Services=ExchangeOnline,SharepointOnline,SkypeForBusinessOnline&displayname=officemonitor&Timeout=600