Updated on 2025-06-27 GMT+08:00

API Overview

AOM provides alarm, monitoring, Prometheus monitoring, log, Prometheus instance, CMDB, automation, and configuration management APIs, helping you quickly and cost-effectively maintain applications. AOM 2.0 APIs are available in ME-Riyadh, CN North-Beijing1, CN North-Beijing4, CN North-Beijing2, CN East-Shanghai1, CN East-Shanghai2, CN East-Qingdao, CN East 2, CN South-Guangzhou, CN Southwest-Guiyang1, CN-Hong Kong, AP-Bangkok, AP-Singapore, AP-Jakarta, AP-Manila, AF-Cairo, AF-Johannesburg, TR-Istanbul, LA-Mexico City1, LA-Mexico City2, LA-Sao Paulo1, and LA-Santiago.

Table 1 API overview

Type

API

Alarm APIs

Alarm APIs, including the APIs for adding, updating, and deleting event alarm rules.

Monitoring APIs

Monitoring APIs, including the APIs for querying metrics, and querying and adding monitoring data.

Prometheus Monitoring APIs

Prometheus monitoring APIs, including the APIs for querying the expression calculation result in a specified period or at a specified time point.

Log APIs

Log APIs, including the API for querying logs.

Prometheus Instance APIs

APIs related to Prometheus instances, including adding and querying Prometheus instances, and uninstalling hosted Prometheus instances.

Configuration Management APIs

Configuration APIs, including the APIs for querying the cloud services for which AOM 2.0 has been granted permissions, and querying ICAgents installed on cluster hosts.

Dashboard APIs

Dashboard APIs, including APIs for querying and deleting dashboards.

CMDB APIs (AOM 2.0 only)

CMDB APIs, including the APIs for adding, modifying, querying, and deleting applications.

Automation APIs (AOM 2.0 only)

Automation APIs, including the APIs for creating tasks and creating and executing scripts.

Automation APIs are available only in CN North-Beijing4, CN East-Shanghai1, CN East-Shanghai2, CN South-Guangzhou, and ME-Riyadh regions.