查询Prometheus实例监控配置。
目前该API接口已标记为弃用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID。默认为 |
cn-hangzhou |
| ClusterId |
string |
是 |
集群 ID。 |
cc7a37ee31aea4ed1a059eff8034b**** |
| Type |
string |
否 |
容器服务类型的实例支持：serviceMonitor、podMonitor、customJob、probe。 ecs 类型的实例支持：customJob、probe。 |
serviceMonitor |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
D80ADAAC-8C32-5479-BD14-C28CF832**** |
| Code |
integer |
状态码。说明 200 表示成功。 |
200 |
| Data |
array<object> |
返回结构体。 |
|
|
object |
返回结构体。 |
||
| ClusterId |
string |
Prometheus 实例 ID。 |
c589a1b8db05c4561aefbb898ca8fb1cf |
| MonitoringName |
string |
监控配置名称。 |
podMonitor1 |
| Type |
string |
监控配置类型。 |
podMonitor |
| ConfigYaml |
string |
监控配置 yaml 串。 |
参见返回参数补充说明。 |
| Status |
string |
监控配置状态。 |
run |
| Message |
string |
返回结果的提示信息。 |
success |
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": "D80ADAAC-8C32-5479-BD14-C28CF832****",
"Code": 200,
"Data": [
{
"ClusterId": "c589a1b8db05c4561aefbb898ca8fb1cf",
"MonitoringName": "podMonitor1",
"Type": "podMonitor",
"ConfigYaml": "参见返回参数补充说明。",
"Status": "run"
}
],
"Message": "success"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。