API standard and pre-built SDKs in multi-language
This product (ARMS/2019-08-08) OpenAPI adopts an RPC-style signature mechanism. For implementation details, please refer to the Signature Mechanism documentation.To streamline development, we provide official SDKs for major programming languages. Using the SDK allows you to call APIs directly without worrying about low-level details such as request signatures, significantly lowering the barrier to entry and reducing integration complexity.
Custom signature
If your use case requires direct API integration with custom signatures, consult our technical support team first. Join our DingTalk support group (147535001692) to receive expert guidance.
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Monitoring Metrics
| API | Title | Description |
|---|---|---|
| QueryMetricByPage | QueryMetricByPage | Queries an Application Monitoring metric or a Browser Monitoring metric. |
Application Monitoring
| API | Title | Description |
|---|---|---|
| GetTraceApp | GetTraceApp | Queries the details of an application monitoring task. |
| GetAppJVMConfig | GetAppJVMConfig | Obtain the JVM configuration information of each instance of the application |
| QueryAppTopology | QueryAppTopology | Queries the topology of an application. |
| GetAppApiByPage | GetAppApiByPage | Queries the API operations of application monitoring by page. |
| GetTrace | GetTrace | Queries the details of a trace. |
| GetStack | GetStack | Queries the information of a method stack. |
| GetMultipleTrace | GetMultipleTrace | Queries the details of one or more traces. |
| ConfigApp | ConfigApp | Turns on or off the main switch of an ARMS agent, or queries the status of the main switch. |
| SaveTraceAppConfig | SaveTraceAppConfig | Modifies the settings of Application Monitoring, such as trace sampling and agent switch settings. |
| GetTraceAppConfig | GetTraceAppConfig | Queries all custom settings of an application monitored by Application Monitoring, such as trace sampling settings and agent switches. This operation is applicable only to applications that are monitored by Application Monitoring. It is not applicable to applications that are monitored by Managed Service for OpenTelemetry. |
| DeleteTraceApp | DeleteTraceApp | Deletes an application based on a specified process identifier (PID) and application type. |
| QueryReleaseMetric | QueryReleaseMetric | Queries the metrics that are provided for different versions of a specified Enterprise Distributed Application Service (EDAS) or Kubernetes application. |
| ListTraceApps | ListTraceApps | Queries all Application Monitoring tasks in a specified region. |
| SearchTraceAppByName | SearchTraceAppByName | Queries Application Monitoring tasks by application name. |
| SearchTraceAppByPage | SearchTraceAppByPage | Queries Application Monitoring tasks by page. |
| SearchTraces | SearchTraces | Queries traces by time, application name, IP address, span name, and tag. |
| SearchTracesByPage | SearchTracesByPage | Queries traces by page. You can query traces by time range, application name, IP address, span name, or tag. |
| GetAgentDownloadUrlV2 | GetAgentDownloadUrlV2 | Obtains the URL for downloading an agent. |
| GetAgentDownloadUrl | GetAgentDownloadUrl | Obtains the URL for downloading an agent. |
| DescribeTraceLicenseKey | DescribeTraceLicenseKey | Queries the license key. |
| ListInsightsEvents | ListInsightsEvents | Queries the abnormal Insights events within a specified period of time. |
| QueryAppMetadata | QueryAppMetadata | Queries the encoding mapping content based on the metadata IDs and metadata type. |
| DeleteAppList | DeleteAppList | Deletes multiple applications at a time based on the process IDs (PIDs). |
| DoInsightsAction | DoInsightsAction | Performs actions based on the specified module type. |
Service Activation
| API | Title | Description |
|---|---|---|
| OpenArmsServiceSecondVersion | OpenArmsServiceSecondVersion | Activates a specified pay-as-you-go sub-service of Application Real-Time Monitoring Service (ARMS). |
| OpenXtraceDefaultSLR | OpenXtraceDefaultSLR | Activates the service-linked role AliyunServiceRoleForXtrace for Tracing Analysis. |
| OpenArmsDefaultSLR | OpenArmsDefaultSLR | Activates the service-linked role AliyunServiceRoleForARMS for Application Real-Time Monitoring Service (ARMS). |
| ChangeResourceGroup | ChangeResourceGroup | Moves a resource to a specific resource group. |
| TagResources | TagResources | Adds tags to ARMS resources. |
| UntagResources | UntagResources | Removes tags from ARMS resources. |
Billing
| API | Title | Description |
|---|---|---|
| GetCommercialStatus | GetCommercialStatus | Queries whether the current account has activated the commercial edition of a service. |
| CheckCommercialStatus | CheckCommercialStatus | Checks whether Application Real-Time Monitoring Service (ARMS) is available for commercial use in a region. |
| QueryCommercialUsage | QueryCommercialUsage | Queries the amount of data written to Application Monitoring, Managed Service for OpenTelemetry, Managed Service for Prometheus, and Real User Monitoring (RUM). |