OpenAPI overview
Dataphin provides OpenAPI that you can use to integrate and interact with your applications. To ensure service stability, Dataphin applies different levels of rate limiting to APIs.
Prerequisites
Before you can use the API, you must have an Alibaba Cloud account and an AccessKey pair. You can use the AccessKey pair to access the API with client tools, such as a software development kit (SDK) or the command-line interface (CLI). For more information, see Create an AccessKey pair.
OpenAPI uses the Remote Procedure Call (RPC) signature style. This style allows a program to call the functions or methods of another program as if they were local. For more information about signing, see Request structure and signing mechanism. The self-signing process is complex and takes approximately five business days. Contact the Dataphin technical support team for expert guidance on signature integration.
Limits
OpenAPI is in public preview. During the public preview, API calls are free. To use this feature, contact Dataphin technical support.
RAM roles cannot be used to call OpenAPI.
Supported regions
China (Beijing), China (Shanghai), China (Shenzhen), and China (Hangzhou)
API call quotas for different Dataphin editions
For more information about the API rate limiting levels and edition requirements for different features, see OpenAPI rate limiting levels and edition requirements.
QPS: Queries per second. The number of API requests that can be processed per second.
Edition |
QPS limit |
Maximum daily calls |
Personal Edition |
Total QPS for Level-1, Level-2, and Level-3 APIs ≤ 5 |
Total daily API calls ≤ 100 |
Agile R&D Edition (includes Database Edition and Big Data Edition) |
Total daily API calls ≤ 1,000 |
|
Basic R&D Edition |
|
|
Intelligent R&D Edition |
|
View OpenAPI documentation
Log on to the OpenAPI Portal product homepage with your Alibaba Cloud account.
In the navigation pane on the left, choose Documents > API Documents.
The documentation center page displays information about the OpenAPI for different features, including request parameters, response parameters, and response examples.