Data Management:Integration overview

Supported version

Alibaba Cloud APIs use version numbers to manage the versions of cloud service APIs.

For example, DMS supports the API of the 2018-11-01 version. 2018-11-01 is an API version number instead of a date. Users are provided with the latest public information about the API. 2018-11-01 is the up-to-date version of the DMS API.

API style

DMS API operations are called in the remote procedure call (RPC) mode.

Online debugging

DMS provides features such as API debugging in OpenAPI Explorer. Before you call API operations, you must understand the following information provided by DMS: the API version, endpoints, API style, and request methods.

Debugging

You can perform API debugging at https://api.alibabacloud.com/api/dms-enterprise/2018-11-01/.

Endpoints

Select an endpoint based on the region where your resource resides to reduce latency.

For example, if your instance resides in the China (Zhangjiakou) region and is deployed in a virtual private cloud (VPC), specify dms-enterprise-vpc.cn-zhangjiakou.aliyuncs.com as the endpoint. For more information, see Endpoints.

Supported identities

By default, after you log on to OpenAPI Explorer by using your Alibaba Cloud account, the Alibaba Cloud account is used to perform online debugging. An Alibaba Cloud account has permissions on all API operations. If you use an Alibaba Cloud account to call API operations, security risks may arise. We strongly recommend that you call API operations or perform routine O&M as a Resource Access Management (RAM) user. Before you call API operations as a RAM user, grant the required permissions to the RAM user based on your business requirements. The RAM user must have the required permissions to use DMS. For more information, see Use RAM to implement access control.

Integration overview

You can integrate DMS with your business systems by using different integration methods such as SDKs based on your business requirements.

Alibaba Cloud SDKs

• Alibaba Cloud provides SDKs in multiple programming languages, including Java, C#, Go, Python, TypeScript + Node.js, PHP, and C++. You can integrate the SDKs with your business systems to directly call API operations. SDKs encapsulate information including the signature logic, timeout mechanism, and retry mechanism and return structured response objects based on specifications, which provide convenience for developers. For more information, see Alibaba Cloud SDKs.

• For information about the programming languages and dependencies supported by DMS SDKs, see DMS SDKs.

Alibaba Cloud CLI

• Alibaba Cloud CLI allows you to use aliyun commands to interact with other Alibaba Cloud services to manage your Alibaba Cloud resources. For more information, see What is Alibaba Cloud CLI?

• You can use Alibaba Cloud CLI to call the API operations of DMS. For more information, see Call RPC API and RESTful API.

ROS

• ROS is an Alibaba Cloud service that can simplify the management of cloud computing resources. You can compile stack templates to describe cloud computing resources such as Elastic Compute Service (ECS) and ApsaraDB RDS instances, and the dependencies between resources in the templates. The ROS engine automatically creates and configures all resources in a stack based on a template to implement automated deployment and O&M. For more information, see What is ROS?

• You can use ROS to call the API operations of DMS. The following DMS-specific resource types are supported by ROS:

  • ALIYUN::DMS::Instance: registers an instance with DMS.

  • ALIYUN::DMS::User: adds a DMS user.

• For more information about how to use ROS to orchestrate DMS resources with efficiency.

Custom API encapsulation

To make native HTTP calls, you must construct custom requests and sign the requests. For more information about the signature method, see List of operations by function and Request syntax and signature method V3.