检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查看实例约束信息 功能介绍 查看实例约束信息 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/instances/{
发布API 概述 在API创建后,您需要把API发布到环境,API只有在发布到环境后,才支持被其他用户调用。 已发布到环境的API,在修改配置信息后,需要重新发布才能将修改后的信息同步到环境中。 前提条件 系统已提供了默认发布环境RELEASE,如果您需要把API发布到其他环境,请提前创建发布环境
下线API 概述 已发布的API,如果需要暂停对外提供服务,可以将API从相关发布环境中下线。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成 APIC > API管理”,在“API列表”页签中单击
配置自定义认证 创建前端自定义认证 创建后端自定义认证 父主题: 服务集成指导(旧版界面)
发布函数API 在函数后端创建后,您需要发布函数后端,生成函数API并发布到环境上,才可供其他用户调用。 前提条件 每个API都要归属到某个API分组下,在发布函数API前您需要有可用的API分组,否则请提前创建API分组。 如果需要使用自定义认证方式进行API的安全认证,请提前创建前端自定义认证
定时调用API 通过在ROMA Connect中创建API定时任务,可以实现定时自动调用API的功能。 前提条件 添加到定时任务中的API必须已发布,否则请先发布API。 添加到定时任务中的API必须为“APP认证”或“无认证”的安全认证方式。 ROMA Connect的实例配置参数
附录:API错误码 用户调用API失败时,系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment
删除变量 功能介绍 删除指定的环境变量。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/{project_id}/apic/instances/
删除VPC通道 功能介绍 删除指定的VPC通道 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/{project_id}/apic/instances
删除域名证书 功能介绍 如果域名证书不再需要或者已过期,则可以删除证书内容。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/{project_id
插件绑定API 功能介绍 绑定插件到API上。 只能选择发布状态的API 绑定以后及时生效 修改插件后及时生效 相同类型的插件只能绑定一个,原来已经绑定的同类型插件,会直接覆盖。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成
新建变量 功能介绍 将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,服务集成会将这些变量替换成真实的变量值,以达到不同环境的区分效果
调试API 概述 在API创建后,您可以使用ROMA Connect提供的调试功能对API进行调试,确保API的功能正常。 前提条件 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义API后端服务时配置的“后端超时(ms)”与“重试次数
自定义后端管理 下线自定义后端 导入导出自定义后端 添加自定义后端公共配置 附录:自定义后端的Swagger扩展定义 父主题: 服务集成指导(旧版界面)
创建负载通道(可选) ROMA Connect通过创建负载通道,可访问指定服务器中已部署的后端服务,并实现后端服务访问的负载均衡功能。ROMA Connect的负载通道可直接访问同一VPC内的弹性云服务器(ECS),也可以通过IP访问其他VPC内的ECS和私有服务器。 例如,VPC
配置调用授权(可选) 使用APP认证方式的API,需要配置调用授权,把API授权给指定凭据。用户调用API时,使用凭据的Key和Secret进行安全认证。 API所属集成应用无需授权,可直接作为凭据用于API调用。 约束与限制 API的安全认证方式为“APP认证”。 前提条件 API
接入数据源 概述 在创建数据API之前,您需要先接入数据源,确保可以正常从数据源读取数据。根据数据源类型的不同,数据源的接入配置有所差异。 前提条件 在接入数据源前,请确保ROMA Connect实例与您的数据源所在网络互通。 若ROMA Connect实例与数据源在相同VPC内时
调用开放的API API在发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。 约束与限制 若您使用系统分配的默认子域名访问API,该子域名每天最多可以访问1000次。 如果两个API的所属分组、请求方法和请求路径都相同,则调用API时
解除授权 功能介绍 解除API对APP的授权关系。解除授权后,APP将不再能够调用该API。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/{project_id
使用插件 概述 ROMA Connect支持通过插件的方式,为API提供灵活的扩展能力。 前提条件 插件和API本身相互独立,只有为API绑定插件后,插件才对API生效。为API绑定插件时需指定发布环境,插件只对指定环境上的API生效。 同一个API在同一个环境中只能绑定一个相同类型的插件