数据服务API调用SKILL

更新时间:
复制 MD 格式

您可以通过自然语言指令驱动Qoder、CodeX等代码Agent,使用应用凭证调用Dataphin数据服务中已发布并授权的API。本文为您介绍该能力的功能、使用前提、使用示例与执行结果,并在附录中提供输入信息清单供参考。

功能介绍

数据服务API调用能力支持您通过自然语言指令,调用Dataphin数据服务中已发布并已授权的API,获取或写入业务数据。该能力使用数据服务应用的凭证(AppKey与AppSecret)发起调用,支持三种模式:同步调用即时返回结果,适合常规查询;异步调用适合大数据量场景,会自动提交任务、轮询状态并合并分页结果;流式调用逐帧返回数据片段。调用面向数据服务网关,可区分开发与生产环境。

适用场景:

  • 调用已发布的数据服务API查询业务数据。

  • 面对较大数据量的查询,采用异步方式获取完整结果。

  • 需要实时逐帧获取数据时采用流式调用。

  • 通过API执行新增、更新、删除等数据操作。

说明

能力限制:调用前目标API须已发布到相应环境,且调用所用应用已获得该API的授权;调用须使用数据服务应用的凭证(AppKey与AppSecret),而非阿里云账号的AccessKey;调用路径与操作类型(列表查询、单条查询、新增、更新、删除)由API发布时的操作类型决定;返回的业务成功标识为特定成功码,仅HTTP状态正常并不代表业务成功,需结合返回码与数据判断。

使用前提

  • 目标API已发布到要调用的环境(开发或生产)。

  • 调用所用的数据服务应用已创建,并已获得目标API的授权。

  • 已获取应用的AppKey、AppSecret以及数据服务网关地址。

  • 已知目标API的标识、操作类型及所需的业务请求参数。

使用示例

您可以直接用自然语言向Agent描述需求,以下为可直接复制的指令示例:

  • 用这个应用调用客户列表查询API,返回前10条。

  • 调用这个API按ID查询单条客户信息。

  • 数据量比较大,用异步方式调用这个列表API并合并结果。

  • 调用这个API新增一条记录。

交互步骤:

  1. 您发出调用指令后,Agent会与您确认应用凭证、网关地址、目标API及业务参数。

  2. 若只提供了应用名与API名,Agent通常会先反查补齐调用所需的凭证、API标识、操作类型与已授权字段等信息。

  3. Agent按同步、异步或流式方式发起调用,凭证信息不会打印到终端或日志。

  4. 调用完成后,Agent会整理并返回业务数据,同时说明调用是否成功。

执行结果

操作完成后,您可以获得以下结果:

  • 返回内容:同步调用即时返回业务数据;异步调用返回合并分页后的完整结果;流式调用逐帧返回数据片段。

  • 完成状态:调用成功以返回的业务成功码为准;列表查询的结果位于列表字段,单条查询的结果位于单对象字段。

  • 查看与验证:您可以核对返回数据是否包含预期的业务字段;若返回未授权或路径未绑定应用等错误,通常说明应用未获授权或操作类型不匹配,需回到授权环节处理。

说明

调用返回成功仅表示本次请求已被正确处理,最终数据请以API实际返回内容及Dataphin界面显示为准。

附录:输入信息

以下为调用数据服务API时可能涉及的信息项,仅供参考。实际使用时,Agent会根据您的指令自动识别所需信息,缺失时再向您询问;标注为无需提供的信息项由系统自动生成,您无需准备。

信息项

是否必填

说明

示例

应用AppKey

是

数据服务应用的AppKey,创建应用时获取,用于唯一确定应用。

——

应用AppSecret

是

数据服务应用的AppSecret,用于调用签名,属敏感凭证,不会打印。

——

网关地址

是

数据服务网关地址,可从Dataphin控制台的网络配置获取。

——

API标识

是

目标API的唯一标识,可查询已发布API列表获取。

10083

操作类型

是

API的操作类型,取值为列表查询、单条查询、新增、更新或删除,由API发布时决定。

LIST、GET

发布环境

否

调用的API发布环境,生产或开发,默认为生产。

RELEASE

数据环境

否

访问的数据环境,生产数据或开发数据,默认为生产数据。

PROD

业务参数

条件必填

API定义的请求参数,具体取决于目标API;只能传入已授权的返回字段。

——