GetPrometheusMonitoring - 查询Prometheus实例指定监控配置

更新时间:2024-11-05 05:58:27

查询Prometheus实例指定监控配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
操作访问级别资源类型条件关键字关联操作
arms:GetPrometheusMonitoringget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
ClusterIdstring

Prometheus 实例 ID。

cc7a37ee31aea4ed1a059eff8034b****
Typestring

容器服务类型的实例支持:serviceMonitor、podMonitor、customJob、probe。 ecs 类型的实例支持:customJob、probe。

customJob
MonitoringNamestring

监控配置名称。

customJob1

返回参数

名称类型描述示例值
名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

78901766-3806-4E96-8E47-CFEF59E4****
Codeinteger

状态码。说明 200 表示成功。

200
Dataobject

返回结构体。

ClusterIdstring

Prometheus 实例 ID。

c589a1b8db05c4561aefbb898ca8fb1cf
MonitoringNamestring

监控配置名称。

customJob1
Typestring

监控配置类型:serviceMonitor、podMonitor、customJob、probe。

serviceMonitor
Statusstring

监控配置状态:run, stop。

run
ConfigYamlstring

监控配置 yaml 串。

参见返回参数补充说明。
Messagestring

返回结果的提示信息。

message

serviceMonitor 示例:

apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
  name: tomcat-demo
  namespace: default
spec:
  endpoints:
    - interval: 30s
      path: /metrics
      port: tomcat-monitor
  namespaceSelector:
    any: true
  selector:
    matchLabels:
      app: tomcat

podMonitor 示例:

apiVersion: "monitoring.coreos.com/v1"
kind: "PodMonitor"
metadata:
  name: "podmonitor-demo"
  namespace: "default"
spec:
  namespaceSelector:
    any: true
  podMetricsEndpoints:
    - interval: "30s"
      path: "/metrics"
      port: "tomcat-monitor"
  selector:
    matchLabels:
      app: "nginx2-exporter"

customJob 示例:

scrape_configs:
  - job_name: prometheus1
    honor_timestamps: false
    honor_labels: false
    scheme: http
    metrics_path: /metric
    static_configs:
      - targets:
          - 127.0.0.1:9090

probe 示例:

apiVersion: monitoring.coreos.com/v1
kind: Probe
metadata:
  name: name1-tcp-blackbox #规则:xxx-{tcp/http/ping}-blackbox
  namespace: arms-prom #可选
spec:
  interval: 30s
  jobName: blackbox
  module: tcp_connect
  prober:
    path: /blackbox/probe
    scheme: http
    url: 'localhost:9335'
  targets:
    staticConfig:
      static:
        - 'arms-prom-admin.arms-prom:9335'

示例

正常返回示例

JSON格式

{
  "RequestId": "78901766-3806-4E96-8E47-CFEF59E4****",
  "Code": 200,
  "Data": {
    "ClusterId": "c589a1b8db05c4561aefbb898ca8fb1cf",
    "MonitoringName": "customJob1",
    "Type": "serviceMonitor",
    "Status": "run",
    "ConfigYaml": "参见返回参数补充说明。"
  },
  "Message": "message"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
2023-05-25OpenAPI 返回结构发生变更查看变更详情
  • 本页导读 (1)
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史
AI助理

点击开启售前

在线咨询服务

阿里云 AI 助理已上线!

快来体验一下吧。