使用DescribeBackupPolicy擷取叢集備份策略-雲資料庫 ClickHouse-阿里雲

介面說明

說明

版本為 20.3、20.8 和 21.8 的雲資料庫 ClickHouse 叢集支援資料備份。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

clickhouse:DescribeBackupPolicy

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
DBClusterId	string	是	叢集 ID。	cc-bp1qx68m06981****

返回參數

名稱	類型	描述	樣本值
	object
PreferredBackupPeriod	string	備份周期，取值說明： Monday：周一。 Tuesday：周二。 Wednesday：周三。 Thursday：周四。 Friday：周五。 Saturday：周六。 Sunday：周日。	Monday
Switch	string	是否開啟備份服務，取值說明： true：已開啟。 false：未開啟。	true
RequestId	string	請求 ID。	F5178C10-1407-4987-9133-DE4DC9119F75
PreferredBackupTime	string	備份時間，UTC 時間。	15:00Z-16:00Z
BackupRetentionPeriod	integer	備份保留時間，預設保留時間為 7 天。取值範圍：7~730。單位：天。	7
BackupSize	string	備份大小，單位：MB。	123124

樣本

正常返回樣本

JSON格式

{
  "PreferredBackupPeriod": "Monday",
  "Switch": "true",
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PreferredBackupTime": "15:00Z-16:00Z",
  "BackupRetentionPeriod": 7,
  "BackupSize": "123124"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，請確認 DBClusterId 值是否正確。

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

變更歷史

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