检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
控制策略管理 配置流量控制策略 配置访问控制策略 配置客户端配额策略 配置客户端访问控制策略 父主题: 服务集成指导(旧版界面)
已被API绑定的插件无法删除。 创建插件 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成 APIC > API管理”,在“插件”页签下单击“创建插件”。 在创建插件弹窗中配置插件信息。 表1 插件配置 参数 配置说明 插件名称
和“HTTP&HTTPS”,传输重要或敏感数据时推荐使用HTTPS。 后端超时 (ms) 后端服务请求的超时时间,默认为60000ms。 重试次数 ROMA Connect调用后端服务失败后的重试次数。 值为-1时,表示不开启重试功能,但除POST和PATCH外的其他请求类型会默认重试1次。
选择要授权的API发布环境。 授权凭据 勾选要授予权限的凭据。 访问参数 为授权的凭据设置访问参数。访问参数会被添加到后端签名认证信息中,并发送给后端服务,后端服务根据携带的访问参数返回不同的响应参数。 绿色通道 开启绿色通道后,白名单地址中的客户端无需认证即可调用API。 白名单 仅当“绿色通道”开启时需要配置。
对于非简单请求,在正式通信之前,浏览器会增加一次HTTP查询请求,称为预检请求。浏览器查询服务器,当前页面所在的源是否在服务器的许可名单之中,以及可以使用哪些HTTP请求方法和头信息字段。预检通过后,浏览器向服务器发送简单请求。 ROMA Connect默认不支持跨域访问,如果您需要支持跨域
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型
最大长度:32 instance_id 是 String 实例ID。 最小长度:0 最大长度:36 service_id 是 String 服务ID。 最小长度:0 最大长度:20 command_id 是 Integer 命令ID。 最小值:0 最大值:99999999999999999
配置自定义认证 创建前端自定义认证 创建后端自定义认证 父主题: 服务集成指导
X-Apig-Upstream-Latency 从APIC请求后端到后端返回消息头的用时 仅在请求消息头包含X-Apig-Mode: debug,且后端服务类型不为Mock时,返回此参数 X-Apig-RateLimit-api API流量控制信息 示例:remain:9,limit:10,time:10
最大长度:32 instance_id 是 String 实例ID。 最小长度:0 最大长度:36 service_id 是 String 服务ID。 最小长度:0 最大长度:20 command_id 是 Integer 命令ID。 最小值:0 最大值:99999999999999999
APIC如何对流量进行控制? 您可以通过流控策略控制单位时间内API被访问的次数,保护后端服务,详情请参考流量控制。 默认的流控策略是单个API的访问不超过6000次/秒,如果您未创建流控策略,APIC会执行默认流控策略。您可以在ROMA Connect实例控制台“实例信息”页面
请求参数 表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参数 参数 参数类型
Integer 服务集成请求后端服务的超时时间。最大超时时间可通过实例特性backend_timeout配置修改,可修改的上限为600000 单位:毫秒。 最小值:1 enable_client_ssl Boolean 是否开启双向认证 retry_count String 服务集成请求
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 service_id Integer 命令所属服务ID。 最小值:0
Integer 服务集成请求后端服务的超时时间。最大超时时间可通过实例特性backend_timeout配置修改,可修改的上限为600000 单位:毫秒。 最小值:1 enable_client_ssl Boolean 是否开启双向认证 retry_count String 服务集成请求