注册API 本章节主要介绍注册API。 本文将为您介绍如何注册API,与通过数据表生成的API统一管理和发布到API网关。 目前数据服务共享版支持Restful风格的API注册,包含GET/POST常见请求方式。 配置API基本信息 1.在DataArts Studio控制台首页,选择实例,点击“进入控制台”,选择对应工作空间的“数据服务”模块,进入数据服务页面。 详见下图:选择数据服务 2.在左侧导航栏选择服务共享版,进入总览页。 3.进入“数据服务 > 开发API > API管理”页面,单击“注册现有API”,填写API基本信息。 详见下表:API基本信息 配置 说明 API名称 支持中文、英文、数字、下划线,且只能以英文或中文开头,364个字符。 API目录 一个特定功能或场景的API集合,是数据服务中API的最小组织单元,也是API网关中的最小管理单元。 您可单击“新建”进行新建,也可选择新建API目录已创建的API分组。 请求Path 资源路径,也即API访问路径。 示例:/v2/{projectid}/streams 协议 用于传输请求的协议,支持HTTP和HTTPS协议。 请求方式 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 GET:请求服务器返回指定资源。 POST:请求服务器新增资源或执行特殊操作,注册API时推荐使用。POST请求当前不支持body体,而是直接透传。 描述 对API进行简要描述。 标签 用户自定义输入,只能包含中文、英文字母、数字和下划线,且不能以下划线开头。 审核人 拥有API的审核权限。 单击“新建”,进入“审核中心>审核人管理”页面,新建审核人。 安全认证 API认证方式: APP认证:表示由API网关服务负责接口请求的安全认证。 IAM认证:表示借助IAM服务进行安全认证。 无认证:表示不需要认证。 服务目录可见性 发布后,所选范围内的用户均可以在服务目录中看到此API。 当前工作空间可见 当前项目可见 当前租户可见 访问日志 勾选,则此API的查询结果将会产生记录并被保留7天,可以在“运营管理>访问日志”处通过选择“请求日期”的方式查看对应日期的日志。 最低保留期限 API解绑前预留的最低期限。API进行停用/下线/取消授权时,会通知已授权用户,并为用户预留至少X小时,直到所有授权用户均完成解除或处理,或者到达截止时间, API才会停用/下线/取消授权。0表示不设限制。 入参定义 配置API请求中的参数,包含资源路径中的动态参数,请求URI中的查询参数和Header参数。 以配置资源路径中的动态参数为例进行说明,例如资源路径(请求Path)设置为: /v2/{projectid}/streams,资源路径中的{projectid}为动态参数,需要在此进行配置。 1. 单击“添加”,参数名配置为projectid。 2. 参数位置选择PATH。 3. 类型设置为STRING。 4. 选择性配置示例值和描述。 4.配置好API基本信息后,单击“下一步”,即可进入API取数逻辑页面。