Data Transmission Service:Integration overview

Versions

Alibaba Cloud OpenAPI uses version numbers to manage the APIs for major versions of its cloud products. For example, DTS currently supports the 2020-01-01 API version. The string 2020-01-01 represents an API version number, not a date. The displayed data is the latest public API data. This does not mean that the APIs have remained unchanged since 2020-01-01.

Online debugging

DTS provides API debugging features in OpenAPI Explorer. Before you call an API, note its supported versions, endpoints, and integration methods.

If your source or destination instance is a self-managed database, you must add the IP addresses of the DTS servers to the database's security settings. To obtain these IP addresses, call the DescribeDTSIP operation. In the left-side navigation pane of OpenAPI Explorer, select DescribeDTSIP. In the parameter configuration section, select a Service Address, such as China (Hangzhou), and enter the request parameters: RegionId (for example, cn-hangzhou), SourceEndpointRegion (required, the region of the source instance), and DestinationEndpointRegion (the region of the destination instance). Then, click Initiate Call.

Debugging URL

You can debug API operations at the following URL: https://next.api.alibabacloud.com/api/Dts/2020-01-01/

Endpoints

To minimize latency, connect to the endpoint in the region where your resources are located. For example, for resources in the China (Zhangjiakou) region, the public and VPC endpoints are dts.cn-zhangjiakou.aliyuncs.com and dts-vpc.cn-zhangjiakou.aliyuncs.com, respectively.

• Public endpoints are accessible from anywhere in the world.

• A VPC endpoint is accessible only from a VPC in the corresponding Alibaba Cloud region. VPC endpoints offer the following advantages:

  • High security: A VPC endpoint can be accessed only from within a VPC, providing enhanced security and privacy.

  • Faster response: By operating on a VPC's internal network, a VPC endpoint typically offers faster response times than a public endpoint and avoids public network latency and bandwidth limitations.

  • Lower cost: VPC endpoints use internal network communication, which can reduce data transfer costs.

For more information, see Endpoints.

User identity

When you log on to OpenAPI Explorer, it uses your current account to debug APIs by default. Because an Alibaba Cloud account has full access to all APIs, using it for debugging is a security risk. We strongly recommend that you create and use a RAM user for API access and routine O&M. Grant permissions to the RAM user based on your business needs before making API calls. The RAM user must have the required permissions to operate DTS. For more information, see RAM Authorization.

More information

• Identity, credential, and authorization

• Throttling and quota management

Alibaba Cloud SDK

• Alibaba Cloud provides an SDK for various programming languages, including Java, C#, Go, Python, TypeScript, PHP, and C++. You can integrate the SDK into your application to call APIs directly. The SDK handles common tasks like signing logic, timeouts, and retries, and returns structured response objects, which simplifies development. For more information about the Alibaba Cloud SDK, see Alibaba Cloud SDK.

• For information about the programming languages and dependencies supported by the DTS SDK, see DTS SDK.

Custom API encapsulation

If none of the preceding methods meet your business requirements, you can encapsulate API requests yourself. This method is not recommended. For more information, see V3 request structure and signature.