Data Management (DMS) provides a visual console and programmatic access through OpenAPI online debugging, the Alibaba Cloud SDK, and the Alibaba Cloud CLI. To build efficiently with DMS, select the integration method that best fits your requirements.
OpenAPI overview
To help you efficiently learn and use the OpenAPI of our cloud products, Alibaba Cloud provides the OpenAPI website. It is an all-in-one platform that features intelligent search, documentation, online debugging, access to SDKs, code samples, error diagnostics, and call statistics. You can use the OpenAPI portal to call the OpenAPI of various Alibaba Cloud products and view requests and responses. The portal also automatically generates SDK code samples to help you get started quickly with Alibaba Cloud products. For more information, see What is OpenAPI?.
API versions
Alibaba Cloud OpenAPI uses version numbers to manage the major API versions of cloud products.
For example, DMS supports API version 2018-11-01. The string 2018-11-01 is an API version identifier, not a date. It provides access to the latest API features and does not indicate that the API has been static since 2018-11-01.
|
Feature |
API version |
Description |
|
Data Management (DMS) |
Recommended. |
Online debugging
DMS provides API debugging and other features in the OpenAPI portal. Before making an API call, you must understand the versions, endpoints, API style, and request methods that DMS provides.
On the debugging page of the OpenAPI portal, the left-side navigation pane lists API operations such as ListInstances (retrieves a list of instance information), AddInstance, ModifyInstance, GetInstance, and DeleteInstance. After you select an API operation, the center panel allows you to configure the endpoint, such as China (Hangzhou), and the request parameters. These parameters include Tid (tenant ID), SearchKey (search keyword), DbType (database type), EnvType (environment type), InstanceSource (instance source), NetType (network type), InstanceState (instance state), and PageNumber (page number). After entering the values, click Initiate Call to send the request. The documentation panel on the right displays the data type and an example value for each parameter.
Debugging entry points
|
Feature |
API version |
Entry point |
|
Data Management (DMS) |
Endpoints
DMS
Select the endpoint that corresponds to the region where your resources are located to minimize latency.
For example, the VPC endpoint for the China (Zhangjiakou) region is dms-enterprise-vpc.cn-zhangjiakou.aliyuncs.com. For more information, see Endpoints.
Supported identities
After you log on to the OpenAPI website with your Alibaba Cloud account, API calls are made using this account by default for online debugging. Using an Alibaba Cloud account for routine API access is high-risk due to its full permissions. We strongly recommend creating and using a RAM user for daily operations. Grant permissions to the RAM user based on your business needs before making API calls. The RAM user must have the necessary permissions to operate DMS. For more information, see Use RAM for access control.
|
User identity |
Supported |
|
Supported |
|
|
RAM user (recommended) |
Supported |
|
RAM role (recommended) |
Supported |
Integration methods
Integration overview
DMS provides multiple integration methods, including SDKs. You can choose the method that best suits your business needs.
SDKs are easy to integrate and are the recommended method for calling OpenAPI.
DMS
|
Method |
Supported |
|
Alibaba Cloud SDK (recommended) |
Supported |
|
Supported |
|
|
Partially supported |
|
|
Not supported |
|
|
Custom API encapsulation (not recommended) |
Supported |
Alibaba Cloud SDK
-
Alibaba Cloud provides SDKs for multiple programming languages, including Java, C#, Go, Python, Node.js/TypeScript, PHP, and C++. You only need to integrate the SDK to call OpenAPI directly through the exposed methods. The SDKs simplify development by handling signing logic, timeout, and retry mechanisms, and returning structured Response objects. For more information about Alibaba Cloud SDKs, see Alibaba Cloud SDK.
-
For information about the languages and dependencies supported by the DMS SDK, see DMS SDK.
Alibaba Cloud CLI
-
The Alibaba Cloud CLI allows you to interact with Alibaba Cloud services and manage your cloud resources from a terminal by using
aliyuncommands. For more information about the Alibaba Cloud CLI, see What is Alibaba Cloud CLI? -
You can use Alibaba Cloud CLI to call DMS API operations. For more information, see Call RPC API operations by using Alibaba Cloud CLI.
Resource Orchestration (ROS)
-
Resource Orchestration Service (ROS) is an Alibaba Cloud service that simplifies the management of cloud resources. Developers and administrators can write templates to define the required Alibaba Cloud resources, such as ECS instances and RDS database instances, and their dependencies. The ROS orchestration engine automatically creates and configures all resources based on the template, enabling automated deployment and O&M. For more information, see What is Resource Orchestration Service?.
-
You can use ROS to orchestrate DMS resources. The following DMS resources are supported:
-
ALIYUN::DMS::Instance: Registers a new instance.
-
ALIYUN::DMS::User: Registers a new user.
-
-
To quickly use ROS to orchestrate DMS resources, see ROS integration example.
Custom API encapsulation
To make native HTTP calls, you must implement the signature algorithm, construct custom requests, and initiate the HTTP calls. For more information about the signature mechanism, see DMS API overview and Request body and signature mechanism (V3).
Usage notes
DMS
-
If an API call fails, use the returned error code to check your request parameters and their values. For more information, see Error codes.
-
Alternatively, record the RequestID or SDK error message from the response and use Alibaba Cloud OpenAPI Diagnostics to troubleshoot the issue.