检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
添加API的SSL证书（可选） 配置API的调用域名 在开放API前，您需要为API分组绑定一个独立域名，供API调用者访问API使用。 在绑定独立域名前，您可以使用系统为API分配的调试域名进行API调试，每天最多可以访问调试域名1000次。 创建API的负载通道（可选） 通过创建负载通道，可访问指定服务器中已部署的后端服务。
在左侧导航栏选择“API管理 > 凭据管理”。 单击凭据名称，进入凭据详情页面。 在“AppCodes”区域，单击“添加AppCode”。 在弹窗中配置AppCode，完成后单击“确定”。 表1 配置AppCode 参数 说明 生成方式 选择AppCode的生成方式。 自动生成：由系统随机生成AppCode。
除操作。 创建响应缓存策略 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 在“策略管理”页面，单击“创建策略”。 在“选择策略类型”弹窗中，选择“插件策略 > 响应缓存”。 在“创建策略”弹窗中，配置策略信息。
创建Kafka日志推送策略 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 在“策略管理”页面，单击“创建策略”。 在“选择策略类型”弹窗中，选择“插件策略 > Kafka日志推送”。 在“创建策略”弹窗中，配置策略信息。
您需要创建更多实例，可提交工单，申请修改配额。 用户权限 如果您使用系统角色相关权限，需要同时拥有“APIG Administrator”和“VPC Administrator”权限才能创建实例。 如果您使用系统策略，则拥有“APIG FullAccess”即可。 如果使用自定义策略，请参考APIG自定义策略。
名称 创建虚拟私有云的同时创建一个默认子网。 表2 VPC网段规划 VPC1 APIG实例系统VPC VPC2 10.X 172.31.0.0/16 不能与VPC1和APIG实例系统VPC重复。 172.X 192.168.0.0/16 192.X 172.31.0.0/16
续费相关的功能 包年/包月实例续费相关的功能如表1所示。 表1 续费相关的功能 功能 说明 手动续费 包年/包月实例从购买到被自动删除之前，您可以随时在管理控制台为实例续费，以延长实例的使用时间。 自动续费 开通自动续费后，实例会在每次到期前自动续费，避免因忘记手动续费而导致资源被自动删除。
映射后端参数 如果认证通过，函数返回的context信息，可以传到后端，配置方式如下： 编辑API，在后端服务页面，添加系统参数，参数类型为前端认证参数，系统参数名称填自定义认证函数中context中的字段，后端参数名称和位置填需要传入到后端请求的参数名和位置。 编辑和发布完成之
参数位置：用于规则匹配的参数位置。 path：API请求的URI，系统默认配置。 method：API请求方法，系统默认配置。 Header：请求头的key值。 说明： 建议不要设置敏感信息，以防泄露。 Query：QueryString的key值。 System：系统参数。 参数：用于判断与规则匹配中的参数值是否匹配。
参数位置：用于规则匹配的参数位置。 path：API请求的URI，系统默认配置。 method：API请求方法，系统默认配置。 header：请求头的key值。 query：QueryString的key值。 system：系统参数。 参数：用于判断与规则中的参数值是否匹配。 定义规则 定义用于规则的判断条件。
准备一个已做ping/pong保活的WebSocket服务后端。 操作步骤 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”。 单击“创建API > 创建API”，配置前端信息。 表1 前端配置 参数 配置说明 API名称 填写API名称，建议
当客户端和服务端之间通信的合同。 创建API 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”。 单击“创建API > 创建GRPC API”。更多详细指导，请参见创建GRPC API。 配置前端信息后，单击“下一步”。
专享版-API分组管理 专享版-环境管理 专享版-环境变量管理 专享版-流控策略管理 专享版-API管理 专享版-签名密钥管理 专享版-签名密钥绑定关系管理 专享版-API绑定流控策略 专享版-设置特殊流控 专享版-APP授权管理 专享版-概要查询 专享版-域名管理 专享版-ACL策略管理
共享版API（仅存量用户使用） API分组管理 API管理 APP管理 APP授权管理 环境管理 环境变量管理 流控策略管理 API绑定流控策略 设置特殊流控 ACL策略管理 API绑定ACL策略 云商店订购信息查询 配置管理 概要查询 签名密钥管理 签名密钥绑定关系管理 域名管理 VPC通道管理 监控信息查询
可。 域名问题 域名是否备案成功，且能正常解析。 域名是否绑定到正确的API分组。 子域名（调试域名）访问超过默认次数。API分组创建后，系统为分组自动分配一个内部测试用的子域名，此子域名唯一且不可更改，每天最多可以访问1000次。您可以通过添加独立域名来访问您开放的API。 发布问题
专享版API（V1）（待下线） 使用限制 API分组管理（待下线） API管理（待下线） APP管理（待下线） APP授权管理（待下线） 环境管理（待下线） 环境变量管理（待下线） 流控策略管理（待下线） API绑定流控策略（待下线） 设置特殊流控（待下线） ACL策略管理（待下线） API绑定ACL策略（待下线）
和查询等接口。 APP管理 包括APP的创建、修改、删除、重置密钥和查询等接口。 APP授权管理 包括授权、解除授权、查询授权关系等接口。 环境管理 包括环境的创建、修改、删除和查询接口。 环境变量管理 包括环境变量的创建、删除和查询等接口。 流控策略管理 包括流控策略的创建、修改、删除和查询等接口。
并选择指定的自定义认证对象，如果没有，则需要创建自定义认证。 配置API后端 在API的后端设置页面添加策略后端，策略条件的条件来源选择“系统参数-前端认证参数”，并完善参数名称、条件类型、条件值等，其中参数名称和条件值要与前端自定义认证函数返回值中context字段下的键值对一致。
方案优势 帮助用户根据业务诉求进行灵活配置，无需修改原有业务网络架构，直接将请求转发到后端服务上。 约束与限制 VPC1、VPC2、APIG实例系统VPC网段不能重叠。关于APIG实例VPC网段规划，请参考表2。 父主题： 使用APIG专享版跨VPC开放后端服务
文档修订记录 发布日期 修订记录 2024-06-26 新增编排规则管理接口。 新增实例自定义入方向端口管理接口。 2024-01-19 新增查询实例支持的特性列表接口。 新增设置调试域名是否可以访问接口。 新增异步任务管理接口。 2023-09-12 增加修改变量接口。 增加校验API定义接口。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
