检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置API的后端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指APIG使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数
弹性云服务器”,进入弹性云服务器管理页面。 单击待使用的弹性云服务器名称,进入详情页面。 在“弹性网卡”页签中,单击,查看子网名称。 在“基本信息”页签中,查看虚拟私有云名称。 单击虚拟私有云名称,进入“网络控制台 > 虚拟私有云”页面。 在左侧导航栏中单击“子网”。 找到4中对应的子网,单击子网名称。
在“API运行”页面,选择待查看发布历史的API。 单击“更多 > 发布历史”。 在版本所在行,单击“查看版本”,弹出此版本详细信息对话框。 查看API基本信息、API请求、后端请求、入参定义、参数映射、常量参数和返回结果。 如果想要设置之前版本为当前版本,则在版本所在行,单击“切换至此版本”,弹出“切换至此版本”对话框。
参数位置:参数在API请求中的位置。 参数:用于做规则匹配的参数名。 系统默认包含reqPath(请求路径)和method(请求方法)参数。单击“添加参数”,可添加其他匹配参数。 定义规则 自定义断路器的匹配规则。单击“添加规则”,可添加规则,系统根据从上到下的顺序匹配规则,可通过上下移动调整规则优先级。
配置API的前端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指APIG使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数
在左侧导航栏选择“API管理 > API策略”。 单击“负载通道”页签,进入到负载通道列表页面。 单击“创建负载通道”,根据下表参数说明,配置基本信息。 表1 基本信息配置 参数 说明 通道名称 自定义负载通道名称,用于识别不同的负载通道。支持中文、英文、数字、下划线、中划线、点,且只能以英文和中文开头,长度为3~64个字符。
Integer 本次返回的列表长度 total Long 满足条件的记录数 certs Array of CertBase objects 证书基本内容 表5 CertBase 参数 参数类型 描述 id String 证书ID name String 证书名称 type String
如表1所示,包括了API网关的所有系统角色和策略。 表1 API网关的系统角色或策略 系统角色/策略名称 描述 类别 依赖关系 APIG Administrator API网关服务的管理员权限。拥有该权限的用户可以使用专享版和共享版API网关服务的所有功能。 系统角色 如果在操作过程中涉及
服务的所有策略请参见权限策略。 表1 API网关的系统角色或策略 系统角色/策略名称 描述 类别 依赖关系 APIG Administrator API网关服务的管理员权限。拥有该权限的用户可以使用API网关服务的所有功能。 系统角色 如果在操作过程中涉及其他服务资源的创建、删除
在开放API前,您需要为API分组绑定一个独立域名,供API调用者访问API使用。 在绑定独立域名前,您可以使用系统为API分配的调试域名进行API调试,每天最多可以访问调试域名1000次。系统自动分配的域名不能用于生产业务,且仅限应用程序调试使用。 创建API的负载通道(可选) 如果需要访问
api_call_limits 是 Integer API流量限制是指时长内一个API能够被访问的次数上限。该值不超过系统默认配额限制,系统默认配额为200tps,用户可根据实际情况修改该系统默认配额。输入的值不超过2147483647。正整数。 type 否 Integer 流控策略的类型 1
映射后端参数 如果认证通过,函数返回的context信息,可以传到后端,配置方式如下: 编辑API,在后端服务页面,添加系统参数,参数类型为前端认证参数,系统参数名称填自定义认证函数中context中的字段,后端参数名称和位置填需要传入到后端请求的参数名和位置。 验证 编辑和发布
可。 域名问题 域名是否备案成功,且能正常解析。 域名是否绑定到正确的API分组。 子域名(调试域名)访问超过默认次数。API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名唯一且不可更改,每天最多可以访问1000次。您可以通过添加独立域名来访问您开放的API。 发布问题
api_call_limits 是 Integer API流量限制是指时长内一个API能够被访问的次数上限。该值不超过系统默认配额限制,系统默认配额为200tps,用户可根据实际情况修改该系统默认配额。输入的值不超过2147483647。正整数。 user_call_limits 否 Integer
name String 名称 status Integer 状态 sl_domain String 系统默认分配的子域名 sl_domains Array of strings 系统默认分配的子域名列表 register_time Timestamp 创建时间 update_time
并选择指定的自定义认证对象,如果没有,则需要创建自定义认证。 配置API后端 在API的后端设置页面添加策略后端,策略条件的条件来源选择“系统参数-前端认证参数”,并完善参数名称、条件类型、条件值等,其中参数名称和条件值要与前端自定义认证函数返回值中context字段下的键值对一致。
方案优势 帮助用户根据业务诉求进行灵活配置,无需修改原有业务网络架构,直接将请求转发到后端服务上。 约束与限制 VPC1、VPC2、APIG实例系统VPC网段不能重叠。关于APIG实例VPC网段规划,请参考表2。 父主题: 使用APIG专享版跨VPC开放后端服务
api_call_limits 是 Integer API流量限制是指时长内一个API能够被访问的次数上限。该值不超过系统默认配额限制,系统默认配额为200tps,用户可根据实际情况修改该系统默认配额。输入的值不超过2147483647。正整数。 user_call_limits 否 Integer
ie信息作为判断条件。 系统参数:以网关内置参数作为策略条件来源。网关内置参数指API网关处理API请求时的系统运行时参数信息。 须知: 选择“请求入参”作为策略条件时,入参需要在API前端请求中配置好,如在Header中添加一个参数。 如果未展示“系统参数”请联系技术支持升级实例。
String 编号 name String 名称 status Integer 状态 sl_domain String 系统默认分配的子域名 sl_domains String 系统默认分配的子域名列表 register_time Timestamp 创建时间 update_time Timestamp