获取数据库 TLS 证书
获取数据库的 TLS 文件（GET /v2/databases//credentials/certificate）：包含私钥和证书的 base64 PEM。
GET
/
v2
/
databases
/
{database_id}
/
credentials
/
certificate
获取数据库 TLS 证书
curl --request GET \
--url https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate \
--header 'Authorization: <authorization>'import requests
url = "https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate', 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/certificate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"status": "success",
"response": {
"certificate": "CERTIFICATE_IN_BASE_64_FORMAT"
}
}
需要具有
databases:credentials 权限范围的 API 密钥。
返回数据库用于加密连接的 TLS 文件，以 base64 编码。解码后是一个 PEM，其中私钥在前、证书在后，可以直接写入 .pem 文件。托管的 MongoDB、MySQL 和 PostgreSQL 数据库各自都带有自己的证书；请查看你所用驱动的 TLS 选项，确认是否需要使用它。
调用此接口时数据库必须处于运行状态，如果已停止，请先启动它。如果需要轮换证书而不仅仅是读取它，请使用带 reset: "certificate" 的重置凭据，然后再通过此接口重新获取。
参数
string
必填
数据库的 ID。
响应
string
指示调用是否成功。成功时为
success，否则为 error。{
"status": "success",
"response": {
"certificate": "CERTIFICATE_IN_BASE_64_FORMAT"
}
}
常见错误
| 代码 | HTTP | 说明 |
|---|---|---|
DATABASE_NOT_RUNNING | 400 | 数据库已停止；请先启动数据库再读取证书。 |
READ_FAILED | 400 | 无法从集群读取证书文件。 |
DATABASE_NOT_FOUND | 404 | 数据库不存在，或不属于调用者。 |
相关内容
- CLI：
squarecloud db credentials certificate - SDK：
api.databases.certificate()（JavaScript）、client.databases.certificate()（Python）、c.Databases.Certificate()（Go）
⌘I
获取数据库 TLS 证书
curl --request GET \
--url https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate \
--header 'Authorization: <authorization>'import requests
url = "https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate', 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/certificate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/databases/{database_id}/credentials/certificate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"status": "success",
"response": {
"certificate": "CERTIFICATE_IN_BASE_64_FORMAT"
}
}