数据库
创建数据库
在 Square Cloud 上创建一个托管的数据库实例。
POST
/
v2
/
databases
创建数据库
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"
}
}
在 Square Cloud 上创建一个托管数据库（MongoDB、MySQL、PostgreSQL 或 Redis），选择可用 RAM 最多的集群，并分配一个指向它的公共 DNS 记录（
square-cloud-db-<id>.squareweb.app）。响应中的 password 和 certificate 仅显示一次，请立即保存，因为之后都无法再次获取，只能通过重置凭据重新生成。
数据库托管需要 Standard、Pro 或 Enterprise 套餐。请求的 memory 必须不低于所选引擎的最小值（Redis 为 512 MB，MongoDB、MySQL 和 PostgreSQL 为 1024 MB），且不能超过账户的可用内存。速率限制为每用户每 3 秒 1 次创建请求。
创建后，可以使用编辑数据库重命名或调整内存大小，并使用创建 snapshot进行备份。
参数
string
必填
数据库的名称。1–32 个字符，可包含字母、数字、下划线（
_）、连字符（-）和空格，并且必须至少包含一个字母、数字或下划线。int
必填
分配给它的内存。Redis 最低为 512，Mongo 最低为 1024。
string
必填
数据库类型，mongo、redis、postgres、mysql。
string
必填
数据库的版本。\
Postgres 17、MySQL 9、Mongo 8、Redis 7。
响应
string
指示调用是否成功。成功时为
success，否则为 error。object
{
"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"
}
}
常见错误
| 代码 | HTTP | 说明 |
|---|---|---|
INVALID_NAME | 400 | 名称未通过 1-32 个字符的校验。 |
INVALID_DATABASE_TYPE | 400 | type 不是 mongo、mysql、redis、postgres 中的一个。 |
INVALID_DATABASE_VERSION | 400 | version 不是所选 type 支持的版本。 |
INSUFFICIENT_MEMORY | 400 | 请求的 memory 低于引擎的最小值，或超过账户的可用内存。 |
CLUSTER_SELECTION_FAILED | 400 | 未能选出容量足够的集群。 |
DATABASE_CREATION_FAILED | 400 / 500 | 创建失败，或集群返回的响应不完整。 |
UPGRADE_REQUIRED | 403 | 当前套餐不包含数据库托管。 |
CLUSTER_MAINTENANCE_TRY_LATER | 503 | 数据库创建因维护而暂时不可用。 |
⌘I
创建数据库
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"
}
}