Get Read Replica Sets

curl --request GET \
  --url https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets"

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://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 => "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://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets"

	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://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets")
  .header("Authorization", "Basic <encoded-value>")
  .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::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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>"
}

GET

projects

{project_id}

services

{service_id}

replicaSets

Get Read Replica Sets

curl --request GET \
  --url https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets"

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://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 => "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://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets"

	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://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets")
  .header("Authorization", "Basic <encoded-value>")
  .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::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

Authorization

string

header

required

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

project_id

string

required

The unique identifier of the project.

Example:

"rp1pz7uyae"

service_id

string

required

The unique identifier of the service.

Example:

"d1k5vk7hf2"

Response

A list of read replica sets.

string

Example:

"alb8jicdpr"

name

string

Example:

"reporting-replica-1"

status

enum<string>

Available options:

creating,

active,

resizing,

deleting,

error

Example:

"active"

nodes

integer

Number of nodes in the replica set.

Example:

2

cpu_millis

integer

CPU allocation in milli-cores.

Example:

250

memory_gbs

integer

Memory allocation in gigabytes.

Example:

1

metadata

object

Additional metadata for the read replica set

Show child attributes

endpoint

object

Show child attributes

connection_pooler

object

Show child attributes

Auth

Services

Read Replica Sets

VPCs

Analytics

Get Read Replica Sets

Authorizations

Path Parameters

Response