Skip to main content

API管理平台常见问题(FAQ)

平台功能使用问题

管理平台支持的API类型,以及注册到平台后,发布出的API类型有哪些?

API管理平台支持的后端服务有HTTP/HTTPs、SOAP Service、主流关系型数据库以及编排平台的应用。更多类型的后端服务,可以使用编排平台作为后端进行对接更多类型的服务,比如Dubbo、HANA、Redis等等。

经过API管理平台发布的服务主要有HTTP/HTTPs和SOAP Service服务,其中SOAP Service只能为透传方式(不支持HTTP/HTTPs转换为SOAP Service)。

管理平台常用的授权和认证方式有哪些?

API门户中的API一般以匿名和授权两种方式。匿名方式不需要登录API门户即可访问相应的API;授权方式需要登录到API门户中,通过登录能访问到已经授权的API列表。常用的授权方式有APIkey和Basic authorization。

在“添加API”界面,API名称怎样能够显示完全?

  • “添加API”界面名称最多支持50个字符:

  • “名称”在UI界面只展现11位,其余省略号代替,如下图:

  • 鼠标悬停方式可以显示全部API名称。

如何针对某一用户进行权限控制?

权限主要分为两块:

  1. 平台功能权限

管理平台功能权限通过“角色”进行控制,每个“角色”可以设定不同的功能权限,可以按照业务需求设定不同的“角色”,然后“账号”关联到对应的“角色”,即可获得该“角色”的权限,每个“账号”可以关联多个“角色”,所具备的权限为几个角色权限的集合。相应的权限可以在平台右上角【系统设置】-【角色管理】中进行管理配置;

注:每个租户默认自动创建三个3个角色,租户管理员、租户运营者、租户开发者,这三个权限不允许编辑,如果权限不满足需求,可以给该租户创建新的角色。

  1. 平台资源权限

平台资源主要指项目资源、D2A应用资源、D2A数据源资源、门户资源等,相关资源可以通过权限设定,允许/禁止不同的账户访问或使用,主要有两种方式进行资源授权:

方式1:通过账号分配项目权限。【系统设置】-【账号管理】-选定账号-【资源配置】,如下图:

选择需要授权的资源(以项目资源为例)-选择项目-选择API-【添加资源】-选择权限(只读、修改、删除、导入、导出)-保存即可,如下图:

方式2:通过项目授予账号权限。【API管理】-【项目管理】-选择项目-【…】-【分配资源】

选择需要授权的账号-选择需要授予的权限:

平台中的租户是什么意思?

租户用于对平台资源进行逻辑隔离,租户内包含:项目及项目内的资源、D2A应用、API门户及门户内资源。可以按组织进行划分,实现不同组织的资源相互隔离。多租户只是在逻辑上进行了隔离,物理上还属于一个网关。详细信息参见手册http://orchsym.baishancloud.com/doc/manager3/dzh/dzh.html

API后端配置的重试是在什么情况下进行的?

重试的时机取决于nginx默认的upstream重试策略,默认配置的是网络错误和超时的情况下会重试:proxy_next_upstream error timeout;

平台【环境管理】-【环境列表】中是否可以增加新的环境 ?

不可以,这些环境是在部署前设计架构时配置的,用户只能针对已有环境信息编辑。

管理平台里面,环境列表有个域名项,这个选项和域名管理有什么联系?

如果在域名管理里添加了环境绑定的域名,在环境列表中会到这个对应的域名,相关域名可以绑定不同的项目,成为API URL的一部分。

管理平台D2A支持的数据库类型有哪些?

管理平台支持主流的关系型数据库:Oracle、MySQL、DB2、SQL Server、PostgreSQL,其余的数据库可以尝试使用编排平台处理。

如何使用平台项目的导入导出功能?

平台支持项目的导入和导出功能,使用方法详见操作手册:

http://orchsym.baishancloud.com/doc/manager3/importswagger.html

额外需要注意:

  1. 导入导出功能不支持集成编排应用的导出,因为导出后相关路由和后端信息会缺失。建议针对编排应用单独创建项目,不要和A2A、D2A类型在同一个项目中,便于后期统一维护;
  2. 项目导入导出功能从3.0_05000版本开始支持。

管理平台界面中【API日志管理】模块的原始日志怎么查找?

原始日志在对应的网关服务器中,具体路径如下:/data/kong/log/kong-xxx_orchsym.log

注:每个集群中可能存在多个网关环境,每个网关节点上可能部署有多个网关环境;上述路径中的kong_xxx为网关环境。

为什么我在平台中的看到的界面功能和其他人的不同?

系统会根据不同的人员关联不同的角色,不同的角色可以配置不同的平台使用权限,具体权限功能请联系管理员确认或申请。

在管理平台【项目管理】-【开发】页面修改API,并保存后,在API门户中调用该API,发现修改的信息并未生效,是什么原因?

在管理平台修改API配置后,其实只是修改了工作区的API,需要将工作区的API进行重新部署,部署后,已发布到API门户中的API才会对修改内容生效。

平台中API的URL路径是否可以修改?

URL的项目部分不允许修改,路由和API 请求Path部分允许修改。

后端API注册到管理平台的规则是什么?

规则:路由地址不会被代理到后端,后端填写只需要写前面部分,不需要填写完整的URL。

示例:原始API(后端)以https://reqres.in/api/users为例,在平台中添加方式为:后端地址:https://reqres.in/     路由地址:/任意值/     api请求地址: api/users在平台注册后的API URL:https://reqres.in/任意值/api/users

使用项目导入功能,显示导入成功,为什么显示的无API?

导入的API默认会在一个部署的版本中,工作区中默认不显示,如果需要在工作区显示,需要从对应的版本中加载到工作区,如下图所示:

如何开启/关闭一个项目的HTTP/HTTPS配置?

在【项目管理】--【总览】页面勾选操作,如下图所示操作:

想要删除一个无用的项目,删除按钮是灰色的,需要怎么操作?

  1. 首先确认下该项目中是否有API存在,需要清除API工作区数据后,才能删除项目;
  2. 确认下是否有项目的删除权限。

API项目部署时,误操作部署为旧版本项目,门户里的授权信息会丢失?

不同项目版本API数量不一致时,来回的版本切换时可能导致项目中的API门户内的应用授权丢失,操作前请注意备份,并谨慎使用。举例说明:项目中有三个版本:

  • 1.0版本包含API a、b、c;
  • 2.0版本包含API a、b、c、d;
  • 3.0版本包含API a、b、c、d、e;

如果再2.0升级为3.0的过程中误操作,点成了部署为1.0版本,则发布后API门户中关于API d的授权关系全部丢失,再次部署为2.0版本或者发布为3.0版本,API d的授权关系也不会恢复,需要进行手动重新授权;