All Products
Search

This Product

    Application Real-Time Monitoring Service:List of operations by function

    Document Center

    Application Real-Time Monitoring Service:List of operations by function

    Last Updated:Dec 13, 2024
    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 (78410016550) 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

    APITitleDescription
    QueryMetricByPageQueryMetricByPageQueries an Application Monitoring metric or a Browser Monitoring metric.

    Application Monitoring

    APITitleDescription
    GetTraceAppGetTraceAppQueries the details of an application monitoring task.
    GetAppJVMConfigGetAppJVMConfigObtain the JVM configuration information of each instance of the application
    QueryAppTopologyQueryAppTopologyQuery App Topology.
    GetAppApiByPageGetAppApiByPageQueries the API operations of application monitoring by page.
    GetTraceGetTraceQueries the details of a trace.
    GetStackGetStackQueries the information of a method stack.
    GetMultipleTraceGetMultipleTraceQueries the details of one or more traces.
    ConfigAppConfigAppTurns on or off the main switch of an ARMS agent, or queries the status of the main switch.
    SaveTraceAppConfigSaveTraceAppConfigModifies the settings of Application Monitoring, such as trace sampling and agent switch settings.
    GetTraceAppConfigGetTraceAppConfigQueries 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.
    DeleteTraceAppDeleteTraceAppDeletes an application based on a specified process identifier (PID) and application type.
    QueryReleaseMetricQueryReleaseMetricQueries the metrics that are provided for different versions of a specified Enterprise Distributed Application Service (EDAS) or Kubernetes application.
    ListTraceAppsListTraceAppsQueries all Application Monitoring tasks in a specified region.
    SearchTraceAppByNameSearchTraceAppByNameQueries Application Monitoring tasks by application name.
    SearchTraceAppByPageSearchTraceAppByPageQueries Application Monitoring tasks by page.
    SearchTracesSearchTracesQueries traces by time, application name, IP address, span name, and tag.
    SearchTracesByPageSearchTracesByPageQueries traces by page. You can query traces by time range, application name, IP address, span name, or tag.
    GetAgentDownloadUrlV2GetAgentDownloadUrlV2Obtains the download URL of the Application Real-Time Monitoring Service (ARMS) agent.
    GetAgentDownloadUrlGetAgentDownloadUrlObtains the download URL of the Application Real-Time Monitoring Service (ARMS) agent.
    DescribeTraceLicenseKeyDescribeTraceLicenseKeyQueries the license key.
    ListInsightsEventsListInsightsEventsQueries the abnormal Insights events within a specified period of time.
    QueryAppMetadataQueryAppMetadataQueries the encoding mapping content based on the metadata IDs and metadata type.
    DeleteAppListDeleteAppListDeletes multiple applications at a time based on the process IDs (PIDs).
    DoInsightsActionDoInsightsActionPerforms the corresponding operation based on the specified module type.

    Service Activation

    APITitleDescription
    OpenArmsServiceSecondVersionOpenArmsServiceSecondVersionActivates a specified pay-as-you-go sub-service of Application Real-Time Monitoring Service (ARMS).
    OpenXtraceDefaultSLROpenXtraceDefaultSLRActivates the service-linked role AliyunServiceRoleForXtrace for Tracing Analysis.
    OpenArmsDefaultSLROpenArmsDefaultSLRActivates the service-linked role AliyunServiceRoleForARMS for Application Real-Time Monitoring Service (ARMS).
    ChangeResourceGroupChangeResourceGroupMoves a resource to a specific resource group.
    TagResourcesTagResourcesAdds tags to ARMS resources.
    UntagResourcesUntagResourcesRemoves tags from ARMS resources.

    Billing

    APITitleDescription
    GetCommercialStatusGetCommercialStatusQueries whether the current account has activated the commercial edition of a service.
    CheckCommercialStatusCheckCommercialStatusChecks whether Application Real-Time Monitoring Service (ARMS) is available for commercial use in a region.
    QueryCommercialUsageQueryCommercialUsageQueries the amount of data written to Application Monitoring, Managed Service for OpenTelemetry, Managed Service for Prometheus, and Real User Monitoring (RUM).