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. |
Browser Monitoring
| API | Title | Description |
|---|---|---|
| Upload | Upload | Uploads a SourceMap file to ARMS Browser Monitoring. |
| DeleteSourceMap | DeleteSourceMap | Deletes the SourceMap files uploaded in Browser Monitoring. |
| GetSourceMapInfo | GetSourceMapInfo | Obtains the details of the SourceMap file uploaded in Browser Monitoring. |
| CreateRetcodeApp | CreateRetcodeApp | Creates a Browser Monitoring task for an application. |
| GetRetcodeShareUrl | GetRetcodeShareUrl | Queries the share URL of an application monitored by Browser Monitoring. |
| DeleteRetcodeApp | DeleteRetcodeApp | Deletes a Browser Monitoring task. |
| SetRetcodeShareStatus | SetRetcodeShareStatus | Turns on or turns off logon-free sharing for an application monitored by Browser Monitoring. |
| ListRetcodeApps | ListRetcodeApps | Queries the Browser Monitoring tasks in a region. |
| SearchRetcodeAppByPage | SearchRetcodeAppByPage | Queries Browser Monitoring tasks by page. |
| GetRetcodeLogstore | GetRetcodeLogstore | Queries the Log Service project and Logstore that correspond to an application of browser monitoring. |
| GetRetcodeDataByQuery | GetRetcodeDataByQuery | Queries the Browser Monitoring data based on a query statement of Log Service. |
| GetRetcodeAppByPid | GetRetcodeAppByPid | Queries the objects of a Browser Monitoring application by process identifier (PID). |
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). |