文档

调用API

更新时间:

调用API即应用调用生产环境中的API。在为企业建立API生态场景中,您需要调用API进行二次开发或开放API给合作伙伴等,帮助企业实现数据的资产化和价值化。本文为您介绍如何调用API。

前提条件

在开始执行操作前,请确认您已满足以下条件:

操作流程

  1. 步骤一:创建应用

    在开始正式调用API前,需要完成应用(APP)的创建。

  2. 步骤二:查询并申请API

    在数据服务市场中,查询符合您业务场景的API。查询到后申请该API的调用权限。

  3. 步骤三:调试API

    调试生产环境中的API是否可以正常使用。

  4. API调用模板

    根据调用API示例模板,配置API调用示例。

步骤一:创建应用

  1. 在Dataphin首页,单击顶部菜单栏的服务

  2. 在数据服务页面,按照下图操作指引,进入创建应用对话框。

    image

  3. 创建应用对话框,配置参数。

    image

    参数

    描述

    所属服务项目

    默认展示您在上述步骤中选择的服务项目,不支持修改。

    应用分组

    选择您已创建的应用分组。

    应用名称

    应用名称命名规则如下:

    • 包含汉字、字母、数字或下划线(_)。

    • 以字母开头。

    • 长度在4~26个字符范围内。

    应用负责人

    默认展示当前账号,不支持修改。

  4. 单击确定,完成应用的创建。

步骤二:查询并申请API

  1. 在数据服务页面,按照下图操作指引,进入API文档页面。

    image

  2. API文档页面,查看基本信息业务请求参数列表公共请求参数列表返回参数列表JSON返回示例,是否符合您的业务场景。

    image

  3. 查询到符合您业务场景的API后,单击立即申请

    image

  4. API权限申请页面,申请API的权限。具体操作,请参见申请API权限

    完成API权限申请后,您可以在已授权API服务页面查看到该API。后续您可以进行调试该API是否可以正常使用。

    image

步骤三:调试API

  1. 在数据服务页面,按照下图操作指引,进入API调试页面。

    image

  2. API调试页面,配置调试输入值。调试参数配置与测试API一致,详情请参见步骤一:测试API

步骤四:下载API文档

完成API开发后,可下载API文档,提高使用灵活性。在API服务界面,您可以通过点击API文档 > 下载API文档,下载单个API文档;您也可以选择多个API,点击下载API文档,下载多个API文档。

说明
  • 下载的API文档中会根据该API生成具体的调用示例,方便您使用;您也可以根据API调用模板配置调用示例。

  • API下载的文档支持Word格式。

  • 文档包括文档目录、文档版本、API调用示例、接口列表(按接口维度,每个接口内容包括基本信息、业务请求参数列表、公共请求参数列表、返回参数列表、JSON返回示例、该API调用的具体示例)。

image.png

API调用模板

  1. 在数据服务页面,按照下图操作指引,查看API调用示例的模板。

    image您也可以单击默认调用示例下载,下载API调用示例。

    如果需要通过python方式调用API,则单击python调用示例下载,下载python示例文件压缩包。

    如果需要通过Java SDK方式调用API,则单击Java SDK下载,下载Java SDK代码包。

  2. 根据调用示例说明,进行调用API。

完成调用API后,即可查询数据。对于不同的服务类型和数据源支持查询条数如下表所示。

服务类型

服务单元

数据源类型

单次最大返回条数

查询总条数限制

API

单物理表服务单元

MySQL

10000

无上限

说明

SQL Server数据源类型暂不支持分页查询,无法通过分页请求参数PageStart和PageSize实现查询数据库中所有数据。

SQL Server

PostgreSQL

ElasticSearch

AnalyticDB for MySQL2.0

AnalyticDB for MySQL3.0

AnalyticDB for PostgreSQL

Oracle

10000

10000

HBase(0.9.4、1.1.x)

MongoDB

API

多物理表服务单元

MySQL

10000

无上限

说明

SQL Server数据源类型暂不支持分页查询,无法通过分页请求参数PageStart和PageSize实现查询数据库中所有数据。

SQLServer

PostgreSQL

AnalyticDB for MySQL2.0

AnalyticDB for MySQL3.0

AnalyticDB for PostgreSQL

API

多物理表服务单元

Oracle

10000

10000

ElasticSearch

HBase(0.9.4、1.1.x)

MongoDB

逻辑表API

Dataphin逻辑表

不涉及

10000

10000

Dataphin数据源

不涉及

Dataphin数据源

0~10000

无上限

在通过SDK调用API时,如需查询第9000~10000条数据,则公共请求参数PageStart配置为8999,PageSize配置为1000。

  • 本页导读 (0)
文档反馈