检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了ROMA Connect如何去访问真实的后端服务。API的真实后端服务目前支持三种类型:传统的HTTP/HTTPS形式的web后端、函数工作流、MOCK。 URI POST
义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了ROMA Connect如何去访问真实的后端服务。API的真实后端服务目前支持的类型:传统的HTTP/HTTPS形式的web后端、函数工作流、MOCK。 调试 您可以在API
API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名每天最多可以访问1000次。对外开放API时,建议您为API分组绑定独立域名。支持通过“调试域名开关”来启用/禁用通过调试域名访问接口,调试域名禁用后将隐藏调试域名,显示为“--”。 Site实例不支持使用子域名
Connect实例的“消息集成 MQS内网连接地址”,您可以在ROMA Connect实例控制台的“实例信息”页面中查看得到。 Topic名称 选择1中创建的消息Topic。 用户名 仅当ROMA Connect实例的“MQS SASL_SSL”已开启时需要配置。 填写“Topic名称”中Topic所属集成应用的Key。
支持跨域(CORS) 是否支持跨域访问API。 浏览器出于安全性考虑,限制从页面脚本内发起的跨域请求,此时页面只能访问同源的资源。而CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。跨域访问API请参见配置跨域访问API。 父主题: 创建并开放函数API
指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。 返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 404 Not Found 所请求的资源不存在。
下线API 概述 已发布的API,如果需要暂停对外提供服务,可以将API从相关发布环境中下线。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成 APIC > API管理”,在“API列表”页签中单击API右侧的“更多
每个Topic都要归属到某个集成应用下,在创建Topic前您需要有可用的集成应用,否则请提前创建集成应用。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“消息集成 MQS > Topic管理”,单击页面右上角的“创建Topic”。
Pipeline连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”,在连接器页面单击“新建连接”。 选择“CodeArts Pipeline”连接器。 在弹窗中配置连接器信息,完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 描述 填写连接器的描述信息,用于识别不同的连接器。
支持跨域(CORS) 是否支持跨域访问API。 浏览器出于安全性考虑,限制从页面脚本内发起的跨域请求,此时页面只能访问同源的资源。而CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。跨域访问API请参见配置跨域访问API。 父主题: 创建并开放数据API
path:API请求的URI,已默认配置。 method:API请求方法,已默认配置。 header:API请求Header参数的第一个值。 说明: 建议不要设置敏感信息,防止泄露。 query:API请求Query参数的第一个值。 system:系统参数。 参数:用作规则匹配的参数名。 定义规则
9 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码:
Token 仅当“认证类型”选择“API Token”时需要配置。 用户需要在JIRA的个人设置中生成一个API Token,API Token是一种用于身份验证的令牌,它允许JIRA用户通过API访问其账户和相关数据。 描述 填写连接器的描述信息,用于识别不同的连接器。 支持的动作 监听自定义事件
已部署的自定义后端,如果需要暂停提供服务,可以下线自定义后端,下线时会同步下线和删除该自定义后端对应发布的API。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成 APIC > 自定义后端”,在“后端列表”页签中单击后端右侧的“下线”。
调试域名是否可以访问,true表示可以访问,false表示禁止访问 缺省值:true sl_domains Array of strings 系统默认分配的子域名列表 remark String 描述 call_limits Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置
网络配置 虚拟私有云 选择实例所关联的VPC和子网,VPC和子网须在准备资源中提前创建。 入公网访问 是否开启公网访问ROMA Connect,请根据您的业务需要选择。 入公网带宽 仅当“入公网访问”开启时需要配置。 选择需要开启的入公网带宽大小。 消息集成配置(仅当“RCU分配”中为消息集成分配了RCU时可配置)
说明 api-limit 是 Number API访问次数限制。 user-limit 否 Number 用户访问次数限制。 app-limit 否 Number 应用访问次数限制。 ip-limit 否 Number 源IP访问次数限制。 interval 是 Number 流控策略时间周期。
此场景下,对于数据根字段和解析路径有三种配置方案: 数据根字段不设置 元素c的解析路径需要设置为a.b.c,元素d的解析路径需设置为a.b.d。 数据根字段设置为a 元数据的解析路径从元素a的下层路径开始。元素c的解析路径需要设置为b.c,元素d的解析路径需设置为b.d。 数据根字段设置为a.b 元数据的解析路径从
定的命名规则填写插件名称,方便您快速识别和查找。 插件类型 选择插件的类型,不同类型的插件提供不同扩展能力。 跨域资源共享:为API的跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的能力。 Kafka日志推送:提供了把API的详细调用日志推送到Kafka的能力。
ftp_connect_mode 否 String 访问FTP服务的连接模式。 active (主动模式) passive (被动模式) 最小长度:4 最大长度:2147483647 ftp_protocol 否 String 访问FTP服务协议类型。 sftp ftp 最小长度:4