集成概覽
數(shù)據(jù)管理DMS提供可視化操作控制臺，還提供OpenAPI在線調(diào)試、阿里云SDK、CLI等調(diào)用方式。為提升您使用DMS的開發(fā)效率，建議您按需選擇合適的操作和集成方式。
OpenAPI介紹
為了能夠讓您快速高效地學(xué)習(xí)和使用云產(chǎn)品OpenAPI，阿里云為用戶提供OpenAPI網(wǎng)站。它是一款集OpenAPI智能搜索、文檔、在線調(diào)試、SDK獲取、CodeSample、調(diào)用出錯診斷、調(diào)用統(tǒng)計為一體的產(chǎn)品。您可以在OpenAPI門戶中調(diào)用阿里云各云產(chǎn)品開放的OpenAPI，查看OpenAPI請求和返回結(jié)果。此外，OpenAPI門戶會自動生成相應(yīng)的SDK調(diào)用示例，幫助您快速使用阿里云產(chǎn)品。更多信息，請參見什么是OpenAPI。
版本說明
阿里云OpenAPI通過版本號管控各時期云產(chǎn)品大版本的API。
例如：DMS目前支持2018-11-01版本的API，2018-11-01代表的是API版本號而非時間概念，所展示的都是最新的API公開數(shù)據(jù)，并非自2018-11-01之后就未更新。
功能名稱 | API 版本號 | 說明 |
數(shù)據(jù)管理DMS | 推薦使用 | |
數(shù)據(jù)災(zāi)備（DBS） | 提供備份任務(wù)管理、恢復(fù)任務(wù)管理、備份集下載等功能。該版本支持的API詳情，請參見2019-03-06 API概覽。 | |
提供沙箱實例管理、RDS高級下載等功能。該版本支持的API詳情，請參見2021-01-01 API概覽。 |
接口風格
RPC風格。更多關(guān)于接口風格的介紹，請參見OpenAPI風格。
在線調(diào)試
DMS在OpenAPI門戶提供API調(diào)試等功能。在調(diào)用前，您需要了解DMS提供的版本、接入點、接口風格、調(diào)用方式等信息。
調(diào)試入口
功能名稱 | API 版本號 | 入口 |
數(shù)據(jù)管理DMS | ||
數(shù)據(jù)災(zāi)備（DBS） | https://next.api.aliyun.com/api/Dbs/2019-03-06/CreateBackupPlan | |
https://next.api.aliyun.com/api/Dbs/2021-01-01/DescribeDownloadSupport |
接入點說明
數(shù)據(jù)管理DMS
根據(jù)相關(guān)資源所在地域，選擇對應(yīng)的服務(wù)接入點地址，以獲得最低延遲。
例如華北3（張家口）的VPC接入地址為dms-enterprise-vpc.cn-zhangjiakou.aliyuncs.com，更多信息請參見服務(wù)接入點。
數(shù)據(jù)災(zāi)備（DBS）
根據(jù)相關(guān)資源所在地域，選擇對應(yīng)的接入地址，以獲得最低延遲。例如華北3（張家口）數(shù)據(jù)災(zāi)備（DBS）的公網(wǎng)接入地址為dbs-api.cn-zhangjiakou.aliyuncs.com，VPC接入地址為dbs-api-vpc.cn-zhangjiakou.aliyuncs.com。
公網(wǎng)接入地址在全球都可訪問。
VPC（Virtual Private Cloud）隔離了虛擬網(wǎng)絡(luò)，每個VPC對應(yīng)一個虛擬化網(wǎng)絡(luò)。VPC地址的優(yōu)勢：
高安全性：VPC接入地址只能在VPC內(nèi)部訪問，提供更高的安全性和隱私性。
更快的響應(yīng)速度：由于VPC接入地址在VPC內(nèi)部網(wǎng)絡(luò)中運行，其響應(yīng)速度通常比公網(wǎng)接入地址更快，并且可以避免公網(wǎng)延遲和帶寬限制等問題。
更低的成本：VPC接入地址可以使用內(nèi)部網(wǎng)絡(luò)通信。
更多信息，請參見服務(wù)接入點。
支持的調(diào)用身份
您的阿里云賬號登錄OpenAPI網(wǎng)站后，OpenAPI默認使用您的阿里云賬號進行在線OpenAPI調(diào)試。阿里云賬號擁有所有API的訪問權(quán)限，風險很高。強烈建議您創(chuàng)建并使用RAM用戶進行API訪問或日常運維。請根據(jù)業(yè)務(wù)的實際情況按需分配權(quán)限后進行接口調(diào)用。RAM用戶需具備操作DMS的權(quán)限，詳情請參見使用RAM進行訪問控制。
用戶身份 | 支持情況 |
支持 | |
RAM用戶（推薦） | 支持 |
RAM角色（推薦） | 支持 |
集成方式
集成概覽
DMS提供SDK等多種集成方式，您可以根據(jù)業(yè)務(wù)的實際需要進行選擇。
SDK便于集成，是OpenAPI最好的調(diào)用方式，推薦您選擇使用SDK。
數(shù)據(jù)管理DMS
調(diào)用方式 | 支持情況 |
阿里云SDK（推薦） | 支持 |
支持 | |
部分支持 | |
部分支持 | |
自定義封裝API調(diào)用（不推薦） | 支持 |
阿里云SDK
阿里云為開發(fā)者提供了多種編程語言（Java、C#、Go、Python、Node.js/TypeScript、PHP、C++等）的SDK。開發(fā)者只需集成SDK，通過SDK暴露的方法直接調(diào)用OpenAPI。SDK統(tǒng)一封裝了簽名邏輯、超時機制、重試機制，并根據(jù)文檔返回結(jié)構(gòu)化Response對象，易于開發(fā)。更多關(guān)于阿里云SDK的介紹，請參見阿里云SDK。
DMS SDK支持的語言及依賴的安裝方法請參見DMS SDK。
支持通過阿里云SDK調(diào)用數(shù)據(jù)災(zāi)備（DBS）的OpenAPI。更多詳情，請參見SDK參考。
阿里云CLI
阿里云命令行工具可以幫助您在使用命令行終端時，通過
aliyun命令與阿里云服務(wù)進行交互，管理云服務(wù)資源。有關(guān)阿里云CLI的更多詳細信息，請參見什么是阿里云CLI。支持使用阿里云CLI調(diào)用DMS API。更多信息，請參見使用阿里云CLI調(diào)用RPC API。
資源編排ROS
資源編排服務(wù)ROS（Resource Orchestration Service）是阿里云提供的一項簡化云計算資源管理的服務(wù)。開發(fā)者和管理員可以編寫模板，在模板中定義所需的阿里云資源（例如：ECS實例、RDS數(shù)據(jù)庫實例）、資源間的依賴關(guān)系等。ROS的編排引擎將根據(jù)模板自動完成所有資源的創(chuàng)建和配置，實現(xiàn)自動化部署及運維。更多詳情，請參見什么是資源編排服務(wù)。
支持使用ROS調(diào)用DMS API。支持編排的資源如下：
ALIYUN::DMS::Instance：錄入新實例。
ALIYUN::DMS::User：錄入新用戶。
快速使用資源編排ROS編排DMS，請參見資源編排ROS集成示例。
Terraform
Terraform支持的DMS的部分資源和數(shù)據(jù)資源如下表。如果您還不知道什么是Terraform，請參見什么是Terraform。
資源類型 | 資源類型 | 說明 |
Resources | 創(chuàng)建權(quán)限模板。 | |
錄入新實例。 | ||
創(chuàng)建邏輯庫。 | ||
開啟數(shù)據(jù)安全訪問功能。 | ||
授予安全訪問代理權(quán)限。 | ||
新增DMS用戶。 | ||
Data Sources | 獲取實例的數(shù)據(jù)庫詳情列表。 | |
獲取實例信息列表。 | ||
獲取邏輯庫信息。 | ||
獲取安全訪問代理列表。 | ||
獲取安全訪問代理授權(quán)信息。 | ||
獲取用戶詳情列表。 | ||
獲取當前的租戶列表。 |
自定義封裝API調(diào)用
原生HTTP調(diào)用需要您自己實現(xiàn)簽名算法，并構(gòu)建自定義請求，發(fā)起HTTP調(diào)用。有關(guān)簽名機制的更多詳細信息，請參見DMS API概覽和V3版本請求體&簽名機制。
數(shù)據(jù)災(zāi)備（DBS）
集成方式名稱 | 是否支持 |
阿里云SDK（推薦） | 支持 |
阿里云CLI | 不支持 |
資源編排 | 部分支持 |
Terraform | 部分支持 |
自定義封裝 | 支持 |
阿里云SDK
自定義封裝
您可以參考SDK部分的V3簽名文檔自定義封裝請求來訪問阿里云OpenAPI。原生HTTP調(diào)用需要您自己實現(xiàn)簽名算法，并構(gòu)建自定義請求，發(fā)起HTTP調(diào)用。有關(guān)簽名機制的更多詳細信息，請參見V3版本請求體&簽名機制。
注意事項
數(shù)據(jù)管理DMS
如果調(diào)用API后返回錯誤，您需要根據(jù)返回的錯誤碼提示檢查傳入的請求參數(shù)及其取值是否正確，更多信息請參見錯誤碼中心。
您也可以記錄下調(diào)用返回的RequestID或SDK報錯信息，通過阿里云OpenAPI診斷平臺進行自助診斷。
數(shù)據(jù)災(zāi)備（DBS）
如果調(diào)用API后返回錯誤，您需要根據(jù)返回的錯誤碼提示檢查傳入的請求參數(shù)及其取值是否正確。更多信息，請參見錯誤碼中心。
您也可以記錄下調(diào)用返回的RequestID或SDK報錯信息，通過阿里云OpenAPI診斷平臺進行自助診斷。