检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
单击“下载”,可把导入的文件内容下载到本地。 是否启用Mock后端,表示是否使用Mock服务作为导入API的后端服务。 单击“立即导入”。 如果您需要在导入前,对导入API的请求信息、后端服务信息进行统一配置,您可以单击“全局配置(可选)”,并根据页面向导配置API的信息。完成后单击“提交”,导入API。
默认部署在VPC下的应用可以调用API。如果域名解析失败,则参考怎样切换内网DNS,在当前终端节点上配置DNS服务器。配置完成后,部署在VPC下的应用可以调用API。 父主题: 服务集成
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型
控制策略管理 配置流量控制策略 配置访问控制策略 配置客户端配额策略 配置客户端访问控制策略 父主题: 服务集成指导(旧版界面)
到Kafka的能力。 HTTP响应头管理:提供了自定义HTTP响应头的能力,并在API响应中返回自定义的响应头。 断路器:在后端服务出现性能问题时为系统提供保护的能力。 可见范围 选择插件的可见范围。 集成应用:插件归属某个集成应用,仅拥有该集成应用权限的用户可查看和使用该插件。
和“HTTP&HTTPS”,传输重要或敏感数据时推荐使用HTTPS。 后端超时 (ms) 后端服务请求的超时时间,默认为60000ms。 重试次数 ROMA Connect调用后端服务失败后的重试次数。 值为-1时,表示不开启重试功能,但除POST和PATCH外的其他请求类型会默认重试1次。
选择要授权的API发布环境。 授权凭据 勾选要授予权限的凭据。 访问参数 为授权的凭据设置访问参数。访问参数会被添加到后端签名认证信息中,并发送给后端服务,后端服务根据携带的访问参数返回不同的响应参数。 绿色通道 开启绿色通道后,白名单地址中的客户端无需认证即可调用API。 白名单 仅当“绿色通道”开启时需要配置。
对于非简单请求,在正式通信之前,浏览器会增加一次HTTP查询请求,称为预检请求。浏览器查询服务器,当前页面所在的源是否在服务器的许可名单之中,以及可以使用哪些HTTP请求方法和头信息字段。预检通过后,浏览器向服务器发送简单请求。 ROMA Connect默认不支持跨域访问,如果您需要支持跨域
配置自定义认证 创建前端自定义认证 创建后端自定义认证 父主题: 服务集成指导
X-Apig-Upstream-Latency 从APIC请求后端到后端返回消息头的用时 仅在请求消息头包含X-Apig-Mode: debug,且后端服务类型不为Mock时,返回此参数 X-Apig-RateLimit-api API流量控制信息 示例:remain:9,limit:10,time:10
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 min_ssl_version
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 env_id
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name
将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,服务集成会将这些变量替换成真实的变量值,以达到不同环境的区分效果。 环境变量定义
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 401 表3 响应Body参数 参数 参数类型
开发场景 场景说明 ROMA Connect的服务集成主要涉及以下几个开发场景: API调用认证开发:业务系统在调用服务集成APIC开放的API时,若API的认证方式为APP认证或IAM认证,则需要在业务系统侧进行调用认证的开发,为API请求添加认证信息。 APP认证(签名认证):调用侧集成ROMA
Connect提供的调试功能对API进行调试,确保API的功能正常。 前提条件 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义API后端服务时配置的“后端超时(ms)”与“重试次数”相乘的值大于30秒,则调试API会超时。 操作步骤
填写负载通道的服务器访问端口号。 分发算法 选择后端服务请求的分发算法,负载通道通过分发算法确定请求被发送到哪台服务器上。 配置通道内服务器。 选择“服务器添加方式”,服务器添加方式在负载通道创建后将不能修改。 选择云服务器:通过选择云服务器的方式添加负载通道服务器。Site实例中,不支持“选择云服务器”方式。
选择要授权的API发布环境。 授权凭据 勾选要授予权限的凭据。 访问参数 为授权的凭据设置访问参数。访问参数会被添加到后端签名认证信息中,并发送给后端服务,后端服务根据携带的访问参数返回不同的响应参数。 绿色通道 开启绿色通道后,白名单地址中的客户端无需认证即可调用API。 白名单 仅当“绿色通道”开启时需要配置。