Data Transmission Service (DTS) provides a visualized management console and allows you to call API operations in OpenAPI Explorer or by using SDKs. To improve your development efficiency when you use DTS, we recommend that you select appropriate operations and integration method based on your business requirements.
OpenAPI Explorer
Alibaba Cloud provides OpenAPI Explorer to help developers use the API operations of various Alibaba Cloud services in an efficient manner. OpenAPI Explorer integrates multiple features related to API operations, such as intelligent search, documentation, online debugging, SDK download, sample code, error diagnosis, and call statistics. In OpenAPI Explorer, you can call the API operations of Alibaba Cloud services and view API requests and responses. OpenAPI Explorer also automatically generates the corresponding SDK sample code to facilitate the use of Alibaba Cloud services. For more information, see What is an API?
Versions
Alibaba Cloud OpenAPI Explorer manages the versions of Alibaba Cloud service APIs by version number. For instance, DTS supports the API of version 2020-01-01. 2020-01-01 is an API version number rather than a date. 2020-01-01 is the up-to-date version of the API, which provides the latest public information about the API.
Version number | Description |
Recommended. | |
We do not recommend using these versions, because they support only limited operations. | |
Online debugging
DTS provides features such as API debugging in OpenAPI Explorer. Before you call API operations, take note of the following information provided by DTS: versions, endpoints, and integration methods.
Debugging pages
The URL of the debugging page is https://next.api.alibabacloud.com/api/Dts/2020-01-01/.
Endpoints
Select an endpoint based on the region in which your resources reside to reduce latency. For example, if you use DTS in the China (Zhangjiakou) region, the public endpoints is dts.cn-zhangjiakou.aliyuncs.com, and the Virtual Private Cloud (VPC) endpoint is dts-vpc.cn-zhangjiakou.aliyuncs.com.
Public endpoints are accessible globally.
A VPC endpoint is accessible only from VPCs in a specific Alibaba Cloud region. VPC endpoints provide the following benefits:
High security: VPC endpoints can be accessed only within a VPC. This provides higher security and privacy.
Faster response: VPC endpoints use the internal network environment to deliver faster responses than public endpoints. In addition, you are free from issues such as network latency and bandwidth limits.
Lower cost: VPC endpoints are accessed over an internal network.
For more information, see Endpoints.
User identities
After you log on to OpenAPI Explorer by using your Alibaba Cloud account, OpenAPI Explorer uses your Alibaba Cloud account to perform online debugging by default. An Alibaba Cloud account has permissions on all API operations. Security risks may arise if you use an Alibaba Cloud account to debug API operations online. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O&M. Before you call API operations as a RAM user, grant the required permissions to the RAM user based on your business requirements. This way, you can use the RAM user to perform operations on the DTS. For more information, see RAM Authorization.
User identity | Description |
Supported | |
RAM user (recommended) | Supported |
RAM role (recommended) | Supported |
References
Integration methods
DTS provides multiple integration methods such as SDKs. You can select an integration method based on your business requirements.
Integration method | Description |
Alibaba Cloud SDK (recommended) | Supported |
Alibaba Cloud CLI | Not supported |
Terraform | Not supported |
Resource Orchestration Service (ROS) | Not supported |
Custom encapsulation | Supported |
Alibaba Cloud SDK
Alibaba Cloud provides SDKs for multiple programming languages, such as Java, C#, Go, Python, TypeScript, PHP, and C++. You can integrate the SDKs with your applications to directly call API operations. SDKs encapsulate information including signature logic, timeout mechanism, and retry mechanism, and return structured response objects based on specifications. This facilitates development. For more information about Alibaba Cloud SDKs, see Alibaba Cloud SDKs.
For more information about the programming languages and dependencies supported by the DTS SDKs, see DTS SDK.
Custom API encapsulation
If none of the preceding methods meets your business requirements, you can encapsulate a request for an API operation and call the operation. This method is not recommended. For more information, see Request syntax and signature method V3.
Usage notes
If an error is returned after you call an API operation, you need to check whether the values of the request parameters are valid based on the returned error code. For more information, see Error Codes.
You can perform self-service diagnostics based on the returned request ID or SDK error information on the OpenAPI problem diagnosis.