Create a Read Replica Set
curl --request POST \
--url https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "my-reporting-replica",
"nodes": 2,
"cpu_millis": 250,
"memory_gbs": 1
}
'import requests
url = "https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets"
payload = {
"name": "my-reporting-replica",
"nodes": 2,
"cpu_millis": 250,
"memory_gbs": 1
}
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({name: 'my-reporting-replica', nodes: 2, cpu_millis: 250, memory_gbs: 1})
};
fetch('https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets', 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://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets",
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([
'name' => 'my-reporting-replica',
'nodes' => 2,
'cpu_millis' => 250,
'memory_gbs' => 1
]),
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://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets"
payload := strings.NewReader("{\n \"name\": \"my-reporting-replica\",\n \"nodes\": 2,\n \"cpu_millis\": 250,\n \"memory_gbs\": 1\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://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"my-reporting-replica\",\n \"nodes\": 2,\n \"cpu_millis\": 250,\n \"memory_gbs\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets")
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 \"name\": \"my-reporting-replica\",\n \"nodes\": 2,\n \"cpu_millis\": 250,\n \"memory_gbs\": 1\n}"
response = http.request(request)
puts response.read_body{
"id": "alb8jicdpr",
"name": "reporting-replica-1",
"status": "active",
"nodes": 2,
"cpu_millis": 250,
"memory_gbs": 1,
"metadata": {
"environment": "<string>"
},
"endpoint": {
"host": "my-service.com",
"port": 8080
},
"connection_pooler": {
"endpoint": {
"host": "my-service.com",
"port": 8080
}
}
}{
"code": "<string>",
"message": "<string>"
}Create a Read Replica Set
Creates a new read replica set for a service. This is an asynchronous operation.
POST
/
projects
/
{project_id}
/
services
/
{service_id}
/
replicaSets
Create a Read Replica Set
curl --request POST \
--url https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "my-reporting-replica",
"nodes": 2,
"cpu_millis": 250,
"memory_gbs": 1
}
'import requests
url = "https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets"
payload = {
"name": "my-reporting-replica",
"nodes": 2,
"cpu_millis": 250,
"memory_gbs": 1
}
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({name: 'my-reporting-replica', nodes: 2, cpu_millis: 250, memory_gbs: 1})
};
fetch('https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets', 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://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets",
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([
'name' => 'my-reporting-replica',
'nodes' => 2,
'cpu_millis' => 250,
'memory_gbs' => 1
]),
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://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets"
payload := strings.NewReader("{\n \"name\": \"my-reporting-replica\",\n \"nodes\": 2,\n \"cpu_millis\": 250,\n \"memory_gbs\": 1\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://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"my-reporting-replica\",\n \"nodes\": 2,\n \"cpu_millis\": 250,\n \"memory_gbs\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets")
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 \"name\": \"my-reporting-replica\",\n \"nodes\": 2,\n \"cpu_millis\": 250,\n \"memory_gbs\": 1\n}"
response = http.request(request)
puts response.read_body{
"id": "alb8jicdpr",
"name": "reporting-replica-1",
"status": "active",
"nodes": 2,
"cpu_millis": 250,
"memory_gbs": 1,
"metadata": {
"environment": "<string>"
},
"endpoint": {
"host": "my-service.com",
"port": 8080
},
"connection_pooler": {
"endpoint": {
"host": "my-service.com",
"port": 8080
}
}
}{
"code": "<string>",
"message": "<string>"
}Authorizations
HTTP Basic Authentication using your Tiger Cloud public key and secret key.
Format: Authorization: Basic <base64(public_key:secret_key)>
Example:
curl -X GET "https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services" \
-H "Authorization: Basic $(echo -n 'your_public_key:your_secret_key' | base64)"
Path Parameters
The unique identifier of the project.
Example:
"rp1pz7uyae"
The unique identifier of the service.
Example:
"d1k5vk7hf2"
Body
application/json
A human-readable name for the read replica.
Example:
"my-reporting-replica"
Number of nodes to create in the replica set.
Example:
2
The initial CPU allocation in milli-cores.
Example:
250
The initial memory allocation in gigabytes.
Example:
1
Response
Read replica set creation request has been accepted.
Example:
"alb8jicdpr"
Example:
"reporting-replica-1"
Available options:
creating, active, resizing, deleting, error Example:
"active"
Number of nodes in the replica set.
Example:
2
CPU allocation in milli-cores.
Example:
250
Memory allocation in gigabytes.
Example:
1
Additional metadata for the read replica set
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes