调用API即应用调用生产环境中的API。在为企业建立API生态场景中,您需要调用API进行二次开发或开放API给合作伙伴等,帮助企业实现数据的资产化和价值化。本文为您介绍如何调用API。
前提条件
步骤一:查询并申请API
在Dataphin首页,在顶部菜单栏选择服务 > 市场。
单击左侧导航栏的API服务,在API服务页面的API列表中,单击目标文档说明列下的API文档,进入API文档页面。
在API文档页面,查看基本信息、排序设置(仅服务单元API-向导模式支持)、业务请求参数列表、公共请求参数列表、返回参数列表及JSON返回示例,是否符合您的业务场景。
确认当前API符合您业务场景的后,单击申请状态列下的立即申请。
在API权限申请页面,申请API的权限。具体操作,请参见申请API权限。
说明需申请该API的所属应用权限才能使用该API。
步骤二:调试API
完成API权限申请后,您可以在已授权API服务页面查看到该API。随后,您可以进行调试该API是否可以正常使用。您可以根据如下路径进入API调试页面。
单击顶部菜单栏调用 > 选择服务项目 > 单击左侧导航栏已授权API服务 > 单击目标API的图标。
在API调试页面,配置调试输入值。调试参数配置与测试API是否一致,详情请参见步骤一:测试API。
步骤三:下载文档
您可以下载API文档分享给其他开发人员,提高使用灵活性。支持下载Word格式的文档,便于修改。
在Dataphin首页,单击顶部菜单栏的服务 > 市场。
单击左侧导航栏的API服务,单击目标API文档说明列下的API文档。
在API文档页面,单击右上角的下载API文档,下载单个API文档;您也可以在API服务页面,选择多个API,单击底部的下载API文档,批量下载API文档。
下载的API文档中会根据该API生成具体的调用示例,方便您使用;您也可以根据API调用模板配置调用示例。
支持将API文档下载至本地,格式为Word。
API文档包括文档目录、文档版本、API调用示例、接口列表(按接口维度,每个接口内容包括基本信息、排序设置(仅服务单元API-向导模式支持)、业务请求参数列表、公共请求参数列表、返回参数列表、JSON返回示例、该API调用的具体示例)。
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 | 不支持 | ||
SelectDB | 支持 | ||
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。