检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建并开放函数API 创建函数API 绑定域名 配置API授权(可选) 父主题: 服务集成指导(旧版界面)
查看API调用日志 概述 ROMA Connect提供了API的可视化分析和统计能力,支持查看API的调用日志。 Site实例中不支持API分析。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成
批量发布或下线API 功能介绍 将多个API发布到一个指定的环境,或将多个API从指定的环境下线。 注意:当action = online时,接口返回的响应中publish_id,version_id, publish_time字段才有含义。 调试 您可以在API Explore
根据版本编号下线API 功能介绍 对某个生效中的API版本进行下线操作,下线后,API在该版本生效的环境中将不再能够被调用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI
删除签名密钥 功能介绍 删除指定的签名密钥。签名密钥绑定了API时无法删除,需要先解除与API的绑定关系后删除。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE
修改签名密钥 功能介绍 修改指定签名密钥的详细信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/{project_id}/apic/instan
查询API下绑定的插件 功能介绍 查询指定API下绑定的插件信息 用于查询指定API下已经绑定的插件列表信息 支持分页返回 支持插件名称模糊查询 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
修改API分组 功能介绍 修改API分组属性。其中name和remark可修改,其他属性不可修改。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/{
配置跨域访问API 概述 出于安全性考虑,浏览器会限制从页面脚本内发起的跨域请求,此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 图1 跨域访问 浏览器将CORS请求分为两类:简单请求和非简单请求。 简单请求:同时满足以下2个条件的,即为简单请求。
附录: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。
删除Topic 功能介绍 删除Topic。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/{project_id}/mqs/instances
绑定流控策略 功能介绍 将流控策略应用于API,则所有对该API的访问将会受到该流控策略的限制。 当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后,后续的访问将会被拒绝,从而能够较好的保护后端API免受异常流量的冲击,保障服务的稳定运行。 为指定的API绑定流控策
查看实例约束信息 功能介绍 查看实例约束信息 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/instances/
添加后端实例 功能介绍 为指定的VPC通道添加后端实例 若指定地址的后端实例已存在,则更新对应后端实例信息。若请求体中包含多个重复地址的后端实例定义,则使用第一个定义。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SD
导入API 功能介绍 导入API。导入文件内容需要符合swagger标准规范,自定义扩展字段请参考用户指南的“附录:前端API的Swagger扩展定义”章节。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
发布API 概述 在API创建后,您需要把API发布到环境,API只有在发布到环境后,才支持被其他用户调用。 已发布到环境的API,在修改配置信息后,需要重新发布才能将修改后的信息同步到环境中。 前提条件 系统已提供了默认发布环境RELEASE,如果您需要把API发布到其他环境,请提前创建发布环境。
下线API 概述 已发布的API,如果需要暂停对外提供服务,可以将API从相关发布环境中下线。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成 APIC > API管理”,在“API列表”页签中单击API右侧的“更多
配置自定义认证 创建前端自定义认证 创建后端自定义认证 父主题: 服务集成指导(旧版界面)