检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
绑定域名 概述 在开放API前,您需要为API分组绑定独立域名,用户通过独立域名访问分组内的API。 独立域名可分为内网域名和公网域名两种: 内网域名:部署在云服务平台内的业务系统,可以使用内网域名访问API。 公网域名:部署在云服务平台外的业务系统,可以使用公网域名访问API。
C对等连接,将两个VPC的网络打通,实现同一区域跨VPC访问API。具体步骤请参考VPC对等连接说明。 若业务系统与ROMA Connect实例在不同区域的不同VPC内时,可通过创建云连接实例并加载需要互通的VPC,将两个VPC的网络打通,实现跨区域跨VPC访问API。具体步骤请参考跨区域VPC互通。
创建并开放函数API 创建函数API 绑定域名 配置API授权(可选) 父主题: 服务集成指导(旧版界面)
创建并开放数据API 接入数据源 创建数据API 绑定域名 配置API授权(可选) 父主题: 服务集成指导(旧版界面)
C对等连接,将两个VPC的网络打通,实现同一区域跨VPC访问数据源。具体步骤请参考VPC对等连接说明。 若ROMA Connect实例与数据源在不同区域的不同VPC内时,可通过创建云连接实例并加载需要互通的VPC,将两个VPC的网络打通,实现跨区域跨VPC访问数据源。具体步骤请参考跨区域VPC互通。
数。 名称:请求参数的名称,自定义。 参数位置:请求参数在后端服务请求中的位置,可选择“Headers”和“Parameters”。 测试界面默认值:仅用于后续的自定义后端测试步骤,作为参数的默认测试值。在自定义后端部署时不生效。 必填:在后端服务请求中,请求参数是否必填。 描述:填写参数的描述信息。
如果没有可选的日志流,单击“查看日志流”,跳转到云日志服务管理控制台,并创建一个日志流,具体操作请参考创建日志流。 日志分析开启后,可以在界面上实时查看所有开放API的调用日志,日志字段说明请参见日志字段说明。 在界面右上角,可选择要查看的日志时间段范围。 单击“查看详细日志”,可前往云日志服务控制台查看日志的详细信息和下载日志到本地。
调试API 概述 在API创建后,您可以使用ROMA Connect提供的调试功能对API进行调试,确保API的功能正常。 前提条件 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义API后端服务时配置的“后端超时(ms)”与“
下线API 概述 已发布的API,如果需要暂停对外提供服务,可以将API从相关发布环境中下线。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成 APIC > API管理”,在“API列表”页签中单击API右侧的“更多
自定义版本 填写导出的API定义文件版本号,如果没有指定版本号,默认使用当前时间作为版本号。 单击“导出”,导出API定义文件到本地,界面右侧显示导出的文件内容结果。 若导出API所在的API分组未绑定独立域名,则导出API分组的子域名。 若导出API所在的API分组绑定了多
创建后端自定义认证 概述 如果您需要把自己的认证系统用于后端服务请求的认证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指ROMA Connect使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数,对来自ROMA
创建前端自定义认证 概述 如果您需要把自己的认证系统用于API调用的认证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指ROMA Connect使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数,对来自ROMA
I。 单击“绑定”,完成API与流控策略的绑定。 为应用绑定流控策略 如果希望对某个集成应用进行流量控制,可以通过在流控策略中添加特殊应用实现。把集成应用添加到流控策略中后,该集成应用的应用流量限制受特殊应用的阈值限制,API流量限制和用户流量限制受流控策略限制。 登录ROMA
创建API分组 概述 API分组是同一类业务API的集合,API开发者以API分组为单位,管理分组内的所有API。每个API都要归属到某个API分组下,在创建API前应提前创建API分组。 前提条件 每个API分组都要归属到某个集成应用下,在创建API分组前您需要有可用的集成应用,否则请提前创建集成应用。
配置API授权(可选) 概述 仅使用APP认证方式的API,才需要配置调用授权,把API授权给指定集成应用。用户调用API时,使用集成应用的Key和Secret进行API请求的安全认证。 若API开启了简易认证,可直接使用集成应用中配置的AppCode进行简易安全认证,无需使用Key和Secret进行签名认证。
查看API调用统计 概述 ROMA Connect提供了API的可视化分析和统计能力,支持查看API的调用统计。 Site实例中不支持API分析。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成
为API绑定签名密钥后,您可以参考后端服务签名校验开发,在后端服务进行签名校验开发,对请求中的签名信息进行校验。 父主题: 服务集成指导(旧版界面)
附录:API错误码 用户调用API失败时,系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment
断路器插件说明 概述 断路器是ROMA Connect在后端服务出现性能问题时保护系统的内置机制。当API的后端服务出现连续N次超时或者时延较高的情况下,会触发断路器的降级机制,向API调用方返回固定错误或者将请求转发到指定的降级后端。当后端服务恢复正常后,断路器关闭,请求恢复正常。
绑定域名 概述 在开放API前,您需要为API分组绑定独立域名,用户通过独立域名访问分组内的API。 独立域名可分为内网域名和公网域名两种: 内网域名:部署在云服务平台内的业务系统,可以使用内网域名访问API。 公网域名:部署在云服务平台外的业务系统,可以使用公网域名访问API。