检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
ID列表 env_id 是 String 环境ID remark 否 String 对本次发布的描述信息 字符长度不超过255 说明: 中文字符必须为UTF-8或者unicode编码。 请求消息样例: { "apis": ["81efcfd94b8747a0b21e8c04144a4e8c"
com/v2/{project_id}/apigw/instances/{instance_id}/api-groups 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 如下公共消息头需要添加到请求中。 Con
基础定义:包括API前端请求定义和响应定义,不包括后端服务定义。其中API前端请求定义除了Swagger规范定义项外,还包括API网关的一些Swagger扩展字段。 全量定义:包括API前端请求定义、后端服务定义和响应定义。 扩展定义:包括API前端请求定义、后端服务定义和响应定义,还包括AP
String API的编号,即:需要进行发布或下线的API的编号 remark 否 String 对发布动作的简述。字符长度不超过255 说明: 中文字符必须为UTF-8或者unicode编码。 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 publish_id
服务端已定义proto文件,即在proto文件中定义API的Request和Response。proto文件是用于定义数据结构和服务接口的文件,通常在gRPC中使用。它基于Protobuf语言,用于描述数据的结构和交互方式,充当客户端和服务端之间通信的合同。 创建API 登录API网关控制台页面。
参数位置为HEADER时,参数名不区分大小写,也不支持下划线。 如上图,test01和test03在调用API时分别配置于PATH和QUERY位置,后端服务通过映射,将在HEADER位置接收test01和test03的值。test02在调用API时配置于HEADER位置,后端服务通过
API网关支持WebSocket API,其创建过程和创建HTTP API一致。WebSocket是一种全双工通信协议,建立在单个TCP连接上,允许在客户端和服务器之间进行双向通信。WebSocket的设计旨在解决HTTP协议在实时性和交互性方面的不足。它广泛应用于实时聊天、在线游戏、金融行业的实时数据更新等场景。
创建策略并绑定API 通过策略的方式,为API提供灵活的控制策略和扩展能力。 策略参数会明文展示,为防止信息泄露,请谨慎配置。 前提条件 一个API只能绑定一个相同类型的策略。 策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。
管理终端节点 终端节点用于在VPC和终端节点服务之间建立便捷、安全、私密的连接通道。 在同一区域中,可实现云内跨VPC访问/开放API。 目前除墨西哥城一、北京一区域外,其他区域都支持终端节点管理功能。 图1 同一区域跨VPC访问 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。
是否为默认响应 表5 ResponseInfoHeader 参数 参数类型 描述 key String 分组自定义响应的响应头的key,支持英文字母、数字和中划线,长度为1到128位 value String 分组自定义响应的响应头的value,为长度为1到1024位的字符串 最小长度:1
API分组ID。必须指定apis或group_id。 remark 否 String 对本次发布的描述信息 字符长度不超过255 说明: 中文字符必须为UTF-8或者unicode编码。 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 success Array
填写弹性负载均衡的名称,根据规划自定义。建议您按照一定的命名规则填写实例名称,方便您快速识别和查找。 企业项目 选择实例所属的企业项目,此处默认选择“default”。 规格 此处规格类型默认选择“固定规格”,规格默认选择“应用型”和“网络型”。 网络类型 此处默认选择“IPv4私网”。 所属VPC 所
APIG使用流程 API网关(API Gateway)是为您提供高性能、高可用、高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关的开放API和调用API功能,可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放。 开放API 企业或开发者通过API网关开放自身的服务与数据。
通过以下两种方式,添加特殊应用。 图1 选择应用 添加已有应用:单击“已有应用”,选择已有应用,输入阈值。 添加其他应用:单击“其他”,输入其他用户的应用ID和阈值。 特殊应用流控值和应用流量限制值共同作用时,以特殊应用流控值为准。 例如:API流量限制值为10,应用流量限制值为3,时长为1分钟,特殊应用(应用
Gateway)是为您提供高性能、高可用、高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。 API网关支持专享版和共享版(存量用户)功能。专享版功能操作指导请参考API管理~云审计服务
text字段,字段中包含键值对。其中键值对的值只支持字符串、布尔、整型三种数值类型,键值对对应“系统参数-前端认证参数”策略条件的参数名称和条件值。 图1 自定义认证函数 已创建前端自定义认证。如果未创建,请参考自定义认证章节创建。 配置API前端 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。
云审计服务 CTS的详细介绍和开通配置方法,请参见CTS快速入门。 APIG用户查看云审计日志方法,请参见云审计日志。 日志 APIG支持日志自定义分析模板,便于日志的统一收集和管理,也可通过API异常调用分析进行追查和溯源。 关于APIG日志记录的详细介绍和配置方法,请参见日志分析。
布历史(如版本、发布说明、发布时间和发布环境),并支持回滚到不同的API历史版本。 已发布的API,在修改信息后,需要重新发布才能将修改后的信息同步到环境中。 同一个API在每个环境中最多记录10条最新的发布历史。 前提条件 已创建API分组和分组内的API。 已创建环境。 发布API
直接使用已创建的负载通道。 例如,负载中包含6台ECS,已创建一条负载通道,其中ECS 01和ECS 04已添加到负载通道中,此时API网关通过负载通道可以直接访问负载中的ECS 01和ECS 04。 图1 通过API网关访问负载通道中的ECS 前提条件 用户需要具备VPC Administrator角色权限。
查看某个API的调用统计,包括“请求次数”、“调用延时”、“数据流量”和“出错统计”,同时可以选择要查看数据的时间段范围。 近1小时数据每2分钟刷新一次。 近6小时数据每2小时刷新一次。 近一天数据每2小时刷新一次。 近一周和近一月数据每天刷新一次。 如果需要查看实例、实例节点的监控信息