使用OpenAPI調用DMS - Data Management

Data Management提供可視化Operations 主控台，還提供OpenAPI線上調試、阿里雲SDK、CLI等調用方式。為提升您使用DMS的開發效率，建議您按需選擇合適的操作和整合方式。

OpenAPI介紹

為了能夠讓您快速高效地學習和使用雲產品OpenAPI，阿里雲為使用者提供OpenAPI網站。它是一款集OpenAPI智能搜尋、文檔、線上調試、SDK擷取、CodeSample、調用出錯診斷、調用統計為一體的產品。您可以在OpenAPI門戶中調用阿里雲各雲產品開放的OpenAPI，查看OpenAPI請求和返回結果。此外，OpenAPI門戶會自動產生相應的SDK調用樣本，協助您快速使用阿里雲產品。更多資訊，請參見什麼是OpenAPI。

版本說明

阿里雲OpenAPI通過版本號碼管控各時期雲產品大版本的API。

例如：DMS目前支援2018-11-01版本的API，2018-11-01代表的是API版本號碼而非時間概念，所展示的都是最新的API公開資料，並非自2018-11-01之後就未更新。

功能名稱	API 版本號碼	說明
Data Management	2018-11-01	推薦使用

線上調試

DMS在OpenAPI門戶提供API調試等功能。在調用前，您需要瞭解DMS提供的版本、存取點、介面風格、調用方式等資訊。

在 OpenAPI 門戶調試頁面，左側導航樹列出 ListInstances（擷取執行個體資訊列表）、AddInstance、ModifyInstance、GetInstance、DeleteInstance 等 API。選中介面後，中間面板可設定服務地址（如華東1（杭州））及請求參數：Tid（租戶ID）、SearchKey（搜尋索引鍵）、DbType（資料庫類型）、EnvType（環境類型）、InstanceSource（執行個體來源）、NetType（網路類型）、InstanceState（執行個體狀態）、PageNumber（分頁頁碼）等，填寫完成後單擊發起調用即可發起請求。右側文件面板展示各參數的類型與樣本值。

調試入口

功能名稱	API 版本號碼	入口
Data Management	2018-11-01	https://api.alibabacloud.com/api/dms-enterprise/2018-11-01/

存取點說明

Data Management

根據相關資源所在地區，選擇對應的服務存取點地址，以獲得最低延遲。

例如華北3（張家口）的VPC接入地址為dms-enterprise-vpc.cn-zhangjiakou.aliyuncs.com，更多資訊請參見服務存取點。

支援的調用身份

您的阿里雲帳號登入OpenAPI網站後，OpenAPI預設使用您的阿里雲帳號進行線上OpenAPI調試。阿里雲帳號擁有所有API的存取權限，風險很高。強烈建議您建立並使用RAM使用者進行API訪問或日常營運。請根據業務的實際情況按需分配許可權後進行介面調用。RAM使用者需具備操作DMS的許可權，詳情請參見使用RAM進行存取控制。

使用者身份	支援情況
阿里雲帳號	支援
RAM使用者（推薦）	支援
RAM角色（推薦）	支援

整合方式

整合概覽

DMS提供SDK等多種整合方式，您可以根據業務的實際需要進行選擇。

說明

SDK便於整合，是OpenAPI最好的調用方式，推薦您選擇使用SDK。

Data Management

調用方式	支援情況
阿里雲SDK（推薦）	支援
阿里雲CLI	支援
Resource Orchestration Service	部分支援
Terraform	不支援
自訂封裝API調用（不推薦）	支援

阿里雲SDK

阿里雲為開發人員提供了多種程式設計語言（Java、C#、Go、Python、Node.js/TypeScript、PHP、C++等）的SDK。開發人員只需整合SDK，通過SDK暴露的方法直接調用OpenAPI。SDK統一封裝了簽名邏輯、逾時機制、重試機制，並根據文檔返回結構化Response對象，易於開發。更多關於阿里雲SDK的介紹，請參見阿里雲SDK。
DMS SDK支援的語言及依賴的安裝方法請參見DMS SDK。

阿里雲CLI

阿里雲命令列工具可以協助您在使用命令列終端時，通過aliyun命令與阿里雲服務進行互動，管理雲端服務資源。有關阿里雲CLI的更多詳細資料，請參見什麼是阿里雲 CLI。
支援使用阿里雲CLI調用DMS API。更多資訊，請參見使用阿里雲CLI調用RPC API。

Resource Orchestration Service

Resource Orchestration Service服務ROS（Resource Orchestration Service）是阿里雲提供的一項簡化雲端運算資源管理的服務。開發人員和管理員可以編寫模板，在模板中定義所需的阿里雲資源（例如：ECS執行個體、RDS資料庫執行個體）、資源間的依賴關係等。ROS的編排引擎將根據模板自動完成所有資源的建立和配置，實現自動化部署及營運。更多詳情，請參見什麼是Resource Orchestration Service服務。
支援使用ROS調用DMS API。支援編排的資源如下：
- ALIYUN::DMS::Instance：錄入新執行個體。
- ALIYUN::DMS::User：錄入新使用者。
快速使用Resource Orchestration Service編排DMS，請參見Resource Orchestration Service整合樣本。

自訂封裝API調用

原生HTTP調用需要您自己實現簽名演算法，並構建自訂請求，發起HTTP調用。有關簽名機制的更多詳細資料，請參見DMS API概覽和V3版本請求體&簽名機制。

注意事項

Data Management

如果調用API後返回錯誤，您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確，更多資訊請參見錯誤碼中心。
您也可以記錄下調用返回的RequestID或SDK報錯資訊，通過阿里雲OpenAPI診斷平台進行自助診斷。