数据库 - 凭证
重置凭据
重置托管在 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"
}
}
轮换数据库的访问密码或 TLS 证书，无需重新创建数据库，也不会改变其连接 URL 的结构。适用于凭据泄露的情况，或作为常规轮换策略的一部分。
重置任一凭据时，数据库都必须处于运行状态。重置
password 会在响应体中一次性返回新密码，之后不会再次显示，请立即保存。重置 certificate 只返回一个成功状态，之后需要通过获取证书获取新证书。任一重置完成后，使用旧凭据的现有客户端连接都需要重新连接。速率限制为每用户每 3 秒 1 次重置请求。
参数
string
必填
数据库的 ID。
string
必填
你想要重置的凭据，password 或 certificate。
响应
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"
}
}