本產品(
數據庫備份/2019-03-06
)的OpenAPI采用RPC簽名風格,簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK,開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜,需花費 5個工作日左右。因此建議加入我們的服務釘釘群(11370001915),在專家指導下進行簽名對接。在使用API前,您需要準備好身份賬號及訪問密鑰(AccessKey),才能有效通過客戶端工具(SDK、CLI等)訪問API。細節請參見獲取AccessKey。
備份計劃
API | 標題 | API概述 |
---|---|---|
CreateBackupPlan | 創建備份計劃 | 該接口用于創建一個DBS備份計劃。 |
CreateAndStartBackupPlan | 創建并啟動備份計劃 | 該接口用于創建、配置并啟動備份計劃。 |
StartBackupPlan | 啟動備份計劃 | 該接口用于啟動一個DBS備份計劃。 |
EnableBackupLog | 開啟增量備份 | 該接口用于開啟備份計劃中的增量備份。 |
StopBackupPlan | 暫停備份計劃 | 該接口用于暫停一個DBS備份計劃。 |
DisableBackupLog | 關閉增量備份 | 該接口用于關閉備份計劃中的增量備份。 |
ModifyBackupObjects | 修改備份對象 | 該接口用于修改一個DBS備份計劃的備份對象。 |
ModifyBackupSourceEndpoint | 修改數據庫備份源 | 該接口用于修改數據庫備份源。 |
ModifyStorageStrategy | 修改存儲數據的生命周期 | 該接口用于修改備份計劃中的存儲數據的生命周期。 |
ModifyBackupPlanName | 修改備份計劃名稱 | 該接口用于修改一個備份計劃名稱。 |
ModifyBackupStrategy | 修改備份時間 | 該接口用于修改備份計劃的備份時間。 |
DescribeBackupPlanList | 查看備份計劃 | 該接口用于查看一個DBS備份計劃。 |
DescribeRestoreRangeInfo | 查看可恢復時間段詳情 | 該接口用于查看一個備份計劃可恢復時間段詳情。 |
DescribeBackupPlanBilling | 查看備份計劃計費信息 | 該接口用于查看備份計劃計費信息。 |
ConfigureBackupPlan | 配置備份計劃 | 該接口用于配置一個DBS備份計劃。 |
RenewBackupPlan | 續費備份計劃 | 該接口用于續費一個DBS備份計劃。 |
UpgradeBackupPlan | 升級備份計劃 | 該接口用于升級一個DBS備份計劃。 |
ReleaseBackupPlan | 釋放按量付費的備份計劃 | 該接口用于釋放一個按量付費的備份計劃。 |
備份任務
API | 標題 | API概述 |
---|---|---|
DescribeIncrementBackupList | 查看增量備份任務列表 | 該接口用于查看DBS增量備份任務列表。 |
DescribeFullBackupList | 查看全量備份任務列表 | 該接口用于查看DBS全量備份任務列表。 |
恢復任務
API | 標題 | API概述 |
---|---|---|
CreateRestoreTask | 創建恢復任務 | 該接口用于創建DBS恢復任務。 |
StartRestoreTask | 啟動恢復任務 | 該接口用于啟動一個DBS恢復任務。 |
DescribeRestoreTaskList | 查看恢復任務列表 | 該接口用于查看DBS恢復任務列表。 |
備份網關
API | 標題 | API概述 |
---|---|---|
DescribeBackupGatewayList | 查看備份網關列表 | 該接口用于查看DBS備份網關列表。 |
備份集下載
API | 標題 | API概述 |
---|---|---|
CreateFullBackupSetDownload | 創建全量備份集下載任務 | 該接口用于創建并啟動全量備份集下載任務。 |
CreateIncrementBackupSetDownload | 創建增量備份集下載任務 | 該接口用于創建并啟動增量備份集下載任務。 |
ModifyBackupSetDownloadRules | 設置備份集下載規則 | 該接口用于開啟、修改、關閉自動下載功能。 |
DescribeBackupSetDownloadTaskList | 查看備份集下載列表 | 該接口用于查看DBS備份集下載列表。 |
服務管理
API | 標題 | API概述 |
---|---|---|
CreateGetDBListFromAgentTask | 創建數據庫列表任務 | 該接口用于通過備份網關獲取數據庫列表任務。 |
DescribeNodeCidrList | 查看DBS運行節點網段 | 該接口用于查看DBS運行節點網段列表。 |
DescribeJobErrorCode | 查看任務錯誤碼信息 | 該接口用于查看DBS任務錯誤碼信息。 |
DescribePreCheckProgressList | 查看預檢查進度列表 | 該接口用于查看備份計劃預檢查進度和恢復任務預檢查進度。 |
DescribeDLAService | 查看數據查詢服務(DLA) | 該接口用于查看備份計劃的數據查詢服務(DLA)。 |
GetDBListFromAgent | 通過備份網關獲取數據庫列表 | 該接口用于通過備份網關獲取物理備份的庫表數據。 |
DescribeRegions | 查看DBS支持地域 | 該接口用于查看DBS支持地域。 |
InitializeDbsServiceLinkedRole | 授權DBS服務關聯角色 | 該接口用于將服務關聯角色(AliyunServiceRoleForDBS)授權給DBS。 |