查詢Prometheus實例指定監控配置。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| arms:GetPrometheusMonitoring | get |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
| ClusterId | string | 是 | Prometheus 實例 ID。 | cc7a37ee31aea4ed1a059eff8034b**** |
| Type | string | 是 | 容器服務類型的實例支持：serviceMonitor、podMonitor、customJob、probe。 ecs 類型的實例支持：customJob、probe。 | customJob |
| MonitoringName | string | 是 | 監控配置名稱。 | customJob1 |
返回參數
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-25 | OpenAPI 返回結構發生變更 | 查看變更詳情 |