Créer une infrastructure BYOC

Crée une nouvelle infrastructure BYOC dans l’organisation. Renvoie la configuration de l’infrastructure nouvellement créée

POST /v1/organizations/{organizationId}/byocInfrastructure

Créer une infrastructure BYOC

cURL

curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/byocInfrastructure \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "<string>",
  "availabilityZoneSuffixes": [],
  "vpcCidrRange": "<string>"
}
'

import requests

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

payload = {
    "accountId": "<string>",
    "availabilityZoneSuffixes": [],
    "vpcCidrRange": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({accountId: '<string>', availabilityZoneSuffixes: [], vpcCidrRange: '<string>'})
};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/byocInfrastructure', 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}/byocInfrastructure",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'accountId' => '<string>',
    'availabilityZoneSuffixes' => [
        
    ],
    'vpcCidrRange' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"accountId\": \"<string>\",\n  \"availabilityZoneSuffixes\": [],\n  \"vpcCidrRange\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.clickhouse.cloud/v1/organizations/{organizationId}/byocInfrastructure")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accountId\": \"<string>\",\n  \"availabilityZoneSuffixes\": [],\n  \"vpcCidrRange\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accountId\": \"<string>\",\n  \"availabilityZoneSuffixes\": [],\n  \"vpcCidrRange\": \"<string>\"\n}"

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

200

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "accountName": "<string>",
    "id": "<string>"
  },
  "status": 200
}

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

Autorisations

Authorization · string · header · requis

Utilisez l’ID de la clé et le secret de la clé obtenus dans la ClickHouse Cloud console : https://clickhouse.com/docs/cloud/manage/openapi

Paramètres de chemin

organizationId · string<uuid> · requis

ID de l’organisation demandée.

Corps

application/json

accountId · string

ID du cloud account pour lequel l’infrastructure BYOC est configurée

availabilityZoneSuffixes · enum<string>[]

Liste des suffixes de zone de disponibilité

Options disponibles: a, b, c, d, e, f

regionId · enum<string>

Region dans laquelle l’infrastructure BYOC sera située

Options disponibles: ap-northeast-1, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, eu-west-2, me-central-1, us-east-1, us-east-2, us-west-2, us-east1, us-central1, europe-west4, asia-southeast1, eastus, eastus2, westus3, germanywestcentral

vpcCidrRange · string

Plage CIDR du VPC

Réponse

200

application/json

Réponse réussie

requestId · string<uuid>

ID unique attribué à chaque requête. UUIDv4

result · object

Show child attributes

status · number

Code d’état HTTP.

Exemple:

200