检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置API的前端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权，可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型： 前端自定义认证：指APIG使用自定义的认证函数，对收到的API请求进行安全认证。 后端自定义认证：指API的后端服务使用自定义的认证函数，
操作流程 配置API前端 在API的前端设置页面选择安全认证方式为“自定义认证”或使用双重认证（APP认证或IAM认证），并选择指定的自定义认证对象，如果没有，则需要创建自定义认证。 配置API后端 在API的后端设置页面添加策略后端，策略条件的条件来源选择“系统参数-前端认证参
x-apigateway-auth-type 含义：基于Swagger的apiKey认证格式，定义API网关支持的特有认证方式。 作用域：Security Scheme Object(2.0)/Security Scheme Object(3.0) Swagger： securityDefinitions:
在左侧导航栏选择“实例管理”。 在待变更计费模式的实例上单击“更多 > 转按需”。 确认信息后，单击“到期转按需”。 方式二：在控制台的费用中心中变更计费模式。 在控制台的主菜单中选择“费用 > 续费管理”。 自定义查询条件。 可在“到期转按需项”页签查询已经设置到期转按需的实例。 可对“手动续费项”
为了让API响应结果为函数中返回的context中的字段（如果您使用的是专享版网关，并且实例支持authorizer_context_support_num_bool特性，那么context中的value的类型可以为boolean类型或number类型），需要修改网关响应模板。在API所在的分组中，“
获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 方法2：通过虚拟私有云服务的API接口查询，具体方法请参见《虚拟私有云服务API参考》的“查询VPC列表”章节。 subnet_id 是 String 子网的网络ID。 获取方法如下： 方法1
请求参数匹配编排规则的生效优先级与列表顺序保持一致，列表中靠前的配置匹配优先级较高； 如果编排规则列表中包含none_value类型的规则，则none_value类型的规则优先级最高，至多绑定一个none_value类型的规则； 如果编排规则列表中包含default类型的规则，则def
der”的初始值为空，与不启用效果一致。 如果配置“app_auth_header”的“参数运行值”，那么对于APP认证的API，请求header中携带APP认证信息的参数为此处“app_auth_header”的值；如果配置“backend_sign_header”的“参数运行
函数代码获取的三种请求参数与API网关自定义认证中的参数关系如下所示： Header中的请求参数：对应自定义认证中参数位置为Header的身份来源，其参数值在您调用使用该前端自定义认证的API时传入 Query中的请求参数：对应自定义认证中参数位置为Query的身份来源，其参数
IP地址/域名可以是公网IP（支持云服务器的弹性IP地址、用户自己服务器的公网IP地址、ELB地址）/公网域名，前提需要开启实例的公网出口。可以是内网的IP，不可以是内网域名。 2022年10月30日后创建的实例支持APIG与后端服务tls握手阶段向后端服务传SNI。 路径 后端服务的路径，即服务的uri，可以
广泛应用于实时聊天、在线游戏、金融行业的实时数据更新等场景。 约束与限制 WebSocket API不支持APIG控制台页面中的调试功能。 WebSocket API受API超时时间的限制，如果当前WebSocket连接空闲时间超过了配置的超时时间，并且没有ping/pong保活，则连接会被自动断开。
签名密钥用于后端服务验证API网关的身份，在API网关请求后端服务时，保障后端服务的安全。 签名密钥是由一对Key和Secret组成，签名密钥需要绑定到API才能生效。当签名密钥绑定API后，API网关向后端服务发送此API的请求时，会增加相应的签名信息，此时需要后端服务依照同样方式进行签名，通过比
aes-256-cfb Key 根据选择的密钥类型，填写不同的密钥信息。 HMAC：填写APP认证所使用密钥对的Key。 Basic Auth：填写basic认证所使用的用户名。 AES：填写AES认证所使用的密钥key。 Public Key：填写public_key认证所使用的公钥。 Secret
配置AppCode 参数 说明 生成方式 选择AppCode的生成方式。 自动生成：由系统随机生成AppCode。 手动输入：自定义AppCode。 AppCode 仅手动输入方式需要填写AppCode的值。 使用AppCode进行API请求的简易认证 在创建API时，选择“APP认证”并且开启“支持简易认证”。
ELB_SWITCH：是否启用ELB通道 AUTHORIZER_NUM_LIMIT：租户可创建的自定义认证个数限制 AUTHORIZER_IDENTITY_NUM_LIMIT：每个自定义认证可以设置的身份来源个数限制 APP_CODE_NUM_LIMIT：每个APP可以创建的APP
源，从而降低预置过多或不足的风险。一般适用于电商等设备需求量瞬间大幅波动的场景。 表1 实例版本计费模式 计费模式 包年/包月 按需计费 付费方式 预付费 按照订单的购买周期结算。 后付费 按照API网关实例版本和实际使用时长计费。 计费周期 按订单的购买周期计费。 秒级计费，按小时结算。
热门咨询 开放API API的后端服务是否支持绑定私网ELB地址？ API的后端服务地址支持填写私有地址（子网IP）吗？ API可以绑定内网域名吗？ 调用API 调用API失败的可能原因 调用API报“The API does not exist or has not been published
当在公网中调用APIG上公开的业务API时，如果不限制API调用的次数，随着用户的不断增加，会引起后端性能的下降，甚至会因为恶意用户发送的大量请求导致网站或程序崩溃。APIG提供了传统策略：流量控制，从API、用户、凭据、源IP等多个维度进行流控。 然而，随着用户多样性以及需求多样性的增加，传统流
复制API的URL到浏览器进行调用。 在“API运行”页面，复制API的URL。打开浏览器，在地址栏输入API的URL进行访问。显示创建API时填写的成功响应示例，表示调用成功。 图2 复制URL示例 至此，实现了通过一键式“导入CCE工作负载”的方式来开放CCE工作负载服务的能力。
策略名称 填写策略的名称，根据业务规划自定义。建议您按照一定的命名规则填写策略名称，方便您快速识别和查找。 策略类型 固定为“第三方认证”。 描述 填写策略的描述信息。 策略内容 策略的配置内容，支持表单配置和脚本配置两种方式。 负载通道 是否使用负载通道作为第三方接口的鉴权服务。 选择“使用”时，配置鉴权服务的负载通道。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
