获取服务备份配置 - ClickHouse Documentation

GET

organizations

{organizationId}

services

{serviceId}

backupConfiguration

获取服务备份配置

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration \
  --header 'Authorization: Basic <encoded-value>'

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "backupPeriodInHours": 123,
    "backupRetentionPeriodInHours": 123,
    "backupStartTime": "<string>"
  },
  "status": 200
}

授权

Authorization

string

header

必填

使用在 ClickHouse Cloud 控制台中获取的 key ID 和 key secret：https://clickhouse.com/docs/cloud/manage/openapi

路径参数

organizationId

string<uuid>

必填

拥有该 service 的组织 ID。

serviceId

string<uuid>

必填

service 的 ID。

响应

成功响应

requestId

string<uuid>

为每个请求分配的唯一 ID。UUIDv4

result

object

Show child attributes

status

number

HTTP 状态码。

示例:

200

最后修改于 2026年6月10日

更新服务备份配置更新 service 的 Backup 配置。需要 ADMIN auth key Role。将属性设为 null value 会将这些属性重置为其 default values。

获取服务备份配置

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration \
  --header 'Authorization: Basic <encoded-value>'

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "backupPeriodInHours": 123,
    "backupRetentionPeriodInHours": 123,
    "backupStartTime": "<string>"
  },
  "status": 200
}