数据传输服务DTS(Data Transmission Service)提供可视化操作控制台,还提供OpenAPI在线调试、Terraform、阿里云SDK等调用方式。为提升您使用DTS的开发效率,建议您按需选择合适的操作和集成方式。
OpenAPI介绍
为了能够让开发者快速高效地学习和使用云产品OpenAPI,阿里云为用户提供OpenAPI网站。它是一款集OpenAPI智能搜索、文档、在线调试、SDK获取、CodeSample、调用出错诊断、调用统计为一体的产品。您可以在OpenAPI门户中调用阿里云各云产品开放的OpenAPI,查看OpenAPI请求和返回结果。此外,OpenAPI门户会自动生成相应的SDK调用示例,帮助您快速使用阿里云产品。更多信息,请参见什么是 OpenAPI。
版本说明
阿里云OpenAPI通过版本号管控各时期云产品大版本的API,例如DTS目前支持2020-01-01
版本的API,2020-01-01
代表的是API版本号而非时间概念,所展示的都是最新的API公开数据,并非自2020-01-01
之后就未更新。
版本号 | 说明 |
推荐使用。 | |
该版本OpenAPI支持的接口较少且不完善,不推荐使用。 | |
在线调试
DTS在OpenAPI门户提供API调试等功能。在调用前,您需要了解DTS提供的版本、接入点说明、集成方式等信息。
调试入口
接入点说明
根据相关资源所在地域,选择对应的服务接入点地址,以获得最低延迟。例如华北3(张家口)的DTS公网接入地址为dts.cn-zhangjiakou.aliyuncs.com
,VPC接入地址为dts-vpc.cn-zhangjiakou.aliyuncs.com
。
公网接入地址在全球都可以访问。
VPC接入地址只有在阿里云对应的地域内,且是VPC网络类型才可访问。VPC地址的优势:
高安全性:VPC接入地址只能在VPC内部访问,提供更高的安全性和隐私性。
更快的响应速度:由于VPC接入地址在VPC内部网络中运行,其响应速度通常比公网服务更快,且可以避免公网延迟和带宽限制等问题。
更低的成本:VPC接入地址可以使用内部网络通信。
更多信息,请参见服务接入点。
用户身份
当您登录OpenAPI网站后,OpenAPI默认使用您所登录的账号进行在线OpenAPI调试。由于阿里云账号拥有所有API的访问权限,存在较高风险,因此不建议您使用阿里云账号在线调试API。强烈建议您创建并使用RAM用户进行API访问或日常运维。请根据业务的实际情况按需分配权限后进行API调用。RAM用户需具备操作DTS的权限。具体操作,请参见授权信息。
用户身份 | 支持情况 |
支持 | |
RAM用户(推荐) | 支持 |
RAM角色(推荐) | 支持 |
更多信息
集成方式
DTS提供SDK等多种集成方式,您可以根据业务的实际需要进行选择。
集成方式名称 | 支持与否 |
阿里云SDK(推荐) | 支持 |
阿里云CLI | 不支持 |
Terraform | 支持 |
资源编排ROS | 不支持 |
自定义封装 | 支持 |
阿里云SDK
Terraform
Terraform是一种开源工具,用于安全高效地预览,配置和管理云基础架构和资源。它与阿里云的资源编排服务的运行机制类似,通过将模板转化为内部数据后完成OpenAPI调用。更多详情,请参见什么是 Terraform。
支持使用Terraform管理DTS的资源。支持的资源清单,请参见Terraform支持的DTS资源。
自定义封装API调用
如果以上方案均无法满足您的业务需要,可自行封装请求调用OpenAPI(不推荐),详情请参见V3版本请求体&签名机制。
注意事项
如果调用API后返回错误,您可以根据返回的错误码提示检查传入的请求参数及其取值是否正确,更多信息请参见错误码中心。
您也可以记录下调用返回的RequestID或SDK报错信息,通过阿里云OpenAPI诊断平台进行自助诊断。