服务备份列表 - ClickHouse Documentation

GET

organizations

{organizationId}

services

{serviceId}

backups

服务备份列表

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

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": [
    {
      "backupName": "<string>",
      "bucket": {
        "bucketPath": "<string>",
        "bucketProvider": "AWS",
        "iamRoleArn": "<string>",
        "iamRoleSessionName": "<string>"
      },
      "durationInSeconds": 123,
      "finishedAt": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "serviceId": "<string>",
      "sizeInBytes": 123,
      "startedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "status": 200
}

授权

Authorization

string

header

必填

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

路径参数

organizationId

string<uuid>

必填

拥有该备份的组织 ID。

serviceId

string<uuid>

必填

创建该备份时所属的服务 ID。

响应

成功响应

requestId

string<uuid>

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

result

object[]

Show child attributes

status

number

HTTP 状态码。

示例:

200

最后修改于 2026年6月26日

获取备份详情返回单个备份的信息。

服务备份列表

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

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": [
    {
      "backupName": "<string>",
      "bucket": {
        "bucketPath": "<string>",
        "bucketProvider": "AWS",
        "iamRoleArn": "<string>",
        "iamRoleSessionName": "<string>"
      },
      "durationInSeconds": 123,
      "finishedAt": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "serviceId": "<string>",
      "sizeInBytes": 123,
      "startedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "status": 200
}