检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
否 String 健康检查时的目标路径。protocol = http或https时必选 method 否 String 健康检查时的请求方法 缺省值:GET port 否 Integer 健康检查的目标端口,缺少或port = 0时为VPC中主机的端口号。 如果此端口存在非0值,则使用此端口进行健康检查。
String 指定已有的分组,为空时创建新的分组 最小长度:0 最大长度:64 group_name 否 String API分组的名称,group_id为空时必填。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、汉字和数字开头,3-255个字符。
选择当前引擎下的微服务或新建微服务。微服务是业务概念,即提供某种服务的某个进程。 微服务版本 选择当前微服务的版本号。微服务版本用来标记微服务的迭代记录,方便对微服务的不同迭代进行管理。 服务契约 选择当前微服务的服务契约。它是基于OpenAPI规范的微服务接口约束规范,是服务端和消费端对于接口的定义。
VPC通道的编号 name 否 String VPC通道的名称 dict_code 否 String VPC通道的字典编码 支持英文,数字,特殊字符(-_.) 暂不支持 最小长度:3 最大长度:64 precise_search 否 String 指定需要精确匹配查找的参数名称,
文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、汉字或数字开头,长度为3~255个字符。 描述 对分组的介绍。长度为0~1000个字符。 单击“确定”,创建完成。 后续操作 API分组创建成功后,您可以为此分组绑定域名,API调用者通过访问独立域名来调用您开放的API。 父主题:
开放API 开放API流程 创建API分组 添加API的SSL证书 配置API的调用域名 创建API的负载通道(可选) 创建API 调试APIG创建的API 配置API的发布环境和环境变量(可选) 发布APIG创建的API
path String 健康检查时的目标路径。protocol = http或https时必选 method String 健康检查时的请求方法 缺省值:GET port Integer 健康检查的目标端口,缺少或port = 0时为VPC中主机的端口号。 如果此端口存在非0值,则使用此端口进行健康检查。
查看关键操作列表 通过云审计服务,您可以记录与API网关相关的操作事件,便于日后的查询、审计和回溯。 表1 云审计服务支持的API Gateway操作列表 操作名称 资源类型 事件名称 创建API分组 ApiGroup createApiGroup 删除API分组 ApiGroup
将此服务的访问方式设置为VPC内网访问,在API网关中创建API时,通过VPC通道访问部署在VPC内的此服务。创建VPC通道和API的详细步骤请参见创建负载通道和创建API。 父主题: 开放API
调试APIG创建的API 通过APIG提供的在线调试功能验证API服务是否正常可用。 配置API的发布环境和环境变量(可选) API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是系统默认的发布环境,如果使用RELEASE环境,可跳过配置发布环境步骤。 如果API的后端服
选择API的发布环境,并填写发布说明。 单击“确定”,API发布成功后,发布按钮左上角的红色感叹号消失。 验证 使用接口测试工具调用已创建的API,或者在客户端调用已创建的API。 填写API所属分组的调试域名。 导入服务端的proto文件。 此处的proto文件如下: syntax = "proto3"; package
PI网关的一些Swagger扩展字段。 全量定义:包括API前端请求定义、后端服务定义和响应定义。 扩展定义:包括API前端请求定义、后端服务定义和响应定义,还包括API关联的流量控制、访问控制等策略对象的定义。 导出格式 选择JSON或YAML。 自定义版本 为导出的API自定
是否支持移动应用调用API? API支持被移动应用调用。 使用APP认证时,将移动应用的AppKey和AppSecrect替换SDK中的AppKey和AppSecrect进行APP签名。 父主题: 调用API
项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 vpc_channel_id 是 String VPC通道的编号 member_group_id 是 String VPC通道后端服务器组编号 请求参数 表2
获取账号名和账号名ID 在调用接口的时候,部分URL中需要填入账号名和账号ID,所以需要先在管理控制台上获取到账号名和账号ID。账号名和账号ID获取步骤如下: 登录管理控制台。 将鼠标移至用户名,在下拉列表中单击“我的凭证”。 查看账号名和账号ID。 父主题: 附录
使用APIG专享版实现WebSocket服务的转发 应用场景 API网关支持WebSocket API,其创建过程和创建HTTP API一致。WebSocket是一种全双工通信协议,建立在单个TCP连接上,允许在客户端和服务器之间进行双向通信。WebSocket的设计旨在解决HTTP协议在实时性和交互性方面的不
随着用户多样性以及需求多样性的增加,传统流控策略无法满足更加精细的流量控制场景。比如针对某一请求参数的流控或者某一租户的流控,APIG在传统流量控制策略的基础上提供了插件策略(流量控制2.0),通过制定更加精细的方案来进行流控。 使用APIG的APP认证和自定义认证实现API的双重认证 在AP
导入导出API的限制与兼容性说明 在API网关中导入或者导出API时,限制与兼容性如下所示: 约束与限制 API网关参数限制,如下所示。 API网关暂不支持formData和body位置的请求参数定义。 API网关暂不支持consumes和produces定义。 API网关中,h
导入导出API 导入导出API的限制与兼容性说明 通过API设计文件导入API 通过CSE微服务导入API 通过CCE工作负载导入API 导出APIG的API 父主题: 管理API
使用APIG专享版开放本地数据中心的服务能力 使用APIG专享版跨VPC开放后端服务 使用APIG专享版实现gRPC服务的路由转发 使用APIG专享版实现WebSocket服务的转发 使用APIG专享版实现http到https自动重定向 使用APIG专享版实现不同后端服务的调用