开发的API只有通过测试并发布至数据服务市场中,用户才可以在数据服务市场中查询并申请调用该API的权限。本文为您介绍如何测试与发布API至数据服务市场中。

前提条件

在开始执行操作前,请确认您已完成API的创建:

步骤一:测试API

  1. 请参见入口介绍,进入数据服务。
  2. 在数据服务页面,按照下图操作指引,进入API测试页面。
    gagaga
  3. API测试页面,完成参数的配置。
    1. 配置业务请求参数列表区域的测试输入值为业务数据中的字段值。
      业务请求参数列表区域展示的参数是您创建API时配置的请求参数。gagaga
    2. 配置公共请求参数列表区域的参数。
      公共请求参数列表区域的参数包括PageStart、PageSize和OrderByList,根据API请求方式不同展示的参数不同。API请求方式为LIST时,展示PageStart、PageSize和OrderByList参数;API请求方式为GET时,展示OrderByList参数。gagaga
      参数描述测试输入值
      PageStart用于定义返回数据从第几条开始展示。配置成正整数,例如2。
      PageSize用于定义每页返回多少数据。配置成正整数,例如56。
      OrderByList用于定义多个返回参数的排序方式。如果没有填写则默认为升序排列。测试输入值需要从业务请求参数列表中获取。
    3. 可选返回参数列表区域选择返回参数。
      可选返回参数列表区域展示的参数是您创建API时配置的返回参数。您需要选择至少一个返回参数才能测试API。gagag
    4. 配置API的协议和返回条数。
      gagag
      参数描述
      协议如果您创建API时选择协议选了HTTP和HTTPS,则调试API时可以选择协议。
      返回条数用于定义测试API时返回数据的条数:
      • 如果请求方式为LIST,则支持选择返回条数
      • 请求方式为GET不支持修改返回条数
  4. 配置完成后,单击测试进行测试API与数据源数据的联通性。
    gagaga
  5. 测试详情区域,查看测试结果。
    如果测试失败,您可以查看附录:错误码及解决方案

步骤二:发布API

  1. 在API列表页面,按照下图操作指引,发布API。
    fagag
  2. 单击确认,发布API至生产环境。
    后续业务应用用户就可以在数据服务总览页面查询并申请调用API的权限。

附录:错误码及解决方案

错误代码错误问题解决方案
DPN-OLTP-COMMON-000成功。无。
DPN-OLTP-COMMON-001系统发生未知异常。请提交工单,或联系Dataphin的支持人员协助处理。
DPN-OLTP-COMMON-002参数异常。请检查参数的正确性。
DPN-OLTP-COMMON-003系统发生未知异常。请提交工单,或联系Dataphin的支持人员协助处理。
DPN-OLTP-COMMON-004SQL解析异常。SQL语句中未定义字段别名,请检查并修改SQL语句。
DPN-OLTP-ENGINE-001参数错误。检查设置的参数。
DPN-OLTP-ENGINE-002对象找不到。请提交工单,或联系Dataphin的支持人员协助处理。
DPN-OLTP-ENGINE-003不支持。无。
DPN-OLTP-ENGINE-004通信表错误。无。
DPN-OLTP-ENGINE-005SQL解析失败。请提交工单,或联系Dataphin的支持人员协助处理。
DPN-OLTP-ENGINE-006元数据错误。
DPN-OLTP-ENGINE-007参数处理错误。
DPN-OLTP-ENGINE-008构建执行模型错误。
DPN-OLTP-ENGINE-009测试执行失败。
DPN-OLTP-ENGINE-010数据源错误。
DPN-OLTP-ENGINE-011HBase引擎不支持。无。
DPN-OLTP-ENGINE-012对象序列化失败。请提交工单,或联系Dataphin的支持人员协助处理。
DPN-OLTP-ENGINE-013权限校验失败。请申请数据表的权限,具体操作请参见申请、续期和交还表权限

获取对应数据表权限后,还是未能解决该问题,请提交工单,或联系Dataphin的支持人员协助处理。

DPN-OLTP-ENGINE-014Elasticsearch引擎不支持。无。
DPN-OLTP-ENGINE-015MongoDB引擎不支持。无。
DPN-OLTP-ENGINE-016字段类型错误。检查配置的字段类型是否与数据源的字段类型不一致。
DPN-OLTP-ENGINE-017Redis缓存异常。请提交工单,或联系Dataphin的支持人员协助处理。
DPN-OLTP-ENGINE-018跨数据源不支持。无。
DPN-OLTP-ENGINE-019数据类型编码或者转换失败。请提交工单,或联系Dataphin的支持人员协助处理。
DPN-OLTP-ENGINE-20熔断。
DPN-OLTP-ENGINE-21限流。您可以配置API限流,以降低请求并发量。
DPN-OLTP-ENGINE-018-01跨数据源不支持Group By。请检查SQL。
DPN-OLTP-ENGINE-018-02跨数据源不支持Order By。
DPN-OLTP-ENGINE-018-03跨数据源不支持没有Where条件。
DPN-OLTP-ENGINE-018-04跨数据源不支持PageStart不等于0。
DPN-OLTP-ENGINE-018-05跨数据源不支持在Where条件中存在or的操作。
DPN-OLTP-ENGINE-018-06跨数据源不支持在一个Select item中有来自多个物理表的字段。
DPN-OLTP-ENGINE-018-07跨数据源查询必须所有的主键都在。
DPN-OLTP-JDBC-001请求参数错误。检查设置的参数是否正确。
DPN-OLTP-JDBC-002请求和账号ID不匹配。检查Session ID和Account ID是否匹配。如果匹配,请提交工单,请提交工单,或联系Dataphin的支持人员协助处理。
DPN-OLTP-JDBC-003用户无权访问数据库。请申请数据源的权限,具体操作请参见申请数据源权限

获取对应数据表权限后,还是未能解决该问题,请提交工单,或联系Dataphin的支持人员协助处理。

DPN-OLTP-JDBC-004用户无权访问数据表。请申请数据表的权限,具体操作请参见申请、续期和交还表权限

获取对应数据表权限后,还是未能解决该问题,请提交工单,或联系Dataphin的支持人员协助处理。

DPN-OLTP-JDBC-005Account Id出错检查Accout ID的正确性。
DPN-OLTP-OLAP-001OLAP客户端失败重连客户端尝试。如果仍失败请提交工单,或联系Dataphin的支持人员协助处理。
DPN-OLTP-JDBC-002OLAP客户端运行失败请提交工单,或联系Dataphin的支持人员协助处理。

后续步骤

测试与发布API后,您就可以在数据服务市场中查询并申请调用的权限。具体操作,请参见调用API