データベースの作成

POST

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

string

必須

アカウントの API キーです。これはアカウント設定で確認できます。

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 回の作成です。作成後は、データベースの編集で名前の変更やメモリのリサイズができ、スナップショットの作成でバックアップを取得できます。

Parameters

string

必須

データベースの名前です。1〜32文字（英字、数字、アンダースコア（_）、ハイフン（-）、スペース）で、少なくとも1つの英字、数字、またはアンダースコアを含む必要があります。

int

必須

割り当てるRAMです。Redisの最小値は512、Mongoは1024です。

string

必須

データベースの種類です。mongo、redis、postgres、mysql。

string

必須

データベースのバージョンです。\ Postgres 17、MySQL 9、Mongo 8、Redis 7。

Response

string

呼び出しが成功したかどうかを示します。成功した場合は success、失敗した場合は error です。

object

レスポンスの内容です。

表示 Toggle object

string

データベースのIDです。

string

データベースに選択した名前です。

int

データベースに割り当てられたメモリです。

int

データベースに割り当てられたvCPUの数です。

string

データベースの種類です。

string

データベースのパスワードです。

string

接続に必要な証明書です。.pem ファイルに保存できます。

string

データベースに接続するためのURLです。

{
  "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	メンテナンスのため、データベースのプロビジョニングが一時的に利用できません。

データベース情報の取得特定のデータベースに関する詳細情報を取得します。

データベースの作成

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

​Parameters

​Response

​一般的なエラー

Parameters

Response

一般的なエラー