Updated on 2023-11-16 GMT+08:00

API Overview

AOM provides common monitoring, Prometheus monitoring, alarm, and log APIs, enabling quick and cost-effective application O&M.

Table 1 API overview

Type

Description

Monitoring

Common monitoring APIs, including the APIs for querying metrics; querying and adding monitoring data; adding, modifying, querying, and deleting threshold rules; adding, modifying, querying, and deleting application discovery rules.

Prometheus Monitoring

Prometheus monitoring APIs, including the APIs for querying data in a specified period, data at a specified time point, tag values, tag names, and metadata.

Log

Log APIs, including the API for querying logs.

Alarm

Event and alarm APIs, including the APIs for querying, counting, and reporting events and alarms.

Common Monitoring APIs

API

Description

Querying Time Series Objects

Query the metrics that can be monitored in the system. You can specify the namespace, metric name, dimension, resource ID (format: resType_resId), start position, and maximum number of returned records in pagination queries.

Querying Time Series Data

Query monitoring data in a specified period. You can specify a dimension or period to query.

Querying Metrics

Query the metrics that can be monitored in the system. You can specify the namespace, metric name, dimension, resource ID (format: resType_resId), start position, and maximum number of returned records in pagination queries.

Querying Monitoring Data

Query monitoring data in a specified period. You can specify a dimension or period to query.

Adding Monitoring Data

Add one or more monitoring data records.

Adding or Modifying One or More Service Discovery Rules

Add or modify one or more service discovery rules.

Deleting a Service Discovery Rule

Delete one or more service discovery rules.

Querying Existing Service Discovery Rules

Query an existing service discovery rule in the system.

Adding a Threshold Rule

Add a threshold rule.

Querying the Threshold Rule List

Query all threshold rules.

Modifying a Threshold Rule

Modify a threshold rule.

Deleting a Threshold Rule

Delete a threshold rule.

Querying a Threshold Rule

Query a threshold rule.

Deleting Threshold Rules in Batches

Delete threshold rules in batches.

Prometheus Monitoring APIs

API

Description

Querying Expression Calculation Results in a Specified Period

Query the calculation results of a PromQL expression in a specified period.

Querying Expression Calculation Results in a Specified Period

Query the calculation results of a PromQL expression in a specified period.

Querying the Expression Calculation Result at a Specified Time Point

Query the calculation results of a PromQL expression at a specified time point.

Querying the Expression Calculation Result at a Specified Time Point

Query the calculation results of a PromQL expression at a specified time point.

Querying Tag Values

Query the values of a specified tag.

Obtaining the Tag Name List

Obtain the tag name list.

Obtaining the Tag Name List

Obtain the tag name list.

Querying Metadata

Query the metadata of time series and corresponding tags.

Log APIs

API

Description

Querying Logs

Query logs by different dimensions, such as by cluster, IP address, or application.

Alarm APIs

API

Description

Querying Events and Alarms

Query events and alarms of a user.

Counting Events and Alarms

Count events and alarms that meet specified conditions.

Reporting Events and Alarms

Report events and alarms of a user.