調用DescribeInstanceCrossBackupPolicy介面查詢跨地區備份設定。

僅適用於如下執行個體：

  • MySQL 5.7高可用本地SSD盤版
  • MySQL 5.6

調試

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

請求參數

名稱 類型 是否必選 樣本值 描述
Action String 是 DescribeInstanceCrossBackupPolicy

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

DBInstanceId String 是 rm-uf6wjk5xxxxxxxxxx

執行個體ID。
RegionId String 是 cn-hangzhou

地區ID，可以通過介面DescribeRegions查看地區ID。

AccessKeyId String 否 LTAIfCxxxxxxx

阿里雲頒發給使用者的訪問服務所用的密鑰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
&<公用請求參數>

正常返回樣本

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",
	"RequestId":"CB7667B2-72C8-497B-9BD8-3B343CEF51AB",
	"RegionId":"cn-hangzhou",
	"Endpoint":"",
	"StorageType":"oss",
	"EngineVersion":"5.6",
	"DBInstanceStatus":"1"
}

錯誤碼

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