List Prometheus scrape targets

Point an http_sd_configs job at this endpoint to discover and scrape all services in the organization automatically. Prometheus refreshes the target list on every discovery poll, so newly created and deleted services are picked up without configuration changes.

Discovered targets scrape with filtered_metrics=true by default; pass ?filtered_metrics=false to this endpoint to discover unfiltered targets. See the Prometheus integration guide for more on the exported metrics.

GET

organizations

{organizationId}

prometheus

discovery

List Prometheus scrape targets

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

[
  {
    "targets": [
      "<string>"
    ],
    "labels": {
      "__scheme__": "<string>",
      "__metrics_path__": "<string>",
      "__param_filtered_metrics": "<string>",
      "clickhouse_org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "clickhouse_service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "clickhouse_discovery_service_name": "<string>"
    }
  }
]

{
  "status": 400,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "status": 500,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Returns one Prometheus scrape target per service in the organization, in the HTTP service discovery (http_sd) format. Only services the API key is authorized to view are included; services that are being deleted or have been deleted are omitted. Point an http_sd_configs job at this endpoint to discover and scrape all services in the organization automatically. Prometheus refreshes the target list on every discovery poll, so newly created and deleted services are picked up without configuration changes. Discovered targets scrape with filtered_metrics=true by default; pass ?filtered_metrics=false to this endpoint to discover unfiltered targets. See the Prometheus integration guide for more on the exported metrics.

授权

Authorization

string

header

必填

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

路径参数

organizationId

string<uuid>

必填

ID of the requested organization.

查询参数

filtered_metrics

string<boolean>

Whether discovered targets scrape a filtered list of metrics. Sets the filtered_metrics parameter on each discovered target. Defaults to true.

响应

Successful response

targets

string[]

Host (and port) of the ClickHouse Cloud API.

labels

object

Show child attributes

最后修改于 2026年9月6日

List Prometheus scrape targets

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

[
  {
    "targets": [
      "<string>"
    ],
    "labels": {
      "__scheme__": "<string>",
      "__metrics_path__": "<string>",
      "__param_filtered_metrics": "<string>",
      "clickhouse_org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "clickhouse_service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "clickhouse_discovery_service_name": "<string>"
    }
  }
]

{
  "status": 400,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "status": 500,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Get started

Services and infrastructure

Bring Your Own Cloud

Data and integrations

Connect and query

Access management

Security and compliance

Monitoring and backups

AI tools and agents

Cloud API

Billing

Support

ClickHouse Private

List Prometheus scrape targets

授权

路径参数

查询参数

响应