检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
本手册基于华为云API网关实践所编写，用于指导如何为API添加自定义认证。 在API的安全认证方面，API网关提供IAM认证、APP认证等方式，帮助用户快速开放API，同时API网关也支持用户使用自己的认证方式（以下简称自定义认证），以便更好地兼容已有业务能力。 API网关支持的自定
流控策略的名称 api_call_limits Integer 单个API流控时间内能够被访问的次数限制 user_call_limits Integer 单个用户流控时间内能够访问API的次数限制 app_call_limits Integer 单个APP流控时间内能够访问API的次数限制
客户从公网客户端访问WAF时，使用的是WAF对外访问域名，WAF转发给APIG时同样使用该对外访问域名，APIG收到访问该域名的请求无次数限制。 在APIG实例中，为API分组绑定已创建的防护域名。 进入APIG控制台，在左侧导航栏中选择“API管理 > API分组”。 单击已创建的分组名称。
Long 满足条件的记录数 apis Array of PluginApiInfo objects 绑定插件的API列表。 表5 PluginApiInfo 参数 参数类型 描述 api_id String API编号 api_name String API名称。 支持汉字、英文、数
apig:apis:create apig:apis:debug " ] } ] } 示例2：拒绝用户创建API分组 拒绝策略需要同时
图3 API网关服务调用API 调用API的业务使用流程如下图所示。 图4 API网关服务调用API基本流程 获取API 获取API的请求信息，包括访问域名、请求协议、请求方法、请求路径以及认证方式等信息。 创建应用 使用APP认证的API，需要在API网关中创建一个应用，以
的单个IP地址请求次数上限。 API流量限制 单个API被调用次数上限。 与“时长”配合使用，表示单位时间内的单个API请求次数上限。 用户流量限制 单个用户调用API次数上限，仅在API的安全认证方式为APP认证或IAM认证时适用。 不超过“API流量限制”。 与“时长”配合使
已购买API 操作场景 API网关共享版支持查看已购买的API，明确已购买服务的详情。并通过调试API，验证服务是否正常。 已购买的API，需要通过APP认证方式调用。 前提条件 已从云商店购买了API。 操作步骤 进入共享版控制台。 单击“调用API > 已购买API”，进入到已购买API分组信息页面。
FullAccess API网关服务所有权限。拥有该权限的用户可以使用API网关服务的所有功能。 系统策略 无。 APIG ReadOnlyAccess API网关服务的只读访问权限。拥有该权限的用户只能查看API网关服务的各类信息。 系统策略 无。 示例流程 图1 给用户授权API网关服务权限流程
删除API 功能介绍 删除指定的API。 删除API时，会删除该API所有相关的资源信息或绑定关系，如API的发布记录，绑定的后端服务，对APP的授权信息等。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances
SDK API网关开放的API，安全认证方式可选IAM认证、APP认证、自定义认证或无认证。四者的区别以及如何选择，请参考调用API。本章节主要提供APP认证的SDK下载以及文档。 操作场景 API使用APP认证时，请根据需要下载SDK包和文档，参考文档完成API的调用。 操作步骤
签名密钥用于后端服务验证API网关的身份，在API网关请求后端服务时，保障后端服务的安全。 签名密钥由一对Key和Secret组成，签名密钥需要绑定到API才能生效。当签名密钥绑定API后，API网关向后端服务发送此API的请求时，会增加相应的签名信息，此时需要后端服务依照同样方式进行签名，通
此时API调用者调用此API时，API的匹配模式为“绝对匹配”。 发布API相关的FAQ 对API的修改是否需要重新发布？ API发布到RELEASE环境可以正常访问，发布到非RELEASE环境无法访问？ API发布到不同环境后，会调用不同的后端服务吗？ 父主题： API管理
默认限制 能否修改 API分组数量 每个用户最多创建50个API分组。 √ API数量 每个用户最多创建200个API。 √ 后端策略数量 每个用户最多创建5个后端策略。 √ 应用数量 每个用户最多创建50个应用。应用配额包括用户自行创建的应用和API云商店购买API生成的应用。 √
语义有误，当前请求无法被服务器解析； 请求参数有误。 401 Unauthorized 当前请求需要用户验证。如需要用户名和密码。 403 Forbidden 对被请求页面的访问被禁止。 404 Not Found 请求失败，在服务器上未找到请求所希望得到的资源。 405 Method Not Allowed 请求
流控策略描述字符长度不超过255。 说明： 中文字符必须为UTF-8或者unicode编码。 api_call_limits 是 Integer API流量限制是指时长内一个API能够被访问的次数上限。该值不超过系统默认配额限制，系统默认配额为200tps，用户可根据实际情况修改该
切换API版本 功能介绍 API每次发布时，会基于当前的API定义生成一个版本。版本记录了API发布时的各种定义及状态。 多个版本之间可以进行随意切换。但一个API在一个环境上，只能有一个版本生效。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id
Integer 单个API流控时间内能够被访问的次数限制 user_call_limits Integer 单个用户流控时间内能够访问API的次数限制 app_call_limits Integer 单个APP流控时间内能够访问API的次数限制 ip_call_limits Integer
您可以根据自身的业务需求使用APIG提供的一系列常用实践。 表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面，API网关提供IAM认证、APP认证等方式，帮助用户快速开放API，同时API网关也支持用户使用自己的认证方式（以下简称自定义认证），以便更好地兼容已有业务能力。
查询已购买的API分组列表 功能介绍 租户可以查询自己已购买的API分组列表。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/purchases/groups[?page_size
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
