API標準及多語言預置SDK
本產品（Dbs/2019-03-06）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。
在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。
備份計劃
|
API |
標題 |
API概述 |
| CreateBackupPlan | 建立備份計劃 | 該介面用於建立一個DBS備份計劃。 |
| CreateAndStartBackupPlan | 建立並啟動備份計劃 | 該介面用於建立、配置並啟動備份計劃。 |
| StartBackupPlan | 啟動備份計劃 | 該介面用於啟動一個DBS備份計劃。 |
| EnableBackupLog | 開啟增量備份 | 該介面用於開啟備份計劃中的增量備份。 |
| StopBackupPlan | 暫停備份計劃 | 該介面用於暫停一個DBS備份計劃。 |
| DisableBackupLog | 關閉增量備份 | 該介面用於關閉備份計劃中的增量備份。 |
| ModifyBackupObjects | 修改備份對象 | 該介面用於修改一個DBS備份計劃的備份對象。 |
| ModifyBackupSourceEndpoint | 修改Database Backup源 | 該介面用於修改Database Backup源。 |
| 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 | 透過備份閘道獲取資料庫列表 | 該介面用於透過備份閘道獲取物理備份的庫表資料。 |
| InitializeDbsServiceLinkedRole | 授權DBS服務關聯角色 | 該介面用於將服務關聯角色（AliyunServiceRoleForDBS）授權給DBS。 |
Others
|
API |
標題 |
API概述 |
| DescribeRegions | 查看DBS支援地區 | 該介面用於查看DBS支援地區。 |