データベース - 認証情報
認証情報のリセット
Square Cloud 上でホストされているデータベースの証明書またはパスワードをリセットします。
POST
/
v2
/
databases
/
{database_id}
/
credentials
/
reset
認証情報のリセット
curl --request POST \
--url https://api.squarecloud.app/v2/databases/{database_id}/credentials/reset \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"reset": "<string>"
}
'import requests
url = "https://api.squarecloud.app/v2/databases/{database_id}/credentials/reset"
payload = { "reset": "<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({reset: '<string>'})
};
fetch('https://api.squarecloud.app/v2/databases/{database_id}/credentials/reset', 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}/credentials/reset",
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([
'reset' => '<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/{database_id}/credentials/reset"
payload := strings.NewReader("{\n \"reset\": \"<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/{database_id}/credentials/reset")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"reset\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/databases/{database_id}/credentials/reset")
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 \"reset\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status":"success",
"response":{
"password":"f3T1hdskMkchMwK6Hxqinoyb"
}
}
データベースを再作成したり接続 URL の構造を変えたりすることなく、アクセスパスワードまたは TLS 証明書のいずれかをローテーションします。認証情報が漏えいした場合や、定期的なローテーションポリシーの一環として使用してください。
どちらの認証情報をリセットする場合もデータベースが実行中である必要があります。
password をリセットすると、新しいパスワードがレスポンスボディに一度だけ返されます。再度表示されることはないため、すぐに保存してください。certificate をリセットした場合は単純な成功レスポンスが返るだけなので、その後証明書の取得で新しい証明書を取得してください。いずれのリセットも、古い認証情報を使用している既存のクライアント接続は再接続が必要になります。レート制限はユーザーごとに 3 秒あたり 1 回のリセットです。
Parameters
string
必須
データベースのIDです。
string
必須
リセットしたい認証情報です。password または certificate。
Response
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。パスワードのリセットの場合
{
"status":"success",
"response":{
"password":"f3T1hdskMkchMwK6Hxqinoyb"
}
}
一般的なエラー
| コード | HTTP | 説明 |
|---|---|---|
INVALID_RESET_TYPE | 400 | reset が "password" または "certificate" ではありませんでした。 |
DATABASE_NOT_RUNNING | 400 | データベースが停止しています。認証情報をリセットする前に起動してください。 |
DATABASE_NOT_FOUND | 404 | データベースが存在しないか、呼び出し元が所有していません。 |
RESET_FAILED | 500 | 認証情報のローテーションがクラスターに拒否されました。 |
⌘I
認証情報のリセット
curl --request POST \
--url https://api.squarecloud.app/v2/databases/{database_id}/credentials/reset \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"reset": "<string>"
}
'import requests
url = "https://api.squarecloud.app/v2/databases/{database_id}/credentials/reset"
payload = { "reset": "<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({reset: '<string>'})
};
fetch('https://api.squarecloud.app/v2/databases/{database_id}/credentials/reset', 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}/credentials/reset",
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([
'reset' => '<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/{database_id}/credentials/reset"
payload := strings.NewReader("{\n \"reset\": \"<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/{database_id}/credentials/reset")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"reset\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/databases/{database_id}/credentials/reset")
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 \"reset\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status":"success",
"response":{
"password":"f3T1hdskMkchMwK6Hxqinoyb"
}
}

