备案 控制台
文档
产品文档

调用API

更新时间:
一键部署
产品详情
相关技术圈
我的收藏

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

前提条件

  • API已发布至数据服务市场。具体操作,请参见 测试与发布API

  • 需先创建应用。具体操作,请参见 新建应用

步骤一:查询并申请API

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

  2. 按照下图操作指引,进入API文档页面。

    依次单击市场->API服务->API文档

    image.png

  3. API文档页面,查看基本信息排序设置(仅服务单元API-向导模式支持)、业务请求参数列表公共请求参数列表返回参数列表JSON返回示例,是否符合您的业务场景。

    image

  4. 检查符合您业务场景的API后,单击立即申请

    image.png

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

    说明

    需申请该API的所属应用权限才能使用该API。

步骤二:调试API

  1. 完成API权限申请后,您可以在已授权API服务页面查看到该API。随后,您可以进行调试该API是否可以正常使用。按照下图操作指引,进入API调试页面。

    image.png

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

步骤三:下载API文档

支持下载API文档分享给其他开发人员,提高使用灵活性。在API服务界面,您可以通过点击API文档 > 下载API文档,下载单个API文档;您也可以选择多个API,点击下载API文档,下载多个API文档。

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

  • API下载的文档支持Word格式,可以下载到本地文件。

  • 文档包括文档目录、文档版本、API调用示例、接口列表(按接口维度,每个接口内容包括基本信息、排序设置(仅服务单元API-向导模式支持)、业务请求参数列表、公共请求参数列表、返回参数列表、JSON返回示例、该API调用的具体示例)。

image

API调用模板

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

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

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

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

  2. 根据调用示例说明,进行调用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。

上一篇:新建及管理服务应用 下一篇:调用Dataphin数据源
  • 本页导读 (0)

聚圣源英文 商标 取名起名大全我家暗卫不好哄起名字五行搭配最佳女婿最新章节乙一58起名网免费取名打分尚起名属羊女起什么名字好灵与肉剧情介绍孺子牛是什么意思?起名查询大神与七位伙伴给孩子起个牙名宝宝起名女宝宝名字大全翻译工作室四海钓鱼频道姓氏杨给女孩起名字许氏鼠年起名男孩国是千万家100分起名字猎人宝宝技能王怎么起名字好保温材料公司起名料理店潘字女人起名大全机电公司起名用字大全鞠姓属鼠起名路由器改密码公司八字起名字好教授走一步撞一下小说淀粉肠小王子日销售额涨超10倍罗斯否认插足凯特王妃婚姻让美丽中国“从细节出发”清明节放假3天调休1天男孩疑遭霸凌 家长讨说法被踢出群国产伟哥去年销售近13亿网友建议重庆地铁不准乘客携带菜筐雅江山火三名扑火人员牺牲系谣言代拍被何赛飞拿着魔杖追着打月嫂回应掌掴婴儿是在赶虫子山西高速一大巴发生事故 已致13死高中生被打伤下体休学 邯郸通报李梦为奥运任务婉拒WNBA邀请19岁小伙救下5人后溺亡 多方发声王树国3次鞠躬告别西交大师生单亲妈妈陷入热恋 14岁儿子报警315晚会后胖东来又人满为患了倪萍分享减重40斤方法王楚钦登顶三项第一今日春分两大学生合买彩票中奖一人不认账张家界的山上“长”满了韩国人?周杰伦一审败诉网易房客欠租失踪 房东直发愁男子持台球杆殴打2名女店员被抓男子被猫抓伤后确诊“猫抓病”“重生之我在北大当嫡校长”槽头肉企业被曝光前生意红火男孩8年未见母亲被告知被遗忘恒大被罚41.75亿到底怎么缴网友洛杉矶偶遇贾玲杨倩无缘巴黎奥运张立群任西安交通大学校长黑马情侣提车了西双版纳热带植物园回应蜉蝣大爆发妈妈回应孩子在校撞护栏坠楼考生莫言也上北大硕士复试名单了韩国首次吊销离岗医生执照奥巴马现身唐宁街 黑色着装引猜测沈阳一轿车冲入人行道致3死2伤阿根廷将发行1万与2万面值的纸币外国人感慨凌晨的中国很安全男子被流浪猫绊倒 投喂者赔24万手机成瘾是影响睡眠质量重要因素春分“立蛋”成功率更高?胖东来员工每周单休无小长假“开封王婆”爆火:促成四五十对专家建议不必谈骨泥色变浙江一高校内汽车冲撞行人 多人受伤许家印被限制高消费

聚圣源 XML地图 TXT地图 虚拟主机 SEO 网站制作 网站优化