Help Center/ Application Operations Management/ API Reference (Ankara Region)/ API Overview
Updated on 2024-04-15 GMT+08:00
View PDF
Share

API Overview

AOM provides open monitoring, auto scaling, and log APIs, helping you implement application O&M with low costs.

Table 1 API overview

Type

Description

Monitoring APIs (v1)

Monitoring APIs, including the APIs that query metrics; query and add monitoring data; add, modify, query, and delete threshold rules; add, modify, query, and delete application discovery rules.

Monitoring APIs (v2)

Monitoring APIs, including the APIs that query time series objects and time series data, and add, modify, query, and delete threshold rules.

NOTE:

You are advised to use v2 APIs, which are newly opened.

The v1 APIs are not recommended for new users and will be taken offline later.

Auto Scaling APIs

Auto scaling APIs, including the APIs that create, delete, and update policies; query one or all policies; update and query policy group attributes.

Log APIs

Log APIs, including the API that query logs.

Event and Alarm APIs

API that reports events and alarms.

Agent APIs

API that query Agent information.

Application Discovery Rule APIs

Application discovery rule APIs, including the APIs that add, modify, query, and delete application discovery rules.

Prometheus Monitoring APIs

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.

Monitoring APIs (v1)

API

Description

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 of metrics within a specified period. You can specify a dimension or period to query.

Adding monitoring data

Add one or more monitoring data records.

Adding a threshold rule

Add a threshold rule.

Modifying a threshold rule

Modify a threshold rule.

Querying the threshold rule list

Query all threshold rules.

Querying a threshold rule

Query a threshold rule.

Deleting a threshold rule

Delete a threshold rule.

Adding or modifying one or more application discovery rules

Add or modify one or more application discovery rules.

Deleting one or more application discovery rules

Delete one or more application discovery rules.

Querying an application discovery rule

Query an application discovery rule.

Monitoring APIs (v2)

API

Description

Querying the time series list

Query the time series list that can be monitored in the system. You can specify the time series namespace, name, dimension, and resource ID (format: resType_resId).

Querying time series data

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

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.

Auto Scaling APIs

API

Description

Creating a policy

Create a policy.

Querying the policy list

Query the details about all policies of a specified project.

Deleting a policy

Delete a specified policy.

Modifying a policy

Modify a policy.

Querying a policy

Query the details about a policy of a specified project.

Modifying policy group attributes

Modify policy group attributes.

Querying policy group attributes

Query policy group attributes.

Log APIs

API

Description

Querying logs

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

Event and Alarm APIs

API

Description

Querying events and alarms

Query events and alarms.

Counting events and alarms

Count events and alarms based on specified conditions.

Reporting events and alarms

Report events and alarms.

Agent APIs

API

Description

Querying Agent information

Query the Agent information about an account, a cluster, or a namespace.

Application Discovery Rule APIs

API

Description

Adding or modifying one or more application discovery rules

Add or modify one or more application discovery rules.

Deleting one or more application discovery rules

Delete one or more application discovery rules.

Querying an application discovery rule

Query an application discovery rule.

Prometheus Monitoring APIs

API

Description

Querying the expression calculation result in a specified period

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

Querying the expression calculation result at a specified time point

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

Querying the values of a tag

Query the values of a specified tag.

Obtaining the tag name list

Obtain the tag name list.

Querying metadata

Query the metadata of time series and corresponding tags.

Querying the calculation results of a PromQL expression in a specified period based on the Prometheus instance

Query the calculation result of a PromQL expression in a specified period based on the Prometheus instance.

Querying the calculation result of a PromQL expression at a specified time point based on the Prometheus instance

Query the calculation result of a PromQL expression at a specified time point based on the Prometheus instance.

Querying the values of a tag based on the Prometheus instance

Query the values of a specified tag based on the Prometheus instance.

Obtaining the tag name list based on the Prometheus instance

Obtain the tag name list based on the Prometheus instance.

Querying metadata based on the Prometheus instance

Query the metadata of time series and corresponding tags based on the Prometheus instance.