All Products
Search
Document Center

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

Last Updated:Jul 05, 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 (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.

Application Monitoring

APITitleDescription
QueryReleaseMetricQueryReleaseMetricQueries the metrics that are provided for different versions of a specified Enterprise Distributed Application Service (EDAS) or Kubernetes application.
DescribeTraceLicenseKeyDescribeTraceLicenseKeyQueries the license key.

Browser Monitoring

APITitleDescription
DeleteSourceMapDeleteSourceMapDelete s SourceMap file that was uploaded to Browser Monitoring.
GetSourceMapInfoGetSourceMapInfoObtains the details of the SourceMap file uploaded in Browser Monitoring.
GetRetcodeLogstoreGetRetcodeLogstoreQueries the Log Service project and Logstore that correspond to an application of browser monitoring.
GetRetcodeDataByQueryGetRetcodeDataByQueryQueries the Browser Monitoring data based on a query statement of Log Service.

Managed Service for Prometheus

APITitleDescription
CreateEnvironmentCreateEnvironmentCreates an environment instance.
InitEnvironmentInitEnvironmentInitializes an environment instance.
DescribeEnvironmentDescribeEnvironmentQueries the details of an environment.
UpdateEnvironmentUpdateEnvironmentUpdates the configuration of an environment.
ListEnvironmentsListEnvironmentsQueries environments.
DeleteEnvironmentDeleteEnvironmentDeletes an environment instance.
InstallEnvironmentFeatureInstallEnvironmentFeatureInstalls a feature.
DescribeEnvironmentFeatureDescribeEnvironmentFeatureQueries the details of a feature.
ListEnvironmentFeaturesListEnvironmentFeaturesQueries the features in an environment.
CreateEnvCustomJobCreateEnvCustomJobCreates a custom job for an environment.
UpdateEnvCustomJobUpdateEnvCustomJobUpdates a custom job for an environment.
ListEnvCustomJobsListEnvCustomJobsQueries the custom jobs of an environment.
DescribeEnvCustomJobDescribeEnvCustomJobQueries the details of a custom job for an environment.
DeleteEnvCustomJobDeleteEnvCustomJobDeletes a custom job for an environment.
CreateEnvPodMonitorCreateEnvPodMonitorCreates a PodMonitor for an environment.
DescribeEnvPodMonitorDescribeEnvPodMonitorQueries the PodMonitor details of an environment.
ListEnvPodMonitorsListEnvPodMonitorsQueries the PodMonitors of an environment.
UpdateEnvPodMonitorUpdateEnvPodMonitorUpdates the PodMonitor of an environment.
DeleteEnvPodMonitorDeleteEnvPodMonitorDeletes the PodMonitor of an environment.
CreateEnvServiceMonitorCreateEnvServiceMonitorCreates a ServiceMonitor for an environment.
DescribeEnvServiceMonitorDescribeEnvServiceMonitorQueries the ServiceMonitor details of an environment.
ListEnvServiceMonitorsListEnvServiceMonitorsQueries the ServiceMonitors of an environment.
UpdateEnvServiceMonitorUpdateEnvServiceMonitorUpdates the ServiceMonitor of an environment.
DeleteEnvServiceMonitorDeleteEnvServiceMonitorDeletes the ServiceMonitor of an environment.
InstallAddonInstallAddonInstalls an add-on.
DescribeAddonReleaseDescribeAddonReleaseQueries the release information of an add-on by name.
ListAddonsListAddonsQueries a list of cloud services that are supported in the new integration center.
UpgradeAddonReleaseUpgradeAddonReleaseUpdates the release information of an add-on.
ListAddonReleasesListAddonReleasesQueries the add-ons installed in an environment.
DeleteAddonReleaseDeleteAddonReleaseDelete AddonRelease data by AddonRelease name.
ListEnvironmentDashboardsListEnvironmentDashboardsQueries information about a dashboard of an environment instance.
EnableMetricEnableMetricEnables a discarded metric.
UpdatePrometheusMonitoringStatusUpdatePrometheusMonitoringStatusUpdates the status of the monitoring configuration of a Prometheus instance.
UpdatePrometheusMonitoringUpdatePrometheusMonitoringUpdates the monitoring configuration of a Prometheus instance.
ListPrometheusMonitoringListPrometheusMonitoringQueries the monitoring configuration of a Prometheus instance.
GetPrometheusMonitoringGetPrometheusMonitoringQueries the monitoring configuration of a Prometheus instance.
DeletePrometheusMonitoringDeletePrometheusMonitoringDeletes the monitoring configuration of a Prometheus instance.
CreatePrometheusMonitoringCreatePrometheusMonitoringCreates a monitoring configuration for a Prometheus instance.
AppendInstancesToPrometheusGlobalViewAppendInstancesToPrometheusGlobalViewAdds a data source to a global aggregation instance.
AddPrometheusInstanceAddPrometheusInstanceCreates a Prometheus instance for Remote Write.
AddPrometheusGlobalViewByAliClusterIdsAddPrometheusGlobalViewByAliClusterIdsCreates a global aggregation instance in Prometheus Service.
AddPrometheusGlobalViewAddPrometheusGlobalViewAdds a global aggregation instance in Prometheus Service.
AddAliClusterIdsToPrometheusGlobalViewAddAliClusterIdsToPrometheusGlobalViewAdds data sources to a global aggregation instance in Prometheus Service.
AddRecordingRuleAddRecordingRuleCreates or updates a recording rule of Managed Service for Prometheus.
SyncRecordingRulesSyncRecordingRulesSynchronizes the aggregation rule of a cluster to other clusters in a region.
AddIntegrationAddIntegrationIntegrates the dashboard and collection rules of Prometheus Service.
GetIntegrationStateGetIntegrationStateQueries the integration state of the dashboards and collection rules of Application Real-Time Monitoring Service (ARMS) Prometheus.
DeleteIntegrationDeleteIntegrationDeletes the collection rules for a Container Service for Kubernetes (ACK) cluster.
AddGrafanaAddGrafanaIntegrates the dashboard of Prometheus Service.
InstallCmsExporterInstallCmsExporterInstalls the cms-exporter collector.
OpenVClusterOpenVClusterActivates a virtual cluster.
DeletePrometheusGlobalViewDeletePrometheusGlobalViewDeletes a global aggregation instance from Prometheus Service.
RemoveAliClusterIdsFromPrometheusGlobalViewRemoveAliClusterIdsFromPrometheusGlobalViewRemoves data sources from a global aggregation instance.
RemoveSourcesFromPrometheusGlobalViewRemoveSourcesFromPrometheusGlobalViewRemoves custom data sources from a global aggregation instance in Prometheus Service.
DeleteCmsExporterDeleteCmsExporterUninstalls a Prometheus instance.
DelAuthTokenDelAuthTokenDisables an authentication token.
DeleteGrafanaResourceDeleteGrafanaResourceDeletes Grafana dashboard resources from a cluster monitored by Prometheus Service.
UninstallPromClusterUninstallPromClusterReleases a Prometheus instance.
ManageRecordingRuleManageRecordingRuleEdits the recording rule of a cluster monitored by Prometheus Service.
QueryPromInstallStatusQueryPromInstallStatusQueries whether the Prometheus agent is installed on a cluster.
GetPrometheusGlobalViewGetPrometheusGlobalViewQueries the information about a global aggregation instance.
ManageGetRecordingRuleManageGetRecordingRuleObtains the recording rule of a cluster monitored by Prometheus Service.
CheckServiceStatusCheckServiceStatusChecks the status of a service in the current cluster, such as whether the service is activated and whether an overdue payment exists.
GetPrometheusApiTokenGetPrometheusApiTokenQueries the token required for integrating Prometheus Service.
GetExploreUrlGetExploreUrlEnables the Explore feature of Grafana.
ListDashboardsListDashboardsQueries the Grafana dashboards of a Container Service for Kubernetes (ACK) cluster.
ListClusterFromGrafanaListClusterFromGrafanaQueries all Grafana dashboards in a specified region.
GetRecordingRuleGetRecordingRuleObtains the recording rule of a cluster.
ListCmsInstancesListCmsInstancesQueries the information about the collection of cloud services.
ListDashboardsByNameListDashboardsByNameUses Loki data sources and other data sources to create a dashboard in Prometheus Service.
GetAuthTokenGetAuthTokenObtains an authentication token. When you connect a Container Service for Kubernetes (ACK) cluster to Prometheus Service over the Internet, you must use a token for authentication.
GetClusterAllUrlGetClusterAllUrlObtains all the URLs of a cluster, including remote read and write URLs, Pushgateway URLs, and Grafana URLs.
GetCloudClusterAllUrlGetCloudClusterAllUrlQueries the read and write URLs of a CloudMonitor instance, such as Pushgateway and Grafana URLs.
ListPrometheusInstancesListPrometheusInstancesObtains all Prometheus instances in a region.
AddPrometheusRemoteWriteAddPrometheusRemoteWriteAdds a remote write configuration item to a Prometheus instance.
UpdatePrometheusRemoteWriteUpdatePrometheusRemoteWriteModifies a specific remote write configuration item of a Prometheus instance.
ListPrometheusRemoteWritesListPrometheusRemoteWritesQueries the remote write configuration items of a Prometheus instance.
GetPrometheusRemoteWriteGetPrometheusRemoteWriteQueries a specified remote write configuration item of a Prometheus instance.
DeletePrometheusRemoteWriteDeletePrometheusRemoteWriteDeletes remote write configuration items from a Prometheus instance.
InstallManagedPrometheusInstallManagedPrometheusInstalls a Prometheus agent for serverless Kubernetes (ASK) clusters or Elastic Compute Service (ECS) clusters.
UninstallManagedPrometheusUninstallManagedPrometheusUninstalls a Prometheus agent.
GetManagedPrometheusStatusGetManagedPrometheusStatusQueries the installation status of a Prometheus agent in a serverless Kubernetes (ASK) cluster or an Elastic Compute Service (ECS) cluster.
BindPrometheusGrafanaInstanceBindPrometheusGrafanaInstanceBinds a Grafana workspace to a Prometheus instance.
AddPrometheusIntegrationAddPrometheusIntegrationAdds an exporter to a Prometheus instance for Container Service or a Prometheus instance for ECS.
UpdatePrometheusIntegrationUpdatePrometheusIntegrationModifies the configurations of an exporter that is integrated into a Prometheus instance for Container Service or a Prometheus instance for ECS.
DeletePrometheusIntegrationDeletePrometheusIntegrationDeletes an exporter from a Prometheus instance for Container Service or a Prometheus instance for ECS.
GetPrometheusIntegrationGetPrometheusIntegrationQueries the information about an exporter that is integrated into a Prometheus instance for Container Service or a Prometheus instance for ECS.
ListPrometheusIntegrationListPrometheusIntegrationQueries a list of exporters that are integrated into a Prometheus instance. Only aliyun-cs and ecs instances are supported.
GetPrometheusInstanceGetPrometheusInstanceQueries the information about a Prometheus instance.
ListPrometheusInstanceByTagAndResourceGroupIdListPrometheusInstanceByTagAndResourceGroupIdQueries Prometheus instances by tag and resource group.
CreatePrometheusInstanceCreatePrometheusInstanceCreates a Prometheus instance.
UpdatePrometheusInstanceUpdatePrometheusInstanceUpdates the information about a Prometheus instance.
UpdatePrometheusGlobalViewUpdatePrometheusGlobalViewUpdates the data sources of Prometheus instance for GlobalView.

Alert Management

APITitleDescription
ListIntegrationListIntegrationQueries alert integrations.

Prometheus Alerts (Outdated)

APITitleDescription
DeletePrometheusAlertRuleDeletePrometheusAlertRuleDeletes an alert rule of Prometheus Service.
DescribePrometheusAlertRuleDescribePrometheusAlertRuleQueries the details about an alert rule of Prometheus Service.

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
CheckCommercialStatusCheckCommercialStatusChecks whether Application Real-Time Monitoring Service (ARMS) is available for commercial use in a region.