检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
发布API 在API创建后,您需要把API发布到环境,API只有在发布到环境后,才支持被其他用户调用。 约束与限制 已发布到环境的API,在修改配置信息后,需要重新发布才能将修改后的信息同步到环境中。 如果API在选择的环境中已发布,再次发布将覆盖原来已发布的API。 前提条件
API概览 功能 API分类 说明 公共资源API 应用管理 集成应用相关API,包括集成应用的创建、修改、查询、删除等操作。 资产管理 资产相关API,包括资产的导入、导出、下载等操作。 字典管理 字典相关API,包括字典的创建、修改、查询、删除等操作。 公共管理 接口版本相关API,可查询接口版本的信息。
JedisConfig类说明 路径 com.roma.apic.livedata.config.v1.JedisConfig 说明 配合RedisClient使用,对Redis连接进行配置。 使用示例 importClass(com.roma.apic.livedata.client
附录:API的Swagger扩展定义 ROMA Connect在Swagger原有定义的基础上,定义了特有的API定义项,即扩展定义,如认证方式、后端服务定义等。本章节主要介绍API使用的扩展定义。 1:x-apigateway-auth-type 含义:基于Swagger的apiKey认证格式,定义ROMA
查看实例信息 概述 实例创建完成后,可在控制台查看和编辑实例的配置信息,主要包含基本信息、配置参数、数据字典、导入导出资产以及后台任务。 查看后台任务请参考查看后台任务,配置参数请参考修改实例配置参数,数据字典请参考创建数据字典,导入导出资产请参考导入导出资产。 操作步骤 登录新版ROMA
SoapConfig类说明 路径 com.roma.apic.livedata.config.v1.SoapConfig 说明 配合SoapClient使用,对SOAP请求进行配置。 构造器详情 public SoapConfig() 构造一个无参数的SoapConfig 方法列表
准备资源 在创建ROMA Connect实例前您需要提前准备相关依赖资源,包括VPC和子网。每个ROMA Connect实例都部署在某个虚拟私有云(VPC)中,并绑定具体的子网,通过这样的方式为ROMA Connect提供一个隔离的、用户自主配置和管理的虚拟网络环境。 准备依赖资源
查询指定任务的调度信息总览 功能介绍 查询指定任务的调度信息总览。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/fdi/
部署后端API 功能介绍 在某个实例中部署后端API。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}/apic/inst
接入API数据源 概述 ROMA Connect支持把API作为一个数据源,并用于数据集成任务。在使用API数据源前,您需要先接入数据源。 前提条件 每个接入的数据源都要归属到某个集成应用下,在接入数据源前您需要有可用的集成应用,否则请提前创建集成应用。 操作步骤 登录ROMA
SSL证书管理 概述 如果API分组中的API支持HTTPS请求协议,则在绑定独立域名后,还需为独立域名添加SSL证书。 前提条件 仅支持添加pem编码格式的SSL证书。 添加的SSL证书仅支持RSA、ECDSA和DSA加密算法。 创建SSL证书 登录ROMA Connect控制
Kafka日志推送插件说明 概述 ROMA Connect支持收集服务集成下已开放API的调用日志信息。Kafka日志推送插件提供了把API的详细调用日志推送到Kafka的能力,方便用户获取API的调用日志信息。 使用限制 同一个API在同一个环境中只能绑定一个相同类型的插件策略,已被API绑定的插件策略无法删除。
查询实例列表 功能介绍 获取符合条件的服务实例列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/instances 表1
查询字典列表 功能介绍 查询字典列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/instances/{instance_id}/dictionaries
发布或下线API 功能介绍 对API进行发布或下线。 发布操作是将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。 下线操作是将API从某个已发布的环境上下线,下线后,API将无法再被调用。 调试 您可以在API
根据版本编号下线API 功能介绍 对某个生效中的API版本进行下线操作,下线后,API在该版本生效的环境中将不再能够被调用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI
配置响应缓存策略 ROMA Connect支持通过配置响应缓存策略将后端服务(服务端)返回的应答缓存在APIC中,当客户端发送相同的请求时,APIC不用向后端传递请求,直接返回缓存的应答。有效降低后端的负荷,同时减少API调用的延迟。 当使用响应缓存策略时,后端的响应内容会缓存到
查询后端API详情 功能介绍 查询后端API的详细信息。 URI GET /v1/{project_id}/apic/instances/{instance_id}/livedata-apis/{ld_api_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
查询后端API详情 功能介绍 查询后端API的详细信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/inst
创建后端API 功能介绍 在某个实例中创建后端API。 URI POST /v1/{project_id}/apic/instances/{instance_id}/livedata-apis 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String