調用DescribeInstanceCrossBackupPolicy接口查詢跨地域備份設置。

僅適用于如下實例類型：

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeInstanceCrossBackupPolicy

系統規定參數，取值：DescribeInstanceCrossBackupPolicy。

DBInstanceId String 是 rm-uf6wjk5xxxxxxxxxx

實例ID。
RegionId String 是 cn-hangzhou

地域ID，可以通過接口DescribeRegions查看地域ID。

返回數據

名稱 類型 示例值 描述
BackupEnabled String Enable

跨地域備份總開關，取值：

  • Disable：關閉
  • Enable：開啟
BackupEnabledTime String 2019-06-12T05:44:21Z

跨地域備份開啟時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC時間）。

CrossBackupRegion String cn-shanghai

跨地域備份的目的地域ID。
CrossBackupType String 1

跨地域備份保存類型。默認值：1，表示每個備份都保存。

DBInstanceDescription String 測試數據庫

實例名稱，長度為2~256個字符。以中文、英文字母開頭，可以包含數字、中文、英文、下劃線（_）、短橫線（-）。

說明 不能以 http:// 和 https:// 開頭。
DBInstanceId String rm-uf6wjk5xxxxxxxxxx

實例ID。
DBInstanceStatus String Running

實例狀態。詳情請參見實例狀態表。

Engine String mysql

數據庫類型。
EngineVersion String 5.6

數據庫版本。
LockMode String Unlock

實例鎖定狀態，取值：

  • Unlock：正常，沒有鎖定。
  • ManualLock：手動觸發鎖定。
  • LockByExpiration：實例過期自動鎖定。
  • LockByRestoration：實例回滾前的自動鎖定。
  • LockByDiskQuota：實例空間滿自動鎖定，不可訪問實例。
LogBackupEnabled String Enable

跨地域日志備份開關，取值：

  • Disable：關閉
  • Enable：開啟
LogBackupEnabledTime String 2019-06-12T05:44:21Z

跨地域日志備份開啟時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC時間）。

RegionId String cn-hangzhou

實例所在地域ID。
RequestId String CB7667B2-72C8-497B-9BD8-3B343CEF51AB

請求ID。
RetentType Integer 1

跨地域備份保留方式。默認值：1，表示按時長保留。

Retention Integer 15

跨地域備份保留天數，取值：7~1825。

示例

請求示例

http(s)://rds.aliyuncs.com/?Action=DescribeInstanceCrossBackupPolicy
&DBInstanceId=rm-uf6wjk5xxxxxxxxxx
&RegionId=cn-hangzhou
&<公共請求參數>

正常返回示例

XML格式 

<DescribeInstanceCrossBackupPolicyResponse>
  <DBInstanceStatusDesc>ACTIVATION</DBInstanceStatusDesc>
	  <LockMode>Unlock</LockMode>
	  <BackupEnabledTime>2019-06-12T05:44:21Z</BackupEnabledTime>
	  <CrossBackupType>1</CrossBackupType>
	  <LogBackupEnabled>Enable</LogBackupEnabled>
	  <BackupEnabled>Enable</BackupEnabled>
	  <RetentType>1</RetentType>
	  <DBInstanceId>rm-bpxxxxx</DBInstanceId>
	  <DBInstanceDescription></DBInstanceDescription>
	  <Retention>15</Retention>
	  <Engine>mysql</Engine>
	  <LogBackupEnabledTime>2019-06-12T05:44:21Z</LogBackupEnabledTime>
	  <CrossBackupRegion>cn-shanghai</CrossBackupRegion>
	  <StorageOwner>rds</StorageOwner>
	  <RegionId>cn-hangzhou</RegionId>
	  <RequestId>CB7667B2-72C8-497B-9BD8-3B343CEF51AB</RequestId>
	  <EngineVersion>5.6</EngineVersion>
	  <StorageType>oss</StorageType>
	  <Endpoint></Endpoint>
	  <DBInstanceStatus>1</DBInstanceStatus>
</DescribeInstanceCrossBackupPolicyResponse>

JSON格式 

{
	"DBInstanceStatusDesc": "ACTIVATION",
	"LockMode": "Unlock",
	"BackupEnabledTime": "2019-06-12T05:44:21Z",
	"CrossBackupType": "1",
	"LogBackupEnabled": "Enable",
	"BackupEnabled": "Enable",
	"RetentType": 1,
	"DBInstanceId": "rm-bpxxxxx",
	"DBInstanceDescription": "",
	"Retention": 15,
	"Engine": "mysql",
	"LogBackupEnabledTime": "2019-06-12T05:44:21Z",
	"CrossBackupRegion": "cn-shanghai",
	"StorageOwner": "rds",
	"RegionId": "cn-hangzhou",
	"RequestId": "CB7667B2-72C8-497B-9BD8-3B343CEF51AB",
	"EngineVersion": "5.6",
	"StorageType": "oss",
	"Endpoint": "",
	"DBInstanceStatus": "1"
}

錯誤碼

HttpCode 錯誤碼 錯誤信息 描述
400 InvalidRegion.Format Specified Region is not valid. 指定的region不合法

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