Application Real-Time Monitoring Service (ARMS) provides APIs for application monitoring, browser monitoring, Prometheus Service, custom monitoring, and alerting. This topic lists all the API documentation links and describes each API operation.

Application monitoring

API Description
ListTraceApps Queries the list of all application monitoring tasks in a specified region.
ConfigApp Turns on or off the Probe Master Switch of the application monitoring agent, or queries the status of the Probe Master Switch of the agent.
DeleteTraceApp Deletes an application from the application list.
SearchTraceAppByName Queries application monitoring tasks by application name.
SearchTraceAppByPage Queries application monitoring tasks by page.
SearchTraces Queries the list of traces. You can filter traces by time range, application name, IP address, span name, and tag.
SearchTracesByPage Queries traces by page. You can filter traces by time range, application name, IP address, span name, and tag.
GetTrace Queries detailed information of a trace.
GetMultipleTrace Queries detailed information of multiple traces.
QueryMetricByPage (Application Monitoring) Queries the monitoring metrics of application monitoring by page.
SaveTraceAppConfig Customizes application monitoring settings, such as trace sampling and agent switches.

Browser monitoring

API Description
CreateRetcodeApp Creates a browser monitoring task.
DeleteRetcodeApp Deletes a browser monitoring task.
ListRetcodeApps Queries the list of all browser monitoring tasks in a specified region.
SearchRetcodeAppByPage Queries browser monitoring tasks by page.
SetRetcodeShareStatus Enables or disables the logon-free sharing switch of a browser monitoring site.
GetRetcodeShareUrl Queries the sharing URL of a browser monitoring site.
QueryMetricByPage (Browser Monitoring) Queries the monitoring metrics of browser monitoring by page.

Prometheus Monitoring

API Description
AddGrafana Integrates a dashboard for ARMS Prometheus Service.
AddIntegration Integrates a dashboard and data collection rules for ARMS Prometheus Service.
GetPrometheusApiToken Queries the token required to integrate Prometheus Service.
ListDashboards Queries the list of Grafana dashboards for a cluster.

Alert

API Description
ImportAppAlertRules Imports alert rules from application monitoring or browser monitoring.
t1858119.html#doc_api_ARMS_DeleteAlertRules Deletes one or more alert rules.
t1858183.html#doc_api_ARMS_SearchAlertRules Queries alert rules.
t1917839.html#doc_api_ARMS_StartAlert Enables an alert rule.
t1917838.html#doc_api_ARMS_StopAlert Disables an alert rule.
CreateAlertContact Creates an alert contact.
t1858116.html#doc_api_ARMS_DeleteAlertContact Deletes an alert contact.
t1917348.html#doc_api_ARMS_UpdateAlertContact Modifies an alert contact.
SearchAlertContact Queries alert contacts.
CreateAlertContactGroup Creates an alert contact group.
t1858118.html#doc_api_ARMS_DeleteAlertContactGroup Deletes an alert contact group.
t1917377.html#doc_api_ARMS_UpdateAlertContactGroup Modifies an alert contact group.
SearchAlertContactGroup Queries an alert contact group.
t1858153.html#doc_api_ARMS_SearchAlertHistories Queries the alert notifications of an alert rule.
t1858186.html#doc_api_ARMS_SearchEvents Queries alert events.