检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开放API流程 企业或开发者通过API网关开放自身的服务与数据，实现业务能力变现。 创建API分组 每个API都归属到某一个API分组下，在创建API前应提前创建API分组。 添加API的SSL证书（可选） 配置API的调用域名 在开放API前，您需要为API分组绑定一个独立域名，
配置API的响应缓存 您可以通过配置响应缓存策略将后端服务（服务端）返回的应答缓存在API网关中，当客户端发送相同的请求时，网关不用向后端传递请求，直接返回缓存的应答。有效降低后端的负荷，同时减少API调用的延迟。 当使用响应缓存策略时，后端的响应内容会缓存到API网关中，此时API
配置API的Kafka日志推送 支持收集已开放API的调用日志信息。Kafka日志推送策略提供了把API的详细调用日志推送到Kafka的能力，方便用户获取API的调用日志信息。 如果此策略在当前实例中不支持，请联系技术支持升级实例到最新版本。 策略参数会明文展示，为防止信息泄露，请谨慎配置
实施步骤 创建VPC 登录网络控制台。 在左侧导航栏选择“虚拟私有云 > 我的VPC”。 在“虚拟私有云”页面，单击“创建虚拟私有云”，请参考表1和表2配置信息。具体操作请参考《虚拟私有云服务用户指南》中的“创建虚拟私有云和子网”章节。 表1 配置信息 参数 配置说明 区域 选择所在的区域
创建APIG实例 本小节指导您顺利创建实例，实例创建完成后，才能创建API并对外提供服务。 约束说明 创建实例存在一些约束，当您登录后无法创建实例，或者创建失败，请参考以下约束说明进行检查，并解除限制。 实例配额 同一项目ID下，一个主账号默认只能创建5个实例。如果您需要创建更多实例
续费概述 包年/包月实例到期后会影响实例正常运行。如果您想继续使用，需要在指定的时间内为实例续费，否则实例资源会自动释放，数据丢失且不可恢复。 续费操作仅适用于包年/包月实例，按需计费实例不需要续费，只需要保证账户余额充足即可。 包年/包月实例在到期前续费成功，所有资源得以保留，且实例的运行不受影响
使用FunctionGraph服务实现APIG的自定义认证 简介 本手册基于华为云API网关实践所编写，用于指导如何为API添加自定义认证。 在API的安全认证方面，API网关提供IAM认证、APP认证等方式，帮助用户快速开放API，同时API网关也支持用户使用自己的认证方式（以下简称自定义认证
配置API的流量控制2.0 流量控制2.0策略可以限制单位时间内API的被调用次数，支持参数流控、基础流控和基于基础流控的特殊流控。 基础流控 可以对API、用户、凭据、源IP进行多维度流控，与已有的配置API的流量控制功能一致但不兼容。 参数流控 支持根据Header、Path、
配置API的第三方认证 您可以通过第三方认证策略配置自己的鉴权服务为API的访问进行认证。API网关先调用用户的鉴权服务，收到鉴权服务的鉴权成功响应后再继续调用后端服务。 如果此策略在当前实例中不支持，请联系技术支持升级实例到最新版本。 策略参数会明文展示，为防止信息泄露，请谨慎配置
使用APIG专享版实现WebSocket服务的转发 应用场景 API网关支持WebSocket API，其创建过程和创建HTTP API一致。WebSocket是一种全双工通信协议，建立在单个TCP连接上，允许在客户端和服务器之间进行双向通信。WebSocket的设计旨在解决HTTP
实施步骤 前提条件 客户端与服务端均为gRPC类型。 服务端已定义proto文件，即在proto文件中定义API的Request和Response。proto文件是用于定义数据结构和服务接口的文件，通常在gRPC中使用。它基于Protobuf语言，用于描述数据的结构和交互方式，充当客户端和服务端之间通信的合同
调用API失败的可能原因 网络问题 调用API失败的场景分为三种：同一VPC内调用失败、不同VPC之间调用失败、公网调用失败。 VPC内调用API失败时，请检查域名是否和API自动分配的域名一致，如果域名错误，会导致调用API失败。 不同VPC之间调用API失败时，请检查两个VPC
专享版API（V2） 专享版-API分组管理 专享版-环境管理 专享版-环境变量管理 专享版-流控策略管理 专享版-API管理 专享版-签名密钥管理 专享版-签名密钥绑定关系管理 专享版-API绑定流控策略 专享版-设置特殊流控 专享版-APP授权管理 专享版-概要查询 专享版-域名管理
操作流程 配置API前端 在API的前端设置页面选择安全认证方式为“自定义认证”或使用双重认证（APP认证或IAM认证），并选择指定的自定义认证对象，如果没有，则需要创建自定义认证。 配置API后端 在API的后端设置页面添加策略后端，策略条件的条件来源选择“系统参数-前端认证参数
共享版API（仅存量用户使用） API分组管理 API管理 APP管理 APP授权管理 环境管理 环境变量管理 流控策略管理 API绑定流控策略 设置特殊流控 ACL策略管理 API绑定ACL策略 云商店订购信息查询 配置管理 概要查询 签名密钥管理 签名密钥绑定关系管理 域名管理
方案概述 应用场景 当用户后端服务器所在的VPC与创建实例所选择的VPC处于不同的场景时，该如何完成服务配置，以实现跨VPC对接？本文以Elastic Load Balance（弹性负载均衡ELB）为例，讲述如何在API网关上开放内网ELB中的服务。 方案架构 图1 API网关跨VPC
专享版API（V1）（待下线） 使用限制 API分组管理（待下线） API管理（待下线） APP管理（待下线） APP授权管理（待下线） 环境管理（待下线） 环境变量管理（待下线） 流控策略管理（待下线） API绑定流控策略（待下线） 设置特殊流控（待下线） ACL策略管理（待下线
API概览 API网关专享版接口的分类与说明如表1所示，API网关共享版接口的分类与说明如表2所示。 表1 专享版API概览 类型 说明 API分组管理 包括API分组的创建、修改、删除、查询详情和列表等接口。 环境管理 包括环境的创建、修改、删除和查询列表等接口。 环境变量管理
调用API 调用API失败的可能原因 调用API报“414 Request URI too large” 调用API报“The API does not exist or has not been published in the environment” 调用API报“No backend
修订记录 表1 文档修订记录 发布日期 修订记录 2024-06-26 新增编排规则管理接口。 新增实例自定义入方向端口管理接口。 2024-01-19 新增查询实例支持的特性列表接口。 新增设置调试域名是否可以访问接口。 新增异步任务管理接口。 2023-09-12 增加修改变量接口
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
