查看指定云數據庫ClickHouse集群的備份集。
接口說明
說明
版本為 20.3、20.8 和 21.8 的云數據庫 ClickHouse 集群支持數據備份。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| clickhouse:DescribeBackups | get | *DBCluster acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBClusterId | string | 是 | 集群 ID。 | cc-bp1qx68m06981**** |
| BackupId | string | 否 | 備份數據任務 ID。 | 117403**** |
| StartTime | string | 是 | 查詢開始時間。格式：yyyy-MM-ddTHH:mmZ（UTC 時間）。 | 2021-11-21T16:00Z |
| EndTime | string | 是 | 查詢結束時間。格式：yyyy-MM-ddTHH:mmZ（UTC 時間）。 | 2021-11-25T16:00Z |
| PageSize | integer | 否 | 每頁記錄數，取值：
| 30 |
| PageNumber | integer | 否 | 頁數。 | 1 |
返回參數
示例
正常返回示例
JSON格式
{
"TotalCount": "1",
"PageSize": "30",
"RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
"PageNumber": "1",
"Items": [
{
"DBClusterId": "cc-bp1qx68m06981****",
"BackupStatus": "Success",
"BackupType": "IncrementalBackup",
"BackupStartTime": "2021-11-22T18:28:22Z",
"BackupSize": 131072,
"BackupEndTime": "2021-11-22T18:28:41Z",
"BackupSetInfo": "{\"shard_count\"：4}",
"BackupId": "117403****",
"BackupMethod": "Physical",
"ExpireDate": "2022-07-22T18:28:41Z"
}
]
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 您指定的 DBClusterId 不存在，請確認 DBClusterId 值是否正確。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-09-25 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2022-06-07 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2022-03-24 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |