OpenAPI overview
Dataphin enables you to integrate your applications with the platform by using OpenAPI. To ensure service stability, Dataphin applies different throttling levels to its APIs.
Prerequisites
To use the API, you need an account and an AccessKey. This enables you to access the API by using client tools, such as a Software Development Kit (SDK) or a Command Line Interface (CLI). For details, see Create an AccessKey.
OpenAPI uses an RPC-style signature mechanism, which allows a program to call a function or method in another program as if it were a local call. For details about the signature, see Request structure and signature mechanism. Because manually generating the signature is a complex process that can take approximately five business days, we recommend contacting Dataphin technical support for assistance with the integration.
Limitations
OpenAPI is currently in public preview. API calls are free of charge during the public preview period. To use OpenAPI, contact Dataphin technical support.
You cannot use RAM roles to call OpenAPI.
Supported regions
China (Beijing), China (Shanghai), China (Shenzhen), China (Hangzhou), and China (Chengdu).
Endpoints by region
Region | Region ID | Public endpoint | VPC endpoint |
China (Beijing) | cn-beijing | dataphin-public.cn-beijing.aliyuncs.com | dataphin-public-vpc.cn-beijing.aliyuncs.com |
China (Hangzhou) | cn-hangzhou | dataphin-public.cn-hangzhou.aliyuncs.com | dataphin-public-vpc.cn-hangzhou.aliyuncs.com |
China (Shanghai) | cn-shanghai | dataphin-public.cn-shanghai.aliyuncs.com | dataphin-public-vpc.cn-shanghai.aliyuncs.com |
China (Shenzhen) | cn-shenzhen | dataphin-public.cn-shenzhen.aliyuncs.com | dataphin-public-vpc.cn-shenzhen.aliyuncs.com |
China (Chengdu) | cn-chengdu | dataphin-public.cn-chengdu.aliyuncs.com | dataphin-public-vpc.cn-chengdu.aliyuncs.com |
Call quotas by edition
For details on API throttling levels and version requirements by feature, see OpenAPI throttling levels and version requirements.
QPS (Queries Per Second) is the average number of API requests that can be processed per second.
Edition | QPS limit | Daily call limit |
Personal Edition | Total QPS for Level 1, 2, and 3 APIs: ≤ 5 | Total daily API calls: ≤ 100 |
Agile Development Edition (includes Database Edition and Big Data Edition) | Total daily API calls: ≤ 1,000 | |
Basic R&D Edition |
|
|
Intelligent R&D Edition |
|
OpenAPI reference
Log in to the OpenAPI Explorer with your primary Alibaba Cloud account.
In the left-side navigation pane, choose Documentation > API Reference.
On the API Reference page, you can find details for various APIs, including their request parameters, response parameters, and a sample response.
