使用OpenAPI调用DMS-数据管理 DMS-阿里云帮助中心

数据管理DMS提供可视化操作控制台，还提供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 版本号	说明
数据管理DMS	2018-11-01	推荐使用
数据灾备	2021-01-01	提供备份任务管理、恢复任务管理、备份集下载等功能。该版本支持的API详情，请参见API概览。
数据灾备	2019-03-06	提供沙箱实例管理、RDS高级下载等功能。该版本支持的API详情，请参见API概览。

接口风格

RPC风格。更多关于接口风格的介绍，请参见OpenAPI风格。

在线调试

DMS在OpenAPI门户提供API调试等功能。在调用前，您需要了解DMS提供的版本、接入点、接口风格、调用方式等信息。

在 OpenAPI 门户调试页面，左侧导航树列出 ListInstances（获取实例信息列表）、AddInstance、ModifyInstance、GetInstance、DeleteInstance 等 API。选中接口后，中间面板可设置服务地址（如华东1（杭州））及请求参数：Tid（租户ID）、SearchKey（搜索关键字）、DbType（数据库类型）、EnvType（环境类型）、InstanceSource（实例来源）、NetType（网络类型）、InstanceState（实例状态）、PageNumber（分页页码）等，填写完成后单击发起调用即可发起请求。右侧文档面板展示各参数的类型与示例值。

调试入口

功能名称	API 版本号	入口
数据管理DMS	2018-11-01	https://api.aliyun.com/api/dms-enterprise/2018-11-01/
数据灾备	2021-01-01	https://next.api.aliyun.com/api/Dbs/2021-01-01/DescribeDownloadSupport
数据灾备	2019-03-06	https://next.api.aliyun.com/api/Dbs/2019-03-06/CreateBackupPlan

接入点说明

数据管理DMS

根据相关资源所在地域，选择对应的服务接入点地址，以获得最低延迟。

例如华北3（张家口）的VPC接入地址为dms-enterprise-vpc.cn-zhangjiakou.aliyuncs.com，更多信息请参见服务接入点。

数据灾备（DBS）

根据相关资源所在地域，选择对应的接入地址，以获得最低延迟。例如华北3（张家口）数据灾备的公网接入地址为dbs-api.cn-zhangjiakou.aliyuncs.com，VPC接入地址为dbs-api-vpc.cn-zhangjiakou.aliyuncs.com。

公网接入地址在全球都可访问。
VPC（Virtual Private Cloud）隔离了虚拟网络，每个VPC对应一个虚拟化网络。VPC地址的优势：
- 高安全性：VPC接入地址只能在VPC内部访问，提供更高的安全性和隐私性。
- 更快的响应速度：由于VPC接入地址在VPC内部网络中运行，其响应速度通常比公网接入地址更快，并且可以避免公网延迟和带宽限制等问题。
- 更低的成本：VPC接入地址可以使用内部网络通信。

更多信息，请参见服务接入点。

支持的调用身份

您的阿里云账号登录OpenAPI网站后，OpenAPI默认使用您的阿里云账号进行在线OpenAPI调试。阿里云账号拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。请根据业务的实际情况按需分配权限后进行接口调用。RAM用户需具备操作DMS的权限，详情请参见使用RAM进行访问控制。

用户身份	支持情况
阿里云账号	支持
RAM用户（推荐）	支持
RAM角色（推荐）	支持

集成方式

集成概览

DMS提供SDK等多种集成方式，您可以根据业务的实际需要进行选择。

说明

SDK便于集成，是OpenAPI最好的调用方式，推荐您选择使用SDK。

数据管理DMS

调用方式	支持情况
阿里云SDK（推荐）	支持
阿里云CLI	支持
资源编排ROS	部分支持
Terraform	部分支持
自定义封装API调用（不推荐）	支持

阿里云SDK

阿里云为开发者提供了多种编程语言（Java、C#、Go、Python、Node.js/TypeScript、PHP、C++等）的SDK。开发者只需集成SDK，通过SDK暴露的方法直接调用OpenAPI。SDK统一封装了签名逻辑、超时机制、重试机制，并根据文档返回结构化Response对象，易于开发。更多关于阿里云SDK的介绍，请参见阿里云SDK。
DMS SDK支持的语言及依赖的安装方法请参见DMS SDK。
支持通过阿里云SDK调用数据灾备的OpenAPI。更多详情，请参见SDK参考。

