添加监视器 API - 云应用


本节说明如何使用添加监视器 API添加类别类型Cloud Apps的监视器。支持以下监视器:

Amazon

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&accessKey=[ACCESSKEY]&SecretAccessKey=[SECRETACCESSKEY]&displayname=[DISPLAYNAME]&AccountType=[account type]&AmazonServices=[AmazonServices]

请求参数

API请求中涉及的参数如下所述。另外,请参阅公共请求参数列表。

字段描述
type您要添加的监视器的类型。值应该是mazon
accessKeyAWS的访问密钥ID,用于通过API访问AWS。
SecretAccessKeyAWS的秘密访问密钥。
AccountType帐户类型。可能的值为
  • AwsGlobal
  • AwsChina
AmazonServices您要监控的Amazon Services。可能的值为:
  • EC2(用于弹性计算云)
  • RDS(用于关系数据库服务)
  • S3(用于S3bucket)
  • SNS(用于简单通知服务)
  • DYNAMODB(用于DynamoDB)
  • ALB(用于应用程序负载均衡)
  • NLB(用于网络负载均衡)
  • SQS(用于简单队列服务)
  • LAMBDA(用于Lambda函数)
  • DYNAMODB,EC2,RDS,S3,SNS,ALB,NLB,SQS,LAMBDA(用于多种服务)

示例请求

http://localhost:9090/AppManager/xml/AddMonitor?apikey=897cc23e5ca9b0f9a0c3838343517734&accessKey=AKIAIPQGJCIKOQK6KRGQ&type=Amazon&SecretAccessKey=yeKsseccAterceSswayeKsseccAterceSswayeKsseccAterceSswa&displayname=test&AccountType=AwsGlobal&AmazonServices=DYNAMODB,EC2,RDS,S3,SNS,ALB,NLB,SQS,LAMBDA

Windows Azure

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=WindowsAzure&displayname=[displayName]&SubscriptionID=[SubscriptionID]&AccountName=[AccountName]&AccountKey=[AccountKey]&Timeout=[Timeout]

请求参数

API请求中涉及的参数如下所述。另外,请参阅公共请求参数列表。

字段描述
type您要添加的监视器的类型。值应为WindowsAzure
SubscriptionID输入您的Windows Azure订阅ID。

注意:可以通过使用Windows Live ID登录Windows.azure.com来获取订阅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=[APIKEY]&type=OpenStack&displayname=[DISPLAY_NAME]&baseAuthURL=[IDENTITY_URL]&tenantName=[PROJECT_NAME]&username=[USENAME]&password=[PASSWORD]&isProxyRequired=[true/false]&isProjectScopeToken=[True/False]

请求参数

API请求中涉及的参数如下所述。另外,请参阅公共请求参数列表。

字段描述
apikeyApplications Manager API密钥(要获取API密钥,请转到Applications Manager→管理员→REST API)
displaynameOpenStack监视器的显示名称
type您要添加的监视器的类型。对于OpenStack,它应该是OpenStack
baseAuthURLOpenStack的基本身份验证URL。例如:http://controller:5000
tenantName与OpenStack帐户的用户关联的项目名称。
usernameOpenStack帐户的用户名。
passwordOpenStack帐号密码。
IsProxyRequired指定是否需要代理才能进行监控。可能的值为true / false。
IsProjectScopeToken指定授权范围是否设置为租户/项目。可能的值为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&isProjectScopeToken=False

错误处理

4601-身份验证URL不应为空。
4602-租户名称不能为空。

Microsoft Azure

若要使用模式1(AD应用程序和服务主体)添加Microsoft Azure监视器,请执行以下操作:

语法

http://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=MicrosoftAzure&displayname=[DISPLAYNAME]&SubscriptionID=[SUBSCRIPTIONID]&AzureServices=[SERVICES]&DiscoveryMode=[DISCOVERYMODE]&ClientID=[CLIENTID]&TenantID=[TENANTID]&AppKey=[APPKEY]

请求参数

API请求中涉及的参数如下所述。另外,请参见公共请求参数列表。

字段描述
type您要添加的监视器的类型。值应为MicrosoftAzure
displayname监视器的首选显示名称。
SubscriptionID要监控的Azure订阅的订阅ID。
AzureServices要监控的Azure服务。可能的值为
  • 虚拟机器
  • 存储帐户
  • SQL数据库
提供的值以逗号分隔。
DiscoveryMode资源发现方式。该值应为AzureSPApp
ClientID在Azure门户中创建的AD应用程序的客户端ID。
TenantIDAzure 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=

若要使用模式2(Azure组织帐户)添加Microsoft Azure监视器,请执行以下操作:

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=MicrosoftAzure&displayname=[DISPLAYNAME]&SubscriptionID=[SUBSCRIPTIONID]&AzureServices=[SERVICES]&DiscoveryMode=[DISCOVERYMODE]&AzureOrgUserName=[USEREMAILOFORGANIZATIONALACCOUNT]&AzureOrgPassword=[PASSWORDOFORGANIZATIONALACCOUNT]

