跳转到主要内容
API Explorer|API Explorer
监控与采集相关接口/指标采集
POSTMonitoring起始版本 1.0同步需要认证

新增采集目标

注册新prometheus采集目标指标采集。

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • nameString必填

    资源名称。

    示例： node-exporter-host01

  • endpointString必填

    接收端地址。

    示例： http://192.168.1.10:9100

  • metricsPathString必填

    指标抓取路径。

    示例： /metrics

  • scrapeIntervalInteger必填

    抓取周期。

    示例： 15

  • labelsLinkedHashMap必填

    标签列表。

    示例： (nested object)

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • uuidString

    资源的UUID，唯一标识该资源。

    示例： target-001-abc

  • nameString

    资源名称。

    示例： node-exporter-host01

  • endpointString

    接收端地址。

    示例： http://192.168.1.10:9100

  • metricsPathString

    指标抓取路径。

    示例： /metrics

  • scrapeIntervalInteger

    抓取周期。

    示例： 15

  • labelsLinkedHashMap

    标签列表。

    示例： (nested object)

  • enabledBoolean

    是否启用。

    示例： true

  • tenantUuidString

    租户UUID。

    示例： tenant-001-xyz

  • createdAtString

    创建时间。

    示例： 2026-01-15T08:00:00Z

请求地址

POST/api/v1/monitoring/scrape-targets

/api/v1/monitoring/scrape-targets

操作 ID

AddScrapeTarget

永久链接

请求示例

curl -X POST '{host}/api/v1/monitoring/scrape-targets' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"name":"node-exporter-host01","endpoint":"http://192.168.1.10:9100","metricsPath":"/metrics","scrapeInterval":15,"labels":"(nested object)","enabled":true,"tenantUuid":"tenant-001-xyz"}'

响应示例

200
{
  "uuid": "target-001-abc",
  "name": "node-exporter-host01",
  "endpoint": "http://192.168.1.10:9100",
  "metricsPath": "/metrics",
  "scrapeInterval": 15,
  "labels": null,
  "enabled": true,
  "tenantUuid": "tenant-001-xyz"
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史