DescribeBackupPolicy - PolarDB

呼叫 DescribeBackupPolicy 介面查詢執行個體備份設定。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardbx:DescribeBackupPolicy

none

*全部資源。

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	執行個體所屬地域的 ID。	cn-hangzhou
DBInstanceName	string	是	執行個體名稱。	pxc-********

返回參數

名稱	類型	描述	樣本值
	object	返回資料。
Message	string	返回資訊，成功返回 success，錯誤返回對應錯誤碼。	success
RequestId	string	請求 ID。	B87E2AB3-B7C9-4394-9160-7F639F732031
Success	boolean	請求是否成功。	true
Data	object	返回體。
LogLocalRetentionSpace	integer
DBInstanceName	string
BackupWay	string
BackupPeriod	string
ForceCleanOnHighSpaceUsage	integer
BackupType	string
LocalLogRetention	integer
RemoveLogRetention	integer
BackupPlanBegin	string
BackupSetRetention	integer
IsEnabled	integer
ColdDataBackupInterval	integer
ColdDataBackupRetention	integer
LocalLogRetentionNumber	integer
IsCrossRegionDataBackupEnabled	boolean
IsCrossRegionLogBackupEnabled	boolean
DestCrossRegion	string
CrossRegionDataBackupRetention	integer
CrossRegionLogBackupRetention	integer
CrossRegionFilterValue	string

樣本

正常返回樣本

JSON格式

{
  "Message": "success",
  "RequestId": "B87E2AB3-B7C9-4394-9160-7F639F732031",
  "Success": true,
  "Data": {
    "LogLocalRetentionSpace": 0,
    "DBInstanceName": "",
    "BackupWay": "",
    "BackupPeriod": "",
    "ForceCleanOnHighSpaceUsage": 0,
    "BackupType": "",
    "LocalLogRetention": 0,
    "RemoveLogRetention": 0,
    "BackupPlanBegin": "",
    "BackupSetRetention": 0,
    "IsEnabled": 0,
    "ColdDataBackupInterval": 0,
    "ColdDataBackupRetention": 0,
    "LocalLogRetentionNumber": 0,
    "IsCrossRegionDataBackupEnabled": false,
    "IsCrossRegionLogBackupEnabled": false,
    "DestCrossRegion": "",
    "CrossRegionDataBackupRetention": 0,
    "CrossRegionLogBackupRetention": 0,
    "CrossRegionFilterValue": ""
  }
}

錯誤碼

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

變更歷史

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