Crear Base de Datos - Square Cloud

POST

databases

Crear Base de Datos

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

string

requerido

La clave de API de tu cuenta. Puedes encontrarla en la configuración de tu cuenta.

Aprovisiona una base de datos gestionada en Square Cloud (MongoDB, MySQL, PostgreSQL o Redis), selecciona el cluster con más RAM disponible y asigna un registro DNS público (square-cloud-db-<id>.squareweb.app) que apunta a ella. La password y el certificate de la respuesta se muestran solo una vez, guárdalos de inmediato, ya que no se pueden recuperar más adelante, solo restablecer mediante Restablecer Credenciales. Alojar una base de datos requiere un plan Standard, Pro o Enterprise. La memory solicitada debe ser al menos el mínimo del motor (512 MB para Redis, 1024 MB para MongoDB, MySQL y PostgreSQL) y no puede superar la memoria disponible de tu cuenta. Límite de 1 creación cada 3 segundos por usuario. Una vez creada, usa Editar Base de Datos para renombrarla o cambiar su memoria, y Crear Snapshot para respaldarla.

Parámetros

string

requerido

El nombre de la base de datos. 1–32 caracteres — letras, números, guiones bajos (_), guiones (-) y espacios — y debe incluir al menos una letra, un número o un guion bajo.

int

requerido

La RAM asignada. El mínimo de Redis es 512 y el de Mongo, 1024.

string

requerido

El tipo de base de datos, mongo, redis, postgres, mysql.

string

requerido

La versión de la base de datos.\ Postgres 17, MySQL 9, Mongo 8, Redis 7.

Respuesta

string

Indica si la llamada fue exitosa. success si fue exitosa, error si no.

object

El contenido de la respuesta.

Mostrar Alternar objeto

string

El ID de la base de datos.

string

El nombre que elegiste para la base de datos

int

La memoria asignada a la base de datos

int

El número de vCPUs asignadas a la base de datos

string

El tipo de la base de datos.

string

La contraseña de la base de datos.

string

El certificado necesario para conectarse a ella. Puedes guardarlo en un archivo .pem.

string

La url para conectarse a la base de datos.

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

Errores comunes

Código	HTTP	Significado
`INVALID_NAME`	400	El nombre no cumple con la validación de 1 a 32 caracteres.
`INVALID_DATABASE_TYPE`	400	`type` no es uno de `mongo`, `mysql`, `redis`, `postgres`.
`INVALID_DATABASE_VERSION`	400	`version` no es una versión compatible para el `type` elegido.
`INSUFFICIENT_MEMORY`	400	La `memory` solicitada está por debajo del mínimo del motor o supera la memoria disponible de la cuenta.
`CLUSTER_SELECTION_FAILED`	400	No se pudo seleccionar ningún cluster con capacidad suficiente.
`DATABASE_CREATION_FAILED`	400 / 500	El aprovisionamiento falló o la respuesta del cluster estaba incompleta.
`UPGRADE_REQUIRED`	403	El plan activo no incluye alojamiento de bases de datos.
`CLUSTER_MAINTENANCE_TRY_LATER`	503	El aprovisionamiento de bases de datos no está disponible temporalmente por mantenimiento.

Obtener Información de la Base de DatosRecupera información detallada sobre una base de datos específica.

Crear Base de Datos

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

​Respuesta

​Errores comunes

Parámetros

Respuesta

Errores comunes