Criar banco de dados - Square Cloud

POST

databases

Criar banco de dados

curl --request POST \
  --url https://api.squarecloud.app/v2/databases \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "memory": 123,
  "type": "<string>",
  "version": "<string>"
}
'

import requests

url = "https://api.squarecloud.app/v2/databases"

payload = {
    "name": "<string>",
    "memory": 123,
    "type": "<string>",
    "version": "<string>"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', memory: 123, type: '<string>', version: '<string>'})
};

fetch('https://api.squarecloud.app/v2/databases', 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",
  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' => '<string>',
    'memory' => 123,
    'type' => '<string>',
    'version' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "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.squarecloud.app/v2/databases"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"memory\": 123,\n  \"type\": \"<string>\",\n  \"version\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "<authorization>")
	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.squarecloud.app/v2/databases")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"memory\": 123,\n  \"type\": \"<string>\",\n  \"version\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"memory\": 123,\n  \"type\": \"<string>\",\n  \"version\": \"<string>\"\n}"

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

{
  "status":"success",
  "response": {
    "id": "a14b8d5e1cb7405a851eb4c075506121",
    "name": "test",
    "memory": 1024,
    "cpu": 2,
    "type": "mongo",
    "password": "PASSWORD",
    "certificate": "CERTIFICATE_IN_BASE_64_FORMAT",
    "connection_url": "mongodb://default:PASSWORD@square-cloud-db-ID.squareweb.app:PORT"
    }
}

Authorization

string

obrigatório

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

Provisiona um banco de dados gerenciado na Square Cloud (MongoDB, MySQL, PostgreSQL ou Redis), escolhe o cluster com mais RAM disponível e aloca um registro DNS público (square-cloud-db-<id>.squareweb.app) apontando para ele. A password e o certificate retornados aparecem apenas uma vez: salve-os imediatamente, pois nenhum dos dois pode ser recuperado depois, apenas redefinido via Redefinir Credenciais. A hospedagem de banco de dados requer um plano Standard, Pro ou Enterprise. O memory solicitado deve ser no mínimo o exigido pelo motor (512 MB para Redis, 1024 MB para MongoDB, MySQL e PostgreSQL) e não pode exceder a memória disponível da sua conta. Limite de taxa de 1 criação a cada 3 segundos por usuário. Depois de criado, use Editar Banco de Dados para renomeá-lo ou redimensionar sua memória, e Criar Snapshot para fazer backup dele.

Parâmetros

name

string

obrigatório

O nome do banco de dados. De 1 a 32 caracteres — letras, números, underscores (_), hífens (-) e espaços — e deve incluir ao menos uma letra, número ou underscore.

memory

int

obrigatório

A RAM alocada para ele. Mínimo para Redis é 512 e para Mongo é 1024.

type

string

obrigatório

O tipo de banco de dados: postgres, mysql, mongo, redis.

version

string

obrigatório

A versão do banco de dados.
Postgres 17, MySQL 9, Mongo 8, Redis 7.

Resposta

status

string

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

response

object

O conteúdo da resposta.

Mostrar Alternar objeto

string

O ID do banco de dados.

name

string

O nome que você escolheu para o banco de dados

memory

int

A memória alocada para o banco de dados

cpu

int

O número de vCPUs alocados para o banco de dados

type

string

O tipo do banco de dados.

password

string

A senha do banco de dados.

certificate

string

O certificado necessário para conectar-se a ele. Você pode salvá-lo em um arquivo .pem.

connection_url

string

A URL para conectar-se ao banco de dados.

{
  "status":"success",
  "response": {
    "id": "a14b8d5e1cb7405a851eb4c075506121",
    "name": "test",
    "memory": 1024,
    "cpu": 2,
    "type": "mongo",
    "password": "PASSWORD",
    "certificate": "CERTIFICATE_IN_BASE_64_FORMAT",
    "connection_url": "mongodb://default:PASSWORD@square-cloud-db-ID.squareweb.app:PORT"
    }
}

Erros comuns

Código	HTTP	Significado
`INVALID_NAME`	400	O nome falha na validação de 1 a 32 caracteres.
`INVALID_DATABASE_TYPE`	400	`type` não é um dos valores `mongo`, `mysql`, `redis`, `postgres`.
`INVALID_DATABASE_VERSION`	400	`version` não é uma versão suportada para o `type` escolhido.
`INSUFFICIENT_MEMORY`	400	O `memory` solicitado está abaixo do mínimo do motor ou excede a memória disponível da conta.
`CLUSTER_SELECTION_FAILED`	400	Nenhum cluster com capacidade suficiente pôde ser selecionado.
`DATABASE_CREATION_FAILED`	400 / 500	O provisionamento falhou, ou a resposta do cluster ficou incompleta.
`UPGRADE_REQUIRED`	403	O plano ativo não inclui hospedagem de banco de dados.
`CLUSTER_MAINTENANCE_TRY_LATER`	503	O provisionamento de banco de dados está temporariamente indisponível devido a manutenção.

Consultar informações do banco de dadosRecuperar informações detalhadas sobre um banco de dados específico.

Criar banco de dados

curl --request POST \
  --url https://api.squarecloud.app/v2/databases \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "memory": 123,
  "type": "<string>",
  "version": "<string>"
}
'

import requests

url = "https://api.squarecloud.app/v2/databases"

payload = {
    "name": "<string>",
    "memory": 123,
    "type": "<string>",
    "version": "<string>"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', memory: 123, type: '<string>', version: '<string>'})
};

fetch('https://api.squarecloud.app/v2/databases', 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",
  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' => '<string>',
    'memory' => 123,
    'type' => '<string>',
    'version' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "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.squarecloud.app/v2/databases"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"memory\": 123,\n  \"type\": \"<string>\",\n  \"version\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "<authorization>")
	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.squarecloud.app/v2/databases")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"memory\": 123,\n  \"type\": \"<string>\",\n  \"version\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"memory\": 123,\n  \"type\": \"<string>\",\n  \"version\": \"<string>\"\n}"

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

{
  "status":"success",
  "response": {
    "id": "a14b8d5e1cb7405a851eb4c075506121",
    "name": "test",
    "memory": 1024,
    "cpu": 2,
    "type": "mongo",
    "password": "PASSWORD",
    "certificate": "CERTIFICATE_IN_BASE_64_FORMAT",
    "connection_url": "mongodb://default:PASSWORD@square-cloud-db-ID.squareweb.app:PORT"
    }
}

​Parâmetros

​Resposta

​Erros comuns

Parâmetros

Resposta

Erros comuns