All Products
Search
Document Center

Data Management:API overview

Last Updated:Aug 30, 2023

This topic describes the basic information and usage notes when you call API operations by using Data Management (DMS).

For more information about how to call an Alibaba Cloud service API, see Overview.

Basic information

Version description

Version

Description

2018-11-01

Recommended

User identity

Identity

Supported

Alibaba Cloud account

Supported.

RAM user (recommended)

Supported.

RAM role (recommended)

Supported.

We recommend that you use a RAM user or RAM role to call API operations. Before you use a RAM user or RAM role to call API operations, you need to grant permissions to the RAM user or RAM role.

API style

The remote procedure call (RPC) style is used.

Call methods

Call method

Supported

Description

Alibaba Cloud SDK (recommended)

Supported.

For more information about the programming languages that are supported by DMS SDK and the methods to install dependencies, visit DMS SDK.

Alibaba Cloud CLI

Supported.

None

Resource Orchestration Service (ROS)

Supported.

None

Terraform

Supported.

None

If the preceding call methods cannot meet your business requirements, you can create custom APIs (not recommended). For more information, see Overview.

Usage notes

If an error is returned after you call an API operation, you must check whether the request parameters and their values are valid based on the returned error code. For more information, see DMS error codes.

You can also use Alibaba Cloud OpenAPI Diagnostics to perform self-service diagnostics based on the returned request ID or SDK error information.