文档

生成API

更新时间:

查询调试提供了TQL查询功能生成API,其他应用可以通过调用API来获取数据。本文介绍了如何将标签生成API。

前提条件

操作步骤

  1. 登录数据资源平台控制台

  2. 在页面左上角,单击菜单图标,选择研发工作台

  3. 在顶部菜单栏,单击选择工作组图标,选择目标工作组,单击资产加工

    说明

    若您已在资产加工页面,请跳过“单击资产加工”的操作。

  4. 在左侧导航栏,单击52416图标,选择

  5. (可选)在查询调试页面左上角,选择云计算资源。1

    说明

    此处默认的云计算资源为提前设置的分析数据库,请根据业务需要是否重新选择云计算资源。

  6. 在编辑器里面输入TQL语句。2

    说明
    • 可以从左侧拖入标签或对象以完成TQL快捷编写。

    • 关于TQL语句的使用方法,请参见TQL简介

    • 单击格式化图标,可以将TQL语句格式化。

    • 单击3图标,可以开启、关闭对象和标签的通用推荐。

  7. 在右侧变量列表,配置数据类型、是否必填、默认值和备注信息。

  8. 单击左上角的运行图标,查看运行结果。

  9. 根据配置信息生成API。

    1. 在编辑器上方工具栏,单击生成API图标。

    2. 创建API对话框填写API名称、API Path、API分组、版本和API描述。在API分组下拉列表,单击新建API分组,可根据业务需要添加目录。1

    3. 单击确定

      查看生成的API。

相关操作

操作

说明

查看API详情

页面,单击待查看API操作列的详情

编辑API

页面,单击待编辑API操作列的编辑

删除API

页面,单击待删除API操作列的删除

后续步骤

生成的API初始状态为未发布状态,需要发布后才能被调用。发布API的具体操作请参见发布API