DescribeBackups

檢視指定雲端資料庫 ClickHouse 叢集的備份組。

介面說明

說明

僅 21.8 及以上版本的雲端資料庫 ClickHouse 叢集支援資料備份功能。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（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（預設值） 50 100	30
PageNumber	integer	否	頁數。	1

返回參數

名稱	類型	描述	樣本值
	object
TotalCount	string	總記錄數。	1
PageSize	string	每頁記錄數，取值： 30（預設值） 50 100	30
RequestId	string	請求 ID。	F5178C10-1407-4987-9133-DE4DC9119F75
PageNumber	string	頁數。	1
Items	array<object>	備份組清單。
	object
DBClusterId	string	叢集 ID。	cc-bp1qx68m06981****
BackupStatus	string	備份狀態，取值說明： Success：已完成。 Failure：備份失敗。	Success
BackupType	string	備份類型，取值說明： FullBackup：全量備份。 IncrementalBackup：增量備份。	IncrementalBackup
BackupStartTime	string	備份開始時間。格式：yyyy-MM-ddTHH:mmZ（UTC 時間）。	2021-11-22T18:28:22Z
BackupSize	integer	備份大小。單位：MB。	131072
BackupEndTime	string	備份結束時間。格式：yyyy-MM-ddTHH:mmZ（UTC 時間）。	2021-11-22T18:28:41Z
BackupSetInfo	string	叢集節點數量。單副本版，取值範圍：1~48。雙副本版，取值範圍：1~24。	{"shard_count": 4}
BackupId	string	備份資料工作 ID。	117403****
BackupMethod	string	備份方式。唯一取值為 Physical，代表實體備份。	Physical
ExpireDate	string	備份組到期時間。格式：yyyy-MM-ddTHH:mmZ（UTC 時間）。	2022-07-22T18:28:41Z
BackupScheduleType	string	備份類型。取值 manual（手動備份）/ scheduled（自動備份）。	manual

樣本

正常返回樣本

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",
      "BackupScheduleType": "manual"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。