检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用函数服务开发自定义认证 简介 本手册基于华为云API网关实践所编写，用于指导如何为API添加自定义认证。 在API的安全认证方面，API网关提供IAM认证、APP认证等方式，帮助用户快速开放API，同时API网关也支持用户使用自己的认证方式（以下简称自定义认证），以便更好地兼容已有业务能力。
API网关自定义策略 如果系统预置的API网关权限，不满足您的授权要求，可以创建自定义策略。自定义策略中可以添加的授权项（Action）请参考细粒度策略支持的授权项。 目前华为云支持以下两种方式创建自定义策略： 可视化视图创建自定义策略：无需了解策略语法，按可视化视图导航栏选择云
负载通道 负载通道主要用于将服务通过API网关专享版开放给外部访问。它的优势在于使用VPC的内部子网通信，网络时延更低，同时负载通道具有负载均衡功能（服务器通道类型），以及自动同步服务节点变更的能力（微服务通道类型）和使用已有的负载通道能力（引用负载通道类型），从而实现后端服务的
查看API列表 API列表支持查看当前实例下所有的API，包含URL、运行环境、安全认证等信息。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 您可以管理当前实例下的所有API，支持编辑、发布、调试等操作。 在左侧导航栏选择“API管理 > API列表”，进入到API列表页面。
调试API 操作场景 API创建后需要验证服务是否正常，管理控制台提供调试功能，您可以添加HTTP头部参数与body体参数，调试API接口。 后端路径中含有环境变量的API，不支持调试。 如果API已绑定流控策略，在调试API时，流控策略无效。 前提条件 已创建API分组和分组内的API。
按需计费 适用场景 按需计费适用于短期使用、实例无需7x24小时运行等场景。 适用计费项 表1 按需计费适用计费项 计费项 说明 版本（实例规格） API网关提供的实例版本有：基础版、专业版、企业版、铂金版等，您可以根据实际业务需要按需使用。实例版本说明，请参考产品规格。如果您当
SSL证书管理 如果API分组中的API支持HTTPS请求协议，则在绑定独立域名后，还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书，支持单向认证和双向认证两种认证方式。 单向认证：客户端与服务端连接时，客户端需要验证所连接的服务端是否正确。 双向认证：
实施步骤 创建策略。 登录API网关控制台，创建流量控制2.0策略。具体操作步骤请参考《API网关用户指南》中的流量控制2.0策略。 在左侧导航栏中选择“API管理 > API策略”，单击“创建策略”，在弹窗中选择“流量控制2.0”。 根据流控诉求，配置策略基本信息。 表1 策略基本信息
实施步骤 前提条件 已创建自定义认证函数，如果未创建请参考《函数工作流用户指南》中的创建函数章节创建，并且在函数的返回值中已设置context字段，字段中包含键值对。其中键值对的值只支持字符串、布尔、整型三种数值类型，键值对对应“系统参数-前端认证参数”策略条件的参数名称和条件值。
第三方认证策略说明 您可以通过第三方认证策略配置自己的鉴权服务为API的访问进行认证。API网关先调用用户的鉴权服务，收到鉴权服务的鉴权成功响应后再继续调用后端服务。 如果此策略在当前实例中不支持，请联系技术支持升级实例到最新版本。 第三方认证原理图如下，第三方认证策略绑定API后，您可以参考调用API调用。
HTTP状态码 常用状态码表如表1所示。 表1 HTTP请求状态返回码 返回值 说明 200 OK 处理正常。 204 No Content 无返回内容。 400 Bad Request 服务器未能处理请求。可能原因： 语义有误，当前请求无法被服务器解析； 请求参数有误。 401
专享版-VPC通道管理 创建VPC通道 更新VPC通道 删除VPC通道 查看VPC通道详情 查询VPC通道列表 添加或更新后端实例 查看后端实例列表 更新后端实例 删除后端实例 批量修改后端服务器状态可用 批量修改后端服务器状态不可用 修改VPC通道健康检查 添加或更新VPC通道后端服务器组
VPC通道管理 对象模型 创建VPC通道 更新VPC通道 删除VPC通道 查看VPC通道详情 查看VPC通道列表 添加后端实例（云服务器） 删除后端实例（云服务器） 查看后端实例列表（云服务器列表） 父主题： 共享版API（仅存量用户使用）
添加或更新后端实例 功能介绍 为指定的VPC通道添加后端实例 如果指定地址的后端实例已存在，则更新对应后端实例信息。如果请求体中包含多个重复地址的后端实例定义，则使用第一个定义。 引用负载通道类型的负载通道不支持添加或更新后端实例。 调用方法 请参见如何调用API。 URI POST
VPC通道管理（待下线） 对象模型 创建VPC通道 更新VPC通道 删除VPC通道 查看VPC通道详情 查看VPC通道列表 添加后端实例（云服务器） 删除后端实例（云服务器） 查看后端实例列表（云服务器列表） 父主题： 专享版API（V1）（待下线）
修订记录 表1 文档修订记录 发布日期 修订记录 2024-06-26 新增编排规则管理接口。 新增实例自定义入方向端口管理接口。 2024-01-19 新增查询实例支持的特性列表接口。 新增设置调试域名是否可以访问接口。 新增异步任务管理接口。 2023-09-12 增加修改变量接口。
查询VPC通道后端云服务组列表 功能介绍 查询VPC通道后端云服务组列表 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/member-groups
创建VPC通道 操作场景 VPC通道主要用于将部署在VPC内的服务通过API网关开放给外部访问，它的优势在于使用VPC的内部子网通信，网络时延更低，同时VPC通道具有负载均衡功能，从而实现后端服务的负载均衡。 创建VPC通道后，在创建API，且后端服务类型为HTTP/HTTPS时
发布API 操作场景 创建完成的API，支持发布到不同的环境。API只有在发布到环境后，才支持被调用。API网关支持查看API发布历史（如版本、发布说明、发布时间和发布环境），并支持回滚到不同的API历史版本。 已发布的API，在修改信息后，需要重新发布才能将修改后的信息同步到环境中。
查看后端实例列表 功能介绍 查看指定VPC通道的后端实例列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
