DescribeLogBackupPolicy - 查詢叢集記錄備份保留原則 -

查詢PolarDB叢集記錄備份的保留原則。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:DescribeLogBackupPolicy

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

無

請求參數

名稱	類型	必填	描述	樣本值
DBClusterId	string	是	叢集 ID。說明您可以調用 DescribeDBClusters 介面查看目標地區下所有的叢集資訊，包括叢集 ID。	pc-*****************

返回參數

名稱	類型	描述	樣本值
	object
LogBackupRetentionPeriod	integer	日誌保留周期，取值範圍如下： 3～7300：日誌保留周期，單位天。 -1：長期保留。說明開啟進階備份後，該參數不建議使用，請使用參數 AdvancedLogPolicies。	7
RequestId	string	請求 id。	62EE0051-102B-488D-9C79-D607B8******
LogBackupAnotherRegionRetentionPeriod	string	記錄備份跨地區備份保留周期。取值範圍如下： 0：關閉記錄備份跨地區備份功能。 30～7300：記錄備份跨地區備份保留周期，單位為天。 -1：長期保留。說明建立叢集時，預設取值為 0，即關閉記錄備份跨地區備份功能。開啟進階備份後，該參數不建議使用，請使用參數 AdvancedLogPolicies。	0
LogBackupAnotherRegionRegion	string	記錄備份跨地區備份地區。跨地區備份支援的地區請參見概述。說明開啟進階備份後，該參數不建議使用，請使用參數 AdvancedLogPolicies。	cn-beijing
EnableBackupLog	integer	是否開啟記錄備份，取值範圍如下： 0：未開啟。 1：開啟（預設全部開啟且不支援關閉）。說明開啟進階備份後，該參數不建議使用，請使用參數 AdvancedLogPolicies。	1
AdvancedLogPolicies	object
AdvancedLogPolicy	array<object>	進階記錄備份策略詳情。說明 PolarDB PostgreSQL 版（相容 Oracle）、PolarDB PostgreSQL 版不支援該參數。
	object
PolicyId	string	記錄備份策略 ID。說明僅開啟跨地區記錄備份的叢集存在該值。	1c75zkmqczcd1vbf6f6d05***
LogRetentionType	string	記錄備份保留周期類型，傳回值如下： never：永不到期 delay：固定天數到期	delay
LogRetentionValue	string	記錄備份保留天數，取值範圍如下： 3～7300：日誌保留周期，單位天。 -1：長期保留。	7
SrcType	string	記錄備份策略源類型，傳回值如下： db：資料庫叢集 level1：一級備份 level2：二級備份 level2Cross：二級跨地區備份	level1
DestType	string	記錄備份策略目標類型，取值如下： level1：一級備份 level2：二級備份 level2Cross：二級跨地區備份	level2
EnableLogBackup	integer	是否開啟記錄備份，傳回值如下： 1：開啟 0：未開啟	1
SrcRegion	string	記錄備份策略源地區。	cn-hangzhou
DestRegion	string	記錄備份策略目標地區。	cn-shanghai

樣本

正常返回樣本

JSON格式

{
  "LogBackupRetentionPeriod": 7,
  "RequestId": "62EE0051-102B-488D-9C79-D607B8******",
  "LogBackupAnotherRegionRetentionPeriod": "0",
  "LogBackupAnotherRegionRegion": "cn-beijing",
  "EnableBackupLog": 1,
  "AdvancedLogPolicies": {
    "AdvancedLogPolicy": [
      {
        "PolicyId": "1c75zkmqczcd1vbf6f6d05***",
        "LogRetentionType": "delay",
        "LogRetentionValue": "7",
        "SrcType": "level1",
        "DestType": "level2",
        "EnableLogBackup": 1,
        "SrcRegion": "cn-hangzhou",
        "DestRegion": "cn-shanghai"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	當前的記錄中不存在提供的DBClusterId。
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	當前的記錄中不存在提供的DBClusterId。

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

變更歷史

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