Updated on 2023-08-22 GMT+08:00

API Overview

APIs provided by APM are extended APIs. By using the APIs provided by APM, you can use all functions of APM. For example, call an API to query applications.

Table 1 describes the APIs provided by APM.

Table 1 APM API description

API

Description

Querying the application list

The application list can be queried.

Querying the PodLB address of the master service

The podLB address of the master service in a region can be queried.

Obtaining the AK/SK

The created AK/SK can be queried.

Querying the environment list

The components, environments, and Agents in a specified region can be queried.

Saving the monitoring item configuration

The monitoring item configuration can be saved.

Querying the monitoring item list

The monitoring item list can be queried.

Querying application Agents

The Agents of an application can be queried.

Enabling or disabling the collection function for an instance

The collection function of a specified instance can be enabled or disabled.

Deleting an Agent

An Agent can be deleted.

Querying the regions where APM is enabled

The regions where APM is enabled by the current user can be queried.

Querying the regions where APM is supported

The regions where APM is supported can be queried.

Querying an application tree

An application tree can be queried.

Querying environment tags

Environment tags can be queried.

Querying the component list

The component list can be queried.

Querying the environment list

The environment list of a component can be queried.

Deleting a component based on the component ID

A specified component can be deleted.

Querying the details of an application

The details of an application can be queried.

Querying the details of a sub-application

The details of a sub-application can be queried.

Querying the configuration of a monitoring item

The configuration of a monitoring item can be queried.

Querying the trace topology

The trace topology can be queried.

Querying the details of an event

The details of an event can be queried.

Querying the span data

The span data can be queried.

Querying trace data

All trace data can be queried by trace ID.

Querying a trend graph

A trend graph can be queried.

Querying summary table data

Data in the summary table can be queried.

Querying a raw data table

A raw data table can be queried.

Querying the raw data details

Raw data details can be queried.

Querying the instance information list

The instance information list can be queried.

Querying the monitoring item information

Monitoring item information can be queried.

Creating an AK/SK

An AK/SK can be created.

Querying an AK/SK

The AK/SK of a tenant can be queried.

Deleting an AK/SK

An AK/SK can be deleted.

Querying the alarm list

The list of generated alarms can be queried.

Querying the alarm message list

The list of generated alarm messages can be queried.

Global application topology

The global topology of an application can be queried.

Querying the topology of a component environment

The topology of a component environment can be queried.

Querying the URL tracing configuration list

The URL tracing configuration list can be queried.

Querying a region's environments on which URLs are added for tracing

A region's environments on which URLs are added for tracing can be queried.

Querying the URL tracing view list

The list of invoked URL tracing views can be queried.

Querying the details of a URL tracing view

The details of a URL tracing view can be queried.