更新服务备份配置

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

PATCH /v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration

更新服务备份配置

cURL

curl --request PATCH \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "backupPeriodInHours": 123,
  "backupRetentionPeriodInHours": 123,
  "backupStartTime": "<string>"
}
'

200

{
  "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。

请求体

application/json

backupPeriodInHours · number

每次备份之间的时间间隔（小时）。

backupRetentionPeriodInHours · number

备份可用的最短保留时长（小时）。

backupStartTime · string

执行备份的时间，格式为 HH:MM（按 UTC 时区计算）。定义后，备份周期将重置为每 24 小时一次。

响应

200

application/json

成功响应

requestId · string<uuid>

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

result · object

Show child attributes

status · number

HTTP 状态码。

示例:

200