集成概覽
數(shù)據(jù)傳輸服務(wù)DTS(Data Transmission Service)提供可視化操作控制臺(tái),還提供OpenAPI在線調(diào)試、Terraform、阿里云SDK等調(diào)用方式。為提升您使用DTS的開(kāi)發(fā)效率,建議您按需選擇合適的操作和集成方式。
OpenAPI介紹
為了能夠讓開(kāi)發(fā)者快速高效地學(xué)習(xí)和使用云產(chǎn)品OpenAPI,阿里云為用戶提供OpenAPI網(wǎng)站。它是一款集OpenAPI智能搜索、文檔、在線調(diào)試、SDK獲取、CodeSample、調(diào)用出錯(cuò)診斷、調(diào)用統(tǒng)計(jì)為一體的產(chǎn)品。您可以在OpenAPI門戶中調(diào)用阿里云各云產(chǎn)品開(kāi)放的OpenAPI,查看OpenAPI請(qǐng)求和返回結(jié)果。此外,OpenAPI門戶會(huì)自動(dòng)生成相應(yīng)的SDK調(diào)用示例,幫助您快速使用阿里云產(chǎn)品。更多信息,請(qǐng)參見(jiàn)什么是 OpenAPI。
版本說(shuō)明
阿里云OpenAPI通過(guò)版本號(hào)管控各時(shí)期云產(chǎn)品大版本的API,例如DTS目前支持2020-01-01
版本的API,2020-01-01
代表的是API版本號(hào)而非時(shí)間概念,所展示的都是最新的API公開(kāi)數(shù)據(jù),并非自2020-01-01
之后就未更新。
版本號(hào) | 說(shuō)明 |
推薦使用。 | |
該版本OpenAPI支持的接口較少且不完善,不推薦使用。 | |
在線調(diào)試
DTS在OpenAPI門戶提供API調(diào)試等功能。在調(diào)用前,您需要了解DTS提供的版本、接入點(diǎn)說(shuō)明、集成方式等信息。
調(diào)試入口
調(diào)試API入口為:https://next.api.aliyun.com/api/Dts/2020-01-01/
接入點(diǎn)說(shuō)明
根據(jù)相關(guān)資源所在地域,選擇對(duì)應(yīng)的服務(wù)接入點(diǎn)地址,以獲得最低延遲。例如華北3(張家口)的DTS公網(wǎng)接入地址為dts.cn-zhangjiakou.aliyuncs.com
,VPC接入地址為dts-vpc.cn-zhangjiakou.aliyuncs.com
。
公網(wǎng)接入地址在全球都可以訪問(wèn)。
VPC接入地址只有在阿里云對(duì)應(yīng)的地域內(nèi),且是VPC網(wǎng)絡(luò)類型才可訪問(wèn)。VPC地址的優(yōu)勢(shì):
高安全性:VPC接入地址只能在VPC內(nèi)部訪問(wèn),提供更高的安全性和隱私性。
更快的響應(yīng)速度:由于VPC接入地址在VPC內(nèi)部網(wǎng)絡(luò)中運(yùn)行,其響應(yīng)速度通常比公網(wǎng)服務(wù)更快,且可以避免公網(wǎng)延遲和帶寬限制等問(wèn)題。
更低的成本:VPC接入地址可以使用內(nèi)部網(wǎng)絡(luò)通信。
更多信息,請(qǐng)參見(jiàn)服務(wù)接入點(diǎn)。
用戶身份
當(dāng)您登錄OpenAPI網(wǎng)站后,OpenAPI默認(rèn)使用您所登錄的賬號(hào)進(jìn)行在線OpenAPI調(diào)試。由于阿里云賬號(hào)擁有所有API的訪問(wèn)權(quán)限,存在較高風(fēng)險(xiǎn),因此不建議您使用阿里云賬號(hào)在線調(diào)試API。強(qiáng)烈建議您創(chuàng)建并使用RAM用戶進(jìn)行API訪問(wèn)或日常運(yùn)維。請(qǐng)根據(jù)業(yè)務(wù)的實(shí)際情況按需分配權(quán)限后進(jìn)行API調(diào)用。RAM用戶需具備操作DTS的權(quán)限。具體操作,請(qǐng)參見(jiàn)授權(quán)信息。
用戶身份 | 支持情況 |
支持 | |
RAM用戶(推薦) | 支持 |
RAM角色(推薦) | 支持 |
更多信息
集成方式
DTS提供SDK等多種集成方式,您可以根據(jù)業(yè)務(wù)的實(shí)際需要進(jìn)行選擇。
集成方式名稱 | 支持與否 |
阿里云SDK(推薦) | 支持 |
阿里云CLI | 不支持 |
Terraform | 支持 |
資源編排ROS | 不支持 |
自定義封裝 | 支持 |
阿里云SDK
阿里云為開(kāi)發(fā)者提供了多種編程語(yǔ)言(Java、C#、Go、Python、TypeScript、PHP、C++等)的SDK。開(kāi)發(fā)者只需集成SDK,通過(guò)SDK暴露的方法直接調(diào)用OpenAPI。SDK統(tǒng)一封裝了簽名邏輯、超時(shí)機(jī)制、重試機(jī)制,并根據(jù)文檔返回結(jié)構(gòu)化Response對(duì)象,易于開(kāi)發(fā)。更多關(guān)于阿里云SDK的介紹,請(qǐng)參見(jiàn)阿里云SDK。
DTS SDK支持的語(yǔ)言及依賴的安裝方法,請(qǐng)參見(jiàn)DTS SDK。
Terraform
Terraform是一種開(kāi)源工具,用于安全高效地預(yù)覽,配置和管理云基礎(chǔ)架構(gòu)和資源。它與阿里云的資源編排服務(wù)的運(yùn)行機(jī)制類似,通過(guò)將模板轉(zhuǎn)化為內(nèi)部數(shù)據(jù)后完成OpenAPI調(diào)用。更多詳情,請(qǐng)參見(jiàn)什么是 Terraform。
支持使用Terraform管理DTS的資源。支持的資源清單,請(qǐng)參見(jiàn)Terraform支持的DTS資源。
自定義封裝API調(diào)用
如果以上方案均無(wú)法滿足您的業(yè)務(wù)需要,可自行封裝請(qǐng)求調(diào)用OpenAPI(不推薦),詳情請(qǐng)參見(jiàn)V3版本請(qǐng)求體&簽名機(jī)制。
注意事項(xiàng)
如果調(diào)用API后返回錯(cuò)誤,您可以根據(jù)返回的錯(cuò)誤碼提示檢查傳入的請(qǐng)求參數(shù)及其取值是否正確,更多信息請(qǐng)參見(jiàn)錯(cuò)誤碼中心。
您也可以記錄下調(diào)用返回的RequestID或SDK報(bào)錯(cuò)信息,通過(guò)阿里云OpenAPI診斷平臺(tái)進(jìn)行自助診斷。