Listar ClickPipes

Este endpoint está em beta. O contrato da API é estável, e não são esperadas alterações incompatíveis no futuro.

Retorna uma lista de ClickPipes.

GET /v1/organizations/{organizationId}/services/{serviceId}/clickpipes

Listar ClickPipes

cURL

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

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipes"

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}/services/{serviceId}/clickpipes', 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}/services/{serviceId}/clickpipes",
  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}/services/{serviceId}/clickpipes"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipes")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipes")

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

200

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": [
    {
      "createdAt": "<string>",
      "destination": {
        "columns": [
          {
            "name": "<string>",
            "type": "<string>"
          }
        ],
        "database": "<string>",
        "managedTable": true,
        "table": "<string>",
        "tableDefinition": {
          "engine": {
            "columnIds": [
              "<string>"
            ],
            "versionColumnId": "<string>"
          },
          "partitionBy": "<string>",
          "primaryKey": "<string>",
          "sortingKey": [
            "<string>"
          ]
        }
      },
      "fieldMappings": [
        {
          "destinationField": "<string>",
          "sourceField": "<string>"
        }
      ],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "scaling": {
        "concurrency": 123,
        "replicaCpuMillicores": 1062,
        "replicaMemoryGb": 4.25,
        "replicas": 123
      },
      "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "settings": {
        "clickhouse_max_download_threads": 4,
        "clickhouse_max_insert_threads": 1,
        "clickhouse_max_threads": 8,
        "clickhouse_min_insert_block_size_bytes": 1073741824,
        "clickhouse_parallel_distributed_insert_select": 2,
        "clickhouse_parallel_view_processing": false,
        "object_storage_concurrency": 1,
        "object_storage_max_file_count": 100,
        "object_storage_max_insert_bytes": 10737418240,
        "object_storage_polling_interval_ms": 30000,
        "object_storage_use_cluster_function": true,
        "streaming_max_insert_wait_ms": 5000
      },
      "source": {
        "kafka": {
          "brokers": "<string>",
          "caCertificate": "<string>",
          "consumerGroup": "my-clickpipe-consumer-group",
          "iamRole": "arn:aws:iam::123456789012:role/MyRole",
          "offset": {
            "timestamp": "2021-01-01T00:00"
          },
          "reversePrivateEndpointIds": [
            "<string>"
          ],
          "schemaRegistry": {
            "authentication": "PLAIN",
            "caCertificate": "<string>",
            "url": "https://psrc-aa00.us-east-2.aws.confluent.cloud/schemas/ids/100004"
          },
          "topics": "<string>"
        },
        "kinesis": {
          "iamRole": "arn:aws:iam::123456789012:role/MyRole",
          "region": "us-east-1",
          "streamName": "my-stream",
          "timestamp": 1615766400,
          "useEnhancedFanOut": true
        },
        "objectStorage": {
          "azureContainerName": "mycontainer",
          "compression": "auto",
          "connectionString": "DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=mykey;EndpointSuffix=core.windows.net",
          "delimiter": ",",
          "iamRole": "arn:aws:iam::123456789012:role/MyRole",
          "isContinuous": true,
          "path": "data/logs/*.json",
          "queueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue",
          "url": "https://datasets-documentation.s3.eu-west-3.amazonaws.com/http/**.ndjson.gz"
        },
        "postgres": {
          "database": "<string>",
          "host": "<string>",
          "port": 123,
          "settings": {
            "allowNullableColumns": true,
            "enableFailoverSlots": true,
            "initialLoadParallelism": 123,
            "publicationName": "<string>",
            "pullBatchSize": 123,
            "replicationSlotName": "<string>",
            "snapshotNumRowsPerPartition": 123,
            "snapshotNumberOfParallelTables": 123,
            "syncIntervalSeconds": 123
          },
          "tableMappings": [
            {
              "excludedColumns": [
                "<string>"
              ],
              "sortingKeys": [
                "<string>"
              ],
              "sourceSchemaName": "<string>",
              "sourceTable": "<string>",
              "targetTable": "<string>",
              "useCustomSortingKey": true
            }
          ]
        }
      },
      "state": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "status": 200
}

{
  "error": "<string>",
  "status": 400
}

Autorizaciones

Authorization · string · header · requerido

Use o ID da chave e o segredo da chave obtidos no console do ClickHouse Cloud: https://clickhouse.com/docs/cloud/manage/openapi

Parámetros de ruta

organizationId · string<uuid> · requerido

ID da organização proprietária do serviço.

serviceId · string<uuid> · requerido

ID do serviço proprietário do ClickPipe.

Respuesta

200

application/json

Resposta bem-sucedida

requestId · string<uuid>

ID único atribuído a cada solicitação. UUIDv4

result · object[]

Show child attributes

status · number

Código de status HTTP.

Ejemplo:

200