阿里云CLI

阿里云命令行工具可以帮助您在使用命令行终端时，通过aliyun命令与阿里云服务进行交互，管理云服务资源。有关阿里云CLI的更多详细信息，请参见什么是阿里云 CLI。
支持使用阿里云CLI调用DMS API。更多信息，请参见使用阿里云CLI调用RPC API。

资源编排ROS

资源编排服务ROS（Resource Orchestration Service）是阿里云提供的一项简化云计算资源管理的服务。开发者和管理员可以编写模板，在模板中定义所需的阿里云资源（例如：ECS实例、RDS数据库实例）、资源间的依赖关系等。ROS的编排引擎将根据模板自动完成所有资源的创建和配置，实现自动化部署及运维。更多详情，请参见什么是资源编排服务。
支持使用ROS调用DMS API。支持编排的资源如下：
- ALIYUN::DMS::Instance：录入新实例。
- ALIYUN::DMS::User：录入新用户。
快速使用资源编排ROS编排DMS，请参见资源编排ROS集成示例。

Terraform

Terraform支持的DMS的部分资源和数据资源如下表。如果您还不知道什么是Terraform，请参见了解阿里云Terraform。

资源类型	资源类型	说明
Resources	alicloud_dms_enterprise_authority_template	创建权限模板。
	alicloud_dms_enterprise_instance	录入新实例。
	alicloud_dms_enterprise_logic_database	创建逻辑库。
	alicloud_dms_enterprise_proxy	开启数据安全访问功能。
	alicloud_dms_enterprise_proxy_access	授予安全访问代理权限。
	alicloud_dms_enterprise_user	新增DMS用户。
Data Sources	alicloud_dms_enterprise_databases	获取实例的数据库详情列表。
	alicloud_dms_enterprise_instances	获取实例信息列表。
	alicloud_dms_enterprise_logic_databases	获取逻辑库信息。
	alicloud_dms_enterprise_proxies	获取安全访问代理列表。
	alicloud_dms_enterprise_proxy_accesses	获取安全访问代理授权信息。
	alicloud_dms_enterprise_users	获取用户详情列表。
	alicloud_dms_user_tenants	获取当前的租户列表。

自定义封装API调用

原生HTTP调用需要您自己实现签名算法，并构建自定义请求，发起HTTP调用。有关签名机制的更多详细信息，请参见DMS API概览和V3版本请求体&签名机制。

数据灾备（DBS）

集成方式名称	是否支持
阿里云SDK（推荐）	支持
阿里云CLI	不支持
资源编排	部分支持
Terraform	部分支持
自定义封装	支持

阿里云SDK

阿里云为您提供了多种编程语言（Java、C#、Go、Python、Node.js、TypeScript、PHP、C++等）的SDK。SDK屏蔽了OpenAPI实现细节，统一身份、认证及签名规则。您只需要集成SDK，通过SDK直接调用OpenAPI。关于更多阿里云SDK的介绍，请参见阿里云SDK。
支持通过阿里云SDK调用数据灾备的OpenAPI。更多详情，请参见SDK参考。

自定义封装

您可以参考SDK部分的V3签名文档自定义封装请求来访问阿里云OpenAPI。原生HTTP调用需要您自己实现签名算法，并构建自定义请求，发起HTTP调用。有关签名机制的更多详细信息，请参见V3版本请求体&签名机制。

注意事项

数据管理DMS

如果调用API后返回错误，您需要根据返回的错误码提示检查传入的请求参数及其取值是否正确，更多信息请参见错误码中心。
您也可以记录下调用返回的RequestID或SDK报错信息，通过阿里云OpenAPI诊断平台进行自助诊断。

数据灾备（DBS）

如果调用API后返回错误，您需要根据返回的错误码提示检查传入的请求参数及其取值是否正确。更多信息，请参见错误码中心。
您也可以记录下调用返回的RequestID或SDK报错信息，通过阿里云OpenAPI诊断平台进行自助诊断。