调用API即应用调用生产环境中的API。在为企业建立API生态场景中,您需要调用API进行二次开发或开放API给合作伙伴等,帮助企业实现数据的资产化和价值化。本文为您介绍如何调用API。
前提条件
步骤一:查询并申请API
在Dataphin首页,单击顶部菜单栏的服务。
按照下图操作指引,进入API文档页面。
依次单击市场->API服务->API文档。
在API文档页面,查看基本信息、排序设置(仅服务单元API-向导模式支持)、业务请求参数列表、公共请求参数列表、返回参数列表及JSON返回示例,是否符合您的业务场景。
检查符合您业务场景的API后,单击立即申请。
在API权限申请页面,申请API的权限。具体操作,请参见申请API权限。
说明需申请该API的所属应用权限才能使用该API。
步骤二:调试API
完成API权限申请后,您可以在已授权API服务页面查看到该API。随后,您可以进行调试该API是否可以正常使用。按照下图操作指引,进入API调试页面。
在API调试页面,配置调试输入值。调试参数配置与测试API一致,详情请参见步骤一:测试API。
步骤三:下载API文档
支持下载API文档分享给其他开发人员,提高使用灵活性。在API服务界面,您可以通过点击API文档 > 下载API文档,下载单个API文档;您也可以选择多个API,点击下载API文档,下载多个API文档。
下载的API文档中会根据该API生成具体的调用示例,方便您使用;您也可以根据API调用模板配置调用示例。
API下载的文档支持Word格式,可以下载到本地文件。
文档包括文档目录、文档版本、API调用示例、接口列表(按接口维度,每个接口内容包括基本信息、排序设置(仅服务单元API-向导模式支持)、业务请求参数列表、公共请求参数列表、返回参数列表、JSON返回示例、该API调用的具体示例)。
API调用模板
在数据服务页面,按照下图操作指引,查看API调用示例的模板。
您也可以单击默认调用示例下载,下载API调用示例。
如果需要通过Python方式调用API,则单击python调用示例下载,下载Python示例文件压缩包。
如果需要通过Java SDK方式调用API,则单击Java SDK下载,下载Java SDK代码包。
根据调用示例说明,进行调用API。
API返回条数
完成调用API后,即可查询数据。对于不同的服务类型和数据源支持查询条数如下表所示。
数据源类型 | 单次最大返回条数 | 查询总条数限制 | 是否支持分页查询 |
单物理表服务单元 | |||
MySQL | 10000 | 无上限 | 支持 |
AnalyticDB for MySQL2.0 | 支持 | ||
ElasticSearch | 支持 | ||
Microsoft SQL Server | 不支持 | ||
PostgreSQL | 支持 | ||
AnalyticDB for MySQL3.0 | 支持 | ||
AnalyticDB for PostgreSQL | 支持 | ||
Hologres | 支持 | ||
Hbase(0.9.4/1.1.x/1.2.1/2.x) | 10000 | 10000 | 支持 |
Oracle | 支持 | ||
MongoDB | 支持 | ||
多物理表服务单元 | |||
MySQL | 10000 | 无上限 | 支持 |
AnalyticDB for MySQL2.0 | 支持 | ||
ElasticSearch | 支持 | ||
Microsoft SQL Server | 不支持 | ||
PostgreSQL | 支持 | ||
AnalyticDB for MySQL3.0 | 支持 | ||
AnalyticDB for PostgreSQL | 支持 | ||
Hologres | 支持 | ||
Hbase(0.9.4/1.1.x/1.2.1/2.x) | 10000 | 10000 | 支持 |
Oracle | 支持 | ||
MongoDB | 支持 | ||
直连数据源API | |||
Impala | 10000 | 无上限 | 支持 |
Oracle | 支持 | ||
MySQL | 支持 | ||
PostgreSQL | 支持 | ||
Microsoft SQL Server | 支持 | ||
Hologres | 支持 | ||
Lindorm | 支持 | ||
ClickHouse | 支持 | ||
StarRocks | 支持 | ||
TDengine | 不支持 | ||
SAP HANA | 不支持 | ||
Hbase(0.9.4/1.1.x/1.2.1/2.x) | 1 | 无上限 | 不支持 |
ElasticSearch | 10000 | 10000 | 支持 |
逻辑表API | |||
不涉及 | 10000 | 10000 | 支持 |
Dataphin数据源 | |||
Dataphin数据源 | 10000 | 无上限 | 支持 |
在通过SDK调用API时,如需查询第9000~10000条数据,则公共请求参数PageStart配置为9000,PageSize配置为1000。