检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
APIG是否支持WebSocket数据传输? API网关支持WebSocket数据传输。 在创建API时,请求协议中的HTTP相当于WebSocket的ws,HTTPS相当于WebSocket的wss。 父主题: 调用API
安全配置。请参考5.b。 后端请求配置。请参考1。 单击“下一步”,支持通过“表单”、“JSON”、“YAML”样式查看配置详情。 确认无误后,单击“提交”,完成配置。 单击“立即导入”,在弹窗中选择是否现在发布API到环境。 如果选择“现在发布”,还需要选择API要发布的环境,将API分组下的所有API发布到环境上。
Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。 前提条件 导入API前,您需要在导入的API定义文件中补全Swagger扩展
实例支持的APIG特性 专享版实例支持的APIG特性。 若当前实例中无相关特性,可提交工单申请升级实例解决。 特性名称 特性描述 特性是否可配置 特性配置示例 特性配置参数 参数描述 参数默认值 参数范围 lts 是否支持shubao访问日志上报功能。 是 {"name":"lts"
本小节指导您顺利创建实例,实例创建完成后,才能创建API并对外提供服务。 约束与限制 实例配额 同一项目ID下,一个主账号默认只能创建5个实例。如果您需要创建更多实例,可提交工单,申请修改配额。 用户权限 如果您使用系统角色相关权限,需要同时拥有“APIG Administrator”和“VPC Administrator”权限才能创建实例。
后端服务部署在本地数据中心,且不能通过公网地址直接访问。 如果您使用专享版API网关,可为本地数据中心搭建一条与API网关(所绑定的华为云VPC)之间的专线。 本节针对后端服务部署在本地数据中心的场景,介绍使用API网关开放API的实践步骤。 方案架构 图1 使用云专线连通客户本地数据中心与华为云专享版API网关
导出API 操作场景 导出JSON或YAML格式的API。API网关支持单个API导出和批量API导出。 云商店购买的API不支持导出。 前提条件 已创建API分组和API。 操作步骤 进入共享版控制台。 单击“导出API”,进入“导出API”界面。 设置如表1所示参数。 图1 导出API
填写与SASL用户密码一样的值。 证书内容 仅当“安全协议”选择“SASL_SSL”时需配置。 SSL认证所使用的CA证书内容。 元数据配置信息 系统元数据 推送的日志中,需要携带的系统字段信息。 其中,start_time、request_id、client_ip、request_
导出APIG的API APIG支持把创建的API以JSON、YAML、YML文件的格式导出,支持导出单个API和批量导出API。 导出API 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。单击分组名称然后单击“导出”。
服务器返回服务器的时间的上一分钟到往前推N分钟的数据; 查询范围一天以内,返回一小时一个样本,其样本值为一小时内的累计值,服务器会返回最近时长横跨统计周期的数据,比如时长为大于2小时,且小于3小时,那么会查询最近3个小时的数据; 查询超过一天以上,返回一天为一个样本,其样本值为
为API的访问进行认证。API网关先调用用户的鉴权服务,收到鉴权服务的鉴权成功响应后再继续调用后端服务。 如果此策略在当前实例中不支持,可提交工单升级实例到最新版本。 策略参数会明文展示,为防止信息泄露,请谨慎配置。 第三方认证原理图如下,第三方认证策略绑定API后,您可以参考调用APIG开放的API调用。
查看某个API的调用统计,包括“请求次数”、“调用延时”、“数据流量”和“出错统计”,同时可以选择要查看数据的时间段范围。 近1小时数据每2分钟刷新一次。 近6小时数据每2小时刷新一次。 近一天数据每2小时刷新一次。 近一周和近一月数据每天刷新一次。 如果需要查看实例、实例节点的监控信息
低后端的负荷,同时减少API调用的延迟。 当使用响应缓存策略时,后端的响应内容会缓存到API网关中,此时API网关不支持缓存数据加密,对于响应中的敏感数据存在安全风险,请谨慎配置策略。 策略参数会明文展示,为防止信息泄露,请谨慎配置。 响应缓存策略原理图如下: 约束与限制 同一个
backend_api 字典数据类型 后端服务:web后端详情 mock_info 字典数据类型 后端服务:MOCK详情 func_info 字典数据类型 后端服务:函数工作流后端详情 req_params 字典数据类型 API的请求参数列表 backend_params 字典数据类型 API的后端参数列表
配置APIG实例标签 通过标签功能对实例资源进行标记,批量分类实例资源,实现对实例资源进行分组查询、分析及管理。 用户可在标签管理服务(Tag Management Service,简称TMS)中过滤查询资源、分析资源及管理资源。 配置实例标签 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。
API调用方返回固定错误或者将请求转发到指定的降级后端。当后端服务恢复正常后,断路器关闭,请求恢复正常。 如果此策略在当前实例中不支持,可提交工单升级实例到最新版本。 策略参数会明文展示,为防止信息泄露,请谨慎配置。 约束与限制 同一个环境中,一个API只能被一个断路器策略绑定,但一个断路器策略可以绑定多个API。
响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 请求示例 批量导出API { "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "group_id" :
单击API分组名称,进入API分组详情页面。 单个下线API。在左侧选择API,然后在右上角单击“下线”,弹出“下线API”对话框。 批量下线API,最多同时下线1000个API。单击“批量操作”,选择API,然后单击下线按钮,弹出“下线API”对话框。 选择API需要下线的环境,单击“确定”,完成API下线。
查看API的各项监控指标。 单击“查看更多监控”,进入云监控界面,查看更多监控数据。 监控数据保留周期为两天,如果需要长时间保留,需要配置OBS桶,将监控数据保存至OBS桶中,具体步骤请参见配置OBS数据存储。 父主题: 监控
单击待删除的访问控制策略名称,进入访问控制详情页面,在右上角单击“删除”。 仅在访问控制策略未绑定任何API时,支持删除,否则请先解绑API。 如果需要批量删除访问控制策略,则勾选待删除的访问控制策略,单击“删除”。最多同时删除1000个访问控制策略。 单击“确定”,完成访问控制策略的删除。 父主题: