Python
import os
from gcore import Gcore
client = Gcore(
api_key=os.environ.get("GCORE_API_KEY"), # This is the default and can be omitted
)
postgres_cluster = client.cloud.databases.postgres.clusters.get(
cluster_name="cluster_name",
project_id=0,
region_id=0,
)
print(postgres_cluster.cluster_name)package main
import (
"context"
"fmt"
"github.com/G-Core/gcore-go"
"github.com/G-Core/gcore-go/cloud"
"github.com/G-Core/gcore-go/option"
)
func main() {
client := gcore.NewClient(
option.WithAPIKey("My API Key"),
)
postgresCluster, err := client.Cloud.Databases.Postgres.Clusters.Get(
context.TODO(),
"cluster_name",
cloud.DatabasePostgresClusterGetParams{
ProjectID: gcore.Int(0),
RegionID: gcore.Int(0),
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", postgresCluster.ClusterName)
}
curl --request GET \
--url https://api.gcore.com/cloud/v1/dbaas/postgres/clusters/{project_id}/{region_id}/{cluster_name} \
--header 'Authorization: <api-key>'const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.gcore.com/cloud/v1/dbaas/postgres/clusters/{project_id}/{region_id}/{cluster_name}', 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.gcore.com/cloud/v1/dbaas/postgres/clusters/{project_id}/{region_id}/{cluster_name}",
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: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://api.gcore.com/cloud/v1/dbaas/postgres/clusters/{project_id}/{region_id}/{cluster_name}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gcore.com/cloud/v1/dbaas/postgres/clusters/{project_id}/{region_id}/{cluster_name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"cluster_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"databases": [
{
"name": "mydatabase",
"owner": "myuser",
"size": 2048
}
],
"flavor": {
"cpu": 1,
"memory_gib": 1
},
"high_availability": {},
"network": {
"acl": [
"92.33.34.127"
],
"connection_string": "postgresql://username:password@address.example.com:5432/dbname",
"host": "address.example.com",
"network_type": "public"
},
"pg_server_configuration": {
"pg_conf": "\nlisten_addresses = 'localhost'\nport = 5432\nmax_connections = 100\nshared_buffers = 128MB\nlogging_collector = on",
"version": "<string>",
"pooler": null
},
"storage": {
"size_gib": 100,
"type": "ssd-hiiops"
},
"users": [
{
"is_secret_revealed": true,
"name": "myuser",
"role_attributes": [
"INHERIT"
]
}
]
}Managed PostgreSQL
Get PostgreSQL cluster
Get detailed information about a specific PostgreSQL cluster.
GET
/
cloud
/
v1
/
dbaas
/
postgres
/
clusters
/
{project_id}
/
{region_id}
/
{cluster_name}
Python
import os
from gcore import Gcore
client = Gcore(
api_key=os.environ.get("GCORE_API_KEY"), # This is the default and can be omitted
)
postgres_cluster = client.cloud.databases.postgres.clusters.get(
cluster_name="cluster_name",
project_id=0,
region_id=0,
)
print(postgres_cluster.cluster_name)package main
import (
"context"
"fmt"
"github.com/G-Core/gcore-go"
"github.com/G-Core/gcore-go/cloud"
"github.com/G-Core/gcore-go/option"
)
func main() {
client := gcore.NewClient(
option.WithAPIKey("My API Key"),
)
postgresCluster, err := client.Cloud.Databases.Postgres.Clusters.Get(
context.TODO(),
"cluster_name",
cloud.DatabasePostgresClusterGetParams{
ProjectID: gcore.Int(0),
RegionID: gcore.Int(0),
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", postgresCluster.ClusterName)
}
curl --request GET \
--url https://api.gcore.com/cloud/v1/dbaas/postgres/clusters/{project_id}/{region_id}/{cluster_name} \
--header 'Authorization: <api-key>'const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.gcore.com/cloud/v1/dbaas/postgres/clusters/{project_id}/{region_id}/{cluster_name}', 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.gcore.com/cloud/v1/dbaas/postgres/clusters/{project_id}/{region_id}/{cluster_name}",
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: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://api.gcore.com/cloud/v1/dbaas/postgres/clusters/{project_id}/{region_id}/{cluster_name}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gcore.com/cloud/v1/dbaas/postgres/clusters/{project_id}/{region_id}/{cluster_name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"cluster_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"databases": [
{
"name": "mydatabase",
"owner": "myuser",
"size": 2048
}
],
"flavor": {
"cpu": 1,
"memory_gib": 1
},
"high_availability": {},
"network": {
"acl": [
"92.33.34.127"
],
"connection_string": "postgresql://username:password@address.example.com:5432/dbname",
"host": "address.example.com",
"network_type": "public"
},
"pg_server_configuration": {
"pg_conf": "\nlisten_addresses = 'localhost'\nport = 5432\nmax_connections = 100\nshared_buffers = 128MB\nlogging_collector = on",
"version": "<string>",
"pooler": null
},
"storage": {
"size_gib": 100,
"type": "ssd-hiiops"
},
"users": [
{
"is_secret_revealed": true,
"name": "myuser",
"role_attributes": [
"INHERIT"
]
}
]
}Authorizations
API key for authentication. Make sure to include the word apikey, followed by a single space and then your token.
Example: apikey 1234_abcdef
Path Parameters
Project ID
Region ID
Cluster name
Response
200 - application/json
OK
Required string length:
1 - 50Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$Show child attributes
Show child attributes
Instance RAM and CPU
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Main PG configuration
Show child attributes
Show child attributes
Current cluster status
Available options:
DELETING, FAILED, PREPARING, READY, UNHEALTHY, UNKNOWN, UPDATING PG's storage configuration
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I