DescribeBackupPolicy - 查詢自動備份策略 - Tair (Redis® OSS-Compatible)

查詢雲資料庫 Tair（相容 Redis）執行個體的備份策略，包括備份周期、備份時間等。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:DescribeBackupPolicy

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	執行個體 ID。	r-bp1zxszhcgatnx****

返回參數

名稱	類型	描述	樣本值
	object
BackupRetentionPeriod	string	備份保留天數。	7
RequestId	string	請求 ID。	90B82DB7-FB28-4CC2-ADBF-1F8659F3****
PreferredBackupPeriod	string	備份周期，傳回值： Monday：周一。 Tuesday：周二。 Wednesday：周三。 Thursday：周四。 Friday：周五。 Saturday：周六。 Sunday：周日。	Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
PreferredNextBackupTime	string	下次備份時間，格式為yyyy-MM-ddTHH:mmZ（UTC 時間）。	2019-03-14T05:28Z
PreferredBackupTime	string	備份時間，格式為HH:mmZ-HH:mmZ（UTC 時間）。	05:00Z-06:00Z
EnableBackupLog	integer	是否開啟了增量備份，傳回值： 1：已開啟。 0：未開啟。	1
AccessDeniedDetail	object	本組參數已棄用，請忽略。
AuthAction	string	說明如上。	-
AuthPrincipalDisplayName	string	說明如上。	-
AuthPrincipalOwnerId	string	說明如上。	-
AuthPrincipalType	string	說明如上。	-
EncodedDiagnosticMessage	string	說明如上。	-
NoPermissionType	string	說明如上。	-
PolicyType	string	說明如上。	-
DbsInstance	string	執行個體是否啟用備份服務化，取值： 1：開啟 0：未開啟	0

樣本

正常返回樣本

JSON格式

{
  "BackupRetentionPeriod": "7",
  "RequestId": "90B82DB7-FB28-4CC2-ADBF-1F8659F3****",
  "PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
  "PreferredNextBackupTime": "2019-03-14T05:28Z",
  "PreferredBackupTime": "05:00Z-06:00Z",
  "EnableBackupLog": 1,
  "AccessDeniedDetail": {
    "AuthAction": "-",
    "AuthPrincipalDisplayName": "-",
    "AuthPrincipalOwnerId": "-",
    "AuthPrincipalType": "-",
    "EncodedDiagnosticMessage": "-",
    "NoPermissionType": "-",
    "PolicyType": "-"
  },
  "DbsInstance": "0"
}

異常返回樣本

JSON格式

{
	"PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
	"RequestId": "90B82DB7-FB28-4CC2-ADBF-1F8659F30C26",
	"PreferredNextBackupTime": "2018-10-26T19:05Z",
	"PreferredBackupTime": "19:00Z-20:00Z",
	"BackupRetentionPeriod": "7"
}

錯誤碼

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

變更歷史

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