This product(
ARMS/2019-08-08) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (11370001915) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
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 | Query App Topology. |
| 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 turns 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. |
| DeleteTraceApp | DeleteTraceApp | Deletes an application based on a specified process identifier (PID) and application type. |
| 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. |
| GetAgentDownloadUrl | GetAgentDownloadUrl | Obtains the download URL of the Application Real-Time Monitoring Service (ARMS) agent. |
| 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). |
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 |
|---|---|---|
| CheckCommercialStatus | CheckCommercialStatus | Checks whether Application Real-Time Monitoring Service (ARMS) is available for commercial use in a region. |