Database Autonomy Service:Integration overview

Overview of OpenAPI Explorer

Alibaba Cloud provides OpenAPI Explorer for developers to understand and use the API operations of various Alibaba Cloud services in a quick and efficient manner. OpenAPI Explorer integrates multiple features related to API operations, including 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. In addition, OpenAPI Explorer 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 example, DAS provides the API of the 2020-01-16 version. 2020-01-16 indicates a version number of the API rather than the date when the API was last updated. You are provided with the latest API data in each version.

Online debugging

DAS allows you to debug its API by using OpenAPI Explorer. Before you call API operations, take note of the following information provided by DAS: versions, endpoints, and integration methods.

Online debugging page

You can call API operations of DAS on the online debugging page.

Endpoints

The DAS service is available only in the China (Shanghai) region. The public endpoint is das.cn-shanghai.aliyuncs.com and the Virtual Private Cloud (VPC) endpoint is das.vpc-proxy.aliyuncs.com.

• The public endpoint can be globally accessed.

• Each VPC is identified by using a unique tunnel ID, which corresponds to a virtualized network. The following section describes the benefits of VPC endpoints:

  • Higher security: VPC endpoints can be accessed only from within a VPC. This provides higher security and privacy.

  • Faster response: VPC endpoints use the internal network environment to deliver faster responses than those of public endpoints. In addition, by using VPC endpoints, you are free from issues such as network latency and bandwidth limits.

  • Lower cost: VPC endpoints are accessed over an internal network.

Supported 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 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 permissions to manage DAS resources. For more information, see How do I use DAS as a RAM user?

References

• Identity, credential, and authorization

• Throttling and quota management

Integration methods

DAS provides two integration methods: Alibaba Cloud SDKs and custom encapsulation. You can select an integration method based on your business requirements.

• Alibaba Cloud SDKs

  • Alibaba Cloud provides SDKs in multiple programming languages, including Java, C#, Go, Python, Node.js, TypeScript, PHP, and C++. You can integrate the SDKs with your applications to directly call API operations. SDKs encapsulate information such as the signature logic, timeout mechanism, and retry mechanism and return structured response objects based on specifications. This facilitates development. For more information, see Alibaba Cloud SDKs.

  • OpenAPI Explorer allows you to use Alibaba Cloud SDKs to call API operations of DAS. For more information about the supported languages and how to install dependencies, visit the DAS portal.

• Alibaba Cloud CLI

  • Alibaba Cloud CLI allows you to run aliyun commands to interact with Alibaba Cloud services and manage cloud service resources. For more information, see What is Alibaba Cloud CLI?

  • You cannot call API operations of DAS by using Alibaba Cloud CLI.

• ROS

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

  • You cannot call API operations of DAS by using ROS.

• Custom API encapsulation

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

Usage notes

If an error is returned after you call an API operation of DAS, you must check whether the request parameters and their values are correct based on the error code. For more information, see Public 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.