Consultar informações do banco de dados

GET

databases

{database_id}

curl --request GET \
  --url https://api.squarecloud.app/v2/databases/{database_id} \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/databases/{database_id}', 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.squarecloud.app/v2/databases/{database_id}",
  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: <authorization>"
  ],
]);

$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.squarecloud.app/v2/databases/{database_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/databases/{database_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

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

{
  "status": "success",
  "response": {
    "name": "my-database",
    "id": "db1234567890",
    "owner": "313397145698959364",
    "cluster": "suki-cluster",
    "ram": 1024,
    "type": "mongodb",
    "port": 27017,
    "created_at": "2023-01-15T10:00:00Z"
  }
}

string

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

Retorna a identidade estática de um banco de dados: nome, proprietário, cluster de hospedagem, RAM alocada, tipo de motor e porta de conexão. Isso é apenas metadado, não inclui uso de recursos em tempo real; use Obter Status do Banco de Dados ou Obter Métricas do Banco de Dados para isso. Útil para confirmar a configuração de um banco de dados após Criar Banco de Dados ou Editar Banco de Dados, ou para descobrir em qual cluster ele está antes de contatar o suporte.

Parâmetros

string

obrigatório

O ID do banco de dados. Você pode encontrá-lo no painel da Square Cloud.

Resposta

string

Indica se a chamada foi bem-sucedida. success se bem-sucedida, error se não.

object

O conteúdo da resposta.

Mostrar Alternar objeto

string

O nome do banco de dados.

string

O ID do banco de dados.

string

O ID do proprietário do banco de dados.

string

O cluster do banco de dados.

number

O uso de RAM do banco de dados em MB.

string

O tipo do banco de dados (ex: mongodb, postgresql).

number

A porta do banco de dados.

date

A data de criação do banco de dados.

{
  "status": "success",
  "response": {
    "name": "my-database",
    "id": "db1234567890",
    "owner": "313397145698959364",
    "cluster": "suki-cluster",
    "ram": 1024,
    "type": "mongodb",
    "port": 27017,
    "created_at": "2023-01-15T10:00:00Z"
  }
}

Erros comuns

Código	HTTP	Significado
`DATABASE_NOT_FOUND`	404	O banco de dados não existe ou não pertence a quem fez a chamada.

Iniciar banco de dadosIniciar o seu banco de dados.

Consultar informações do banco de dados

curl --request GET \
  --url https://api.squarecloud.app/v2/databases/{database_id} \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/databases/{database_id}', 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.squarecloud.app/v2/databases/{database_id}",
  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: <authorization>"
  ],
]);

$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.squarecloud.app/v2/databases/{database_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/databases/{database_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

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

{
  "status": "success",
  "response": {
    "name": "my-database",
    "id": "db1234567890",
    "owner": "313397145698959364",
    "cluster": "suki-cluster",
    "ram": 1024,
    "type": "mongodb",
    "port": 27017,
    "created_at": "2023-01-15T10:00:00Z"
  }
}

​Parâmetros

​Resposta

​Erros comuns

Parâmetros

Resposta

Erros comuns