请求参数

API请求中涉及的参数如下所述。另外,请参见公共请求参数列表。

字段描述
type您要添加的监视器的类型。值应为MicrosoftAzure
displayname监视器的首选显示名称。
SubscriptionID要监控的Azure订阅的订阅ID。
AzureServices要监控的Azure服务。可能的值为
  • 虚拟机器
  • 存储帐户
  • SQL数据库
提供的值以逗号分隔。
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

要使用模式3(OAuth模式)添加Microsoft Azure监视器,请执行以下操作:

语法

http://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=MicrosoftAzure&displayname=[DISPLAYNAME]&SubscriptionID=[SUBSCRIPTIONID]&AzureServices=[SERVICES]&DiscoveryMode=[DISCOVERYMODE]&OAuthVal=[OAUTHVALUE]

请求参数

API请求中涉及的参数如下所述。另外,请参见公共请求参数列表。

字段描述
type您要添加的监视器的类型。值应为MicrosoftAzure
displayname监视器的首选显示名称。
SubscriptionID要监控的Azure订阅的订阅ID。
AzureServices
要监控的Azure服务。可能的值为
  • 虚拟机器
  • 存储帐户
  • SQL数据库
提供的值以逗号分隔。
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=[APIKEY]&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请求中涉及的参数如下所述。另外,请参见公共请求参数列表。

字段描述
displaynameOracle Cloud监视器的名称
type要添加的监视器类型。值应为OracleCloud
TenancyOCID租用的Oracle Cloud Identifier。
UserID用户的Oracle云标识符。
OracleServices要监控的服务类型。可用的服务是计算,数据库存储
PEMFilePath文件包含私钥的文件路径。
Fingerprint通过将公钥上传到Oracle Cloud控制台获得。
Regions to monitor要监控的区域列表。
stopdiscovery防止发现特定服务下的资源。
ActionOnTerminatedResources对终止的资源执行的操作。
advancedsettings选中时启用其他设置。
servicesToNotDiscover不应为其启用发现的服务。可用的服务是计算,数据库存储。.

示例请求

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=[APIKEY]&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请求中涉及的参数如下所述。另外,请参见公共请求参数列表。

字段描述
displayname监视器的显示名称。
type添加的监视器类型。该值应为GoogleCloudPlatform
GCPServicesGoogle云服务,例如Compute,Storage,Filestore等。可用的服务包括ComputeEngine,CloudStorage,CloudFilestoreKubernetesEngine
ProjectID监控的项目的唯一ID。
provider在AppManager中创建的OAuth Provider的名称。
advancedsettings启用其他设置。可能的值为TrueFalse
deletedresourceaction在GCP控制台中删除的资源上要执行的操作。如果不使用此参数,则默认为告警。可能的值-告警/停止/取消管理/删除
stopdiscovery防止发现所选服务下的资源。可能的值为TrueFalse
servicestostopdiscovery不应发现其资源的服务。可用服务包括ComputeEngine,CloudStorage,CloudFilestoreKubernetesEngine。如果不使用此选项,则该值应为False

示例请求

http://localhost:9591/AppManager/xml/AddMonitor?apikey=0da3949052acdcda12fa00200ae1170e&type=GoogleCloudPlatform&displayname=GCP&GCPServices=ComputeEngine,CloudStorage,CloudFilestore,KubernetesEngine&ProjectID=black-agility-235006&provider=gcp&advancedsettings=True&deletedresourceaction=Stop&stopdiscovery=False&servicestostopdiscovery=False

Office 365

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&Office365TenantName=[OFFICE365TENANTNAME]&Office365Useremail=[ADMINEMAIL]&Office365Password=[PASSWORD]&Office365Services=[OFFICE365SERVICES]&displayname=[DISPLAYNAME]&Timeout=[TIMEOUT]

请求参数

API请求中涉及的参数如下所述。另外,请参见公共请求参数列表。

字段描述
type您要添加的监视器的类型。值应为 WindowsAzure
Office365TenantNameOffice 365订阅使用的租户名称。
Office365Useremail包含管理员权限的Office 365用户电子邮件。
Office365PasswordOffice 365用户帐户密码。
Office365Services需要监控的服务。支持的服务是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

受到世界各地客户的喜爱

"具有广泛监控功能的Standout工具"

它允许我们跟踪关键指标,如响应时间、资源利用率、错误率和交易性能。实时监控告警会及时通知我们任何问题或异常,使我们能够立即采取行动。

审稿人角色:研究与开发

我喜欢Applications Manager,因为它可以帮助我们检测服务器和SQL数据库中存在的问题。
卡洛斯·里韦罗

Lexmark技术支持经理

受到全球6000多家企业的信任

我们的客户