全部产品
Search

搜索本产品

    可观测监控 Prometheus 版：API概览

    文档中心

    可观测监控 Prometheus 版：API概览

    更新时间：Dec 13, 2024
    本产品（应用实时监控服务ARMS/2019-08-08）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。
    在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

    可观测监控 Prometheus 版

    API标题API概述
    AddTagToFlinkClusterPrometheus Flink集群打标主要将用户Flink工作空间对应的Prometheus实例打上工作空间ID、工作空间名称这两个Tag。
    CreateEnvironment创建环境创建环境实例。
    InitEnvironment初始化环境实例初始化环境实例。
    DescribeEnvironment查询环境详情查询环境详情。
    UpdateEnvironment更新环境信息更新环境信息。
    ListEnvironments查询环境列表查询环境列表。
    DeleteEnvironment删除环境删除环境实例。
    DescribeAddonMetrics查询Addon指标信息查询指定Addon的指标详情。
    InstallEnvironmentFeature安装Feature安装Feature。
    DescribeEnvironmentFeature查询Feature详情查询Feature详情。
    UpgradeEnvironmentFeature更新Feature更新Feature信息。
    RestartEnvironmentFeature重启Feature重启feature。
    ListEnvironmentFeatures查询环境中的Feature查询环境中的Feature。
    DeleteEnvironmentFeature删除feature删除feature。
    CreateEnvCustomJob创建环境的自定义Job创建环境的自定义Job。
    UpdateEnvCustomJob更新环境的自定义Job更新环境的自定义Job。
    ListEnvCustomJobs查询环境的自定义Job列表查询环境的自定义Job列表。
    DescribeEnvCustomJob查询环境CustomJob详情查询环境CustomJob详情。
    DeleteEnvCustomJob删除环境的自定义Job删除环境的自定义job。
    CreateEnvPodMonitor创建环境的PodMonitor创建环境的PodMonitor。
    DescribeEnvPodMonitor查询环境的PodMonitor详情查询环境的PodMonitor详情。
    ListEnvPodMonitors查询环境的PodMonitor列表查询环境的PodMonitor列表。
    UpdateEnvPodMonitor更新环境的PodMonitor更新环境的PodMonitor。
    DeleteEnvPodMonitor删除环境PodMonitor删除环境PodMonitor。
    CreateEnvServiceMonitor创建环境的ServiceMonitor创建环境的ServiceMonitor。
    DescribeEnvServiceMonitor查询环境的ServiceMonitor详情查询环境的ServiceMonitor详情。
    ListEnvServiceMonitors查询环境的ServiceMonitor列表查询环境的ServiceMonitor列表。
    UpdateEnvServiceMonitor更新环境的ServiceMonitor更新环境的ServiceMonitor。
    DeleteEnvServiceMonitor删除环境ServiceMonitor删除环境ServiceMonitor。
    InstallAddon安装Addon信息安装Addon信息。
    DescribeAddonRelease查看AddonRelease详情通过名称查询AddonRelease详情。
    ListAddons查询addon列表新版接入中心产品列表。
    UpgradeAddonRelease更新AddonRelease信息更新AddonRelease信息。
    ListAddonReleases查询环境中安装的Addon查询环境中安装的Addon。
    DeleteAddonRelease删除AddonRelease信息通过AddonRelease名称删除AddonRelease数据。
    ListEnvironmentDashboards查询环境中的大盘信息查询环境中的大盘信息。
    EnableMetric启用单个废弃指标启用废弃指标。
    UpdateMetricDrop更新废弃指标列表更新废弃指标列表。
    UpdatePrometheusMonitoringStatus更新Prometheus实例监控配置状态更新Prometheus实例监控配置状态。
    UpdatePrometheusMonitoring更新Prometheus实例监控配置更新Prometheus实例监控配置。
    ListPrometheusMonitoring查询Prometheus实例监控配置查询Prometheus实例监控配置。
    GetPrometheusMonitoring查询Prometheus实例指定监控配置查询Prometheus实例指定监控配置。
    DeletePrometheusMonitoring删除Prometheus实例监控配置删除Prometheus实例监控配置。
    CreatePrometheusMonitoring创建Prometheus实例的监控配置创建Prometheus实例的监控配置。
    AppendInstancesToPrometheusGlobalView新增Prometheus实例数据源增加ARMS Prometheus监控聚合实例中的数据源，将数据源添加到Prometheus聚合实例。
    AddPrometheusInstance创建RemoteWrite类型的Prometheus实例创建RemoteWrite类型Prometheus实例。
    AddPrometheusGlobalViewByAliClusterIds新增容器聚合实例增加ARMS Prometheus监控的聚合实例。
    AddPrometheusGlobalView新增聚合实例增加ARMS Prometheus监控的聚合实例。
    AddAliClusterIdsToPrometheusGlobalView新增聚合实例数据源增加ARMS Prometheus监控聚合实例的数据源。
    AddRecordingRule创建RecordingRule创建或者更新Prometheus监控的RecordingRule规则。
    SyncRecordingRules将某个集群的聚合规则批量同步到全Region的其他目标集群将某个集群的聚合规则批量同步到全Region的其他目标集群。
    AddIntegration集成大盘及采集规则集成ARMS Prometheus监控的大盘以及采集规则。
    GetIntegrationState获取Integration的接入状态来获取Integration的接入状态。
    DeleteIntegration删除Integration接入的采集规则删除Integration接入的采集规则。
    AddGrafana集成Prometheus监控大盘集成ARMS Prometheus监控的大盘。
    InstallCmsExporter安装云服务采集器安装云服务采集器。
    OpenVCluster开通虚拟集群开通虚拟集群。
    DeletePrometheusGlobalView删除Prometheus聚合实例删除Prometheus聚合实例。
    RemoveAliClusterIdsFromPrometheusGlobalView删除聚合实例数据源移除ARMS Prometheus监控聚合实例的某些数据源。
    RemoveSourcesFromPrometheusGlobalView删除聚合实例非阿里数据源移除ARMS Prometheus监控聚合实例中的数据源，仅支持删除非阿里数据源。
    DeleteCmsExporter卸载Prometheus for 云服务实例来卸载Prometheus for 云服务实例。
    DelAuthToken关闭鉴权token关闭鉴权token。
    DeleteGrafanaResource删除集群的大盘资源删除ARMS Prometheus监控集群中的Grafana大盘资源。
    UninstallPromCluster卸载prometheus集群来卸载ARMS Prometheus集群实例。
    ManageRecordingRule修改聚合规则编辑ARMS Prometheus的RecordingRule聚合规则。
    QueryPromInstallStatus查询集群安装状态来查询ARMS Prometheus集群的安装状态。
    ListPrometheusGlobalView获取聚合实例列表增加ARMS Prometheus监控的聚合实例，获取聚合实例列表。
    GetPrometheusGlobalView获取聚合实例的数据源详情增加ARMS Prometheus监控的聚合实例，获取指定聚合实例的详细数据源情况。
    ManageGetRecordingRule获取聚合规则获取ARMS Prometheus的RecordingRule聚合规则。
    CheckServiceStatus检查产品开通状态检查集群当前的服务状态，例如是否开通服务，是否欠费等。
    GetPrometheusApiToken获取Prometheus监控所需Token获取集成ARMS Prometheus监控所需的Token。
    GetExploreUrl获取Grafana的Explore功能获取使用Grafana的Explore功能。
    ListDashboards获取集群的大盘列表获取集群的Grafana大盘的列表。
    ListClusterFromGrafana列出指定地域下的所有Grafana大盘列出指定地域下的所有Grafana大盘。
    GetRecordingRule获取聚合规则获取集群的RecordingRule聚合规则。
    ListCmsInstances查询云服务采集状态查询云服务采集状态。
    ListDashboardsByName创建Loki数据源和相关的多数据源大盘来创建与Prometheus关联的Loki数据源和相关的多数据源大盘。
    GetAuthToken获取公网读写鉴权获取公网读写鉴权Token。
    GetClusterAllUrl获取集群所有地址获取集群所有地址。包括远程读写地址、 Push Gateway地址、 Grafana地址。
    GetCloudClusterAllUrl获取云产品各种URL获取云监控云产品读写地址，pushgateway，grafana 地址。
    ListPrometheusInstances获取所有正常实例获取Prometheus的所有正常实例。
    InstallManagedPrometheus创建托管Prometheus创建托管（ASK/ECS）Prometheus。
    UninstallManagedPrometheus卸载托管Prometheus卸载托管（ASK/ECS/ACKoNE）Prometheus。
    GetManagedPrometheusStatus获取托管版Prometheus安装状态获取托管版（ask、ecs和one）Prometheus实例的安装状态。
    BindPrometheusGrafanaInstance绑定Prometheus实例使用的Grafana工作区ID绑定Prometheus实例使用的Grafana工作区ID。
    AddPrometheusIntegration增加Prometheus实例的集成中心Exporter实例增加Prometheus实例的集成中心Exporter实例（仅支持aliyun-cs、ecs两种类型的实例）。
    UpdatePrometheusIntegration更改Prometheus实例集成中心Exporter配置更改Prometheus实例（仅支持aliyun-cs、ecs两种类型的实例）集成中心Exporter配置。
    DeletePrometheusIntegration删除Prometheus实例集成中心Exporter实例删除Prometheus实例集成中心Exporter实例（仅支持aliyun-cs、ecs两种类型的实例）。
    GetPrometheusIntegration获取Prometheus实例指定集成中心Exporter实例获取Prometheus实例（仅支持aliyun-cs、ecs两种类型的实例）指定集成中心Exporter实例。
    ListPrometheusIntegration查询Prometheus实例集成中心Exporter实例列表查询Prometheus实例（仅支持aliyun-cs、ecs两种类型的实例）集成中心Exporter实例列表。
    GetPrometheusInstance获取指定Prometheus实例信息获取指定Prometheus实例信息。
    ListPrometheusInstanceByTagAndResourceGroupId根据标签和资源组查询Prometheus实例根据标签和资源组查询Prometheus实例。
    CreatePrometheusInstance新建Prometheus实例新建Prometheus实例。
    UpdatePrometheusInstance更新Prometheus实例信息更新Prometheus实例信息。
    UpdatePrometheusGlobalView更新Prometheus for GlobalView聚合数据源更新Prometheus for GlobalView聚合数据源。

    Prometheus报警规则（旧版）

    API标题API概述
    CreatePrometheusAlertRule创建告警规则创建告警规则。
    DeletePrometheusAlertRule删除告警规则删除Prometheus告警规则。
    UpdatePrometheusAlertRule 更新告警规则调用UpdatePrometheusAlertRule接口更新Prometheus报警规则。
    DescribePrometheusAlertRule查看告警规则查看Prometheus告警规则。
    ListPrometheusAlertRules查看告警规则列表查看Prometheus告警规则列表。
    ListPrometheusAlertTemplates查看告警模板列表调用ListPrometheusAlertTemplates接口查看Prometheus告警模板列表。

    访问控制

    API标题API概述
    OpenArmsServiceSecondVersion开通ARMS开通ARMS下指定子产品的后付费功能。
    OpenXtraceDefaultSLR开通可观测链路 OpenTelemetry 版服务关联角色开通可观测链路 OpenTelemetry 版服务关联角色AliyunServiceRoleForXtrace。
    OpenArmsDefaultSLR开通ARMS服务关联角色开通ARMS服务关联角色AliyunServiceRoleForARMS。
    ChangeResourceGroupARMS资源转组修改资源所属资源组。
    TagResources创建标签资源关系用于给ARMS资源实例打标签。
    UntagResources删除标签资源关系用于删除ARMS资源实例标签。

    产品计费

    API标题API概述
    GetCommercialStatus获取商业化状态查看当前账号是否开通对应产品的商业化版本。
    CheckCommercialStatus检查产品商业化状态检查产品的商业化开通状态。
    QueryCommercialUsage查询可观测用量数据查询写入量数据，支持应用监控、可观测链路OpenTelemetry版、Prometheus、用户体验监控四大产品用量数据。