检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用前必读 欢迎使用API网关(API Gateway),API网关为您提供高性能、高可用、高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。 您可以使用本文档提供的API对API网关进行相关操作,如创建、删除、修改等。支持的全部操作请参见API概览。 在调用A
有的策略(ACL,流控等)。 (可选)单击“全局配置(可选)”。 安全配置。请参考5.b。 后端请求配置。请参考1。 单击“下一步”,支持通过“表单”、“JSON”、“YAML”样式查看配置详情。 确认无误后,单击“提交”,完成配置。 单击“立即导入”,在弹窗中选择是否现在发布API到环境。
新建变量 功能介绍 将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。
修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常,通信失败、返回异常响应等错误 自定义认证失败 500 自定义认证方返回认证失败 自定义认证身份来源错误
方式二:在API网关中一键式导入CCE工作负载,自动生成API和负载通道,通过负载通道访问CCE工作负载中的实例地址。 (可选)配置工作负载标签实现灰度发布 通过CCE工作负载的标签配置,实现灰度发布。灰度发布是服务发布策略之一,旨在通过调整流量分配权重,逐步将流量从旧版本引导到新版本实例上。 父主题:
虚拟私有云(Virtual Private Cloud,简称VPC)。实例需要配置虚拟私有云(负载),在同一负载中的资源(如ECS),可以使用实例的私有地址调用API。 在创建实例时,建议配置和您其他关联业务相同负载,确保网络安全的同时,方便网络配置。 创建实例后,不支持修改虚拟私有云(负载)。 弹性公网IP
云审计服务 CTS的详细介绍和开通配置方法,请参见CTS快速入门。 APIG用户查看云审计日志方法,请参见云审计日志。 日志 APIG支持日志自定义分析模板,便于日志的统一收集和管理,也可通过API异常调用分析进行追查和溯源。 关于APIG日志记录的详细介绍和配置方法,请参见日志分析。 父主题:
创建自定义的前端函数,使用函数服务开发自定义认证。 创建自定义认证 创建自定义认证,类型选择“前端”,函数地址选择上一步创建的函数。 创建API 安全配置中的安全认证选择APP认证,并勾选“支持双重认证”,选择上一步创建的自定义认证。 创建凭据 使用APP认证的API,需要在API网关中创建
新建变量 功能介绍 将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。
创建VPC通道 操作场景 VPC通道主要用于将部署在VPC内的服务通过API网关开放给外部访问,它的优势在于使用VPC的内部子网通信,网络时延更低,同时VPC通道具有负载均衡功能,从而实现后端服务的负载均衡。 创建VPC通道后,在创建API,且后端服务类型为HTTP/HTTPS时
致API缺少公网访问的有效地址,公网调用API失败。 绑定EIP后重新调用即可,详细步骤请参考网络环境准备。 入方向规则配置有误,导致公网调用API失败。 配置入方向规则的详细步骤请参考网络环境准备。 调用时未添加请求消息头“host:分组域名”,导致公网调用API失败。添加消息头后,重新调用即可。
专享版-实例特性管理 实例配置特性 查看实例特性列表 查询实例支持的特性列表 父主题: 专享版API(V2)
API认证 使用FunctionGraph服务实现APIG的自定义认证 使用APIG的APP认证和自定义认证实现API的双重认证 配置APIG专享版与客户端间的单向认证或双向认证
式。 适用于API需求波动的场景,可以随时开通,随时删除。 当您的API后端服务部署在公网时,除实例费用外需要另外收取API请求出公网带宽费用。 专享版实例部署在虚拟私有云中,如果您的后端服务也部署在相同虚拟私有云,可直接通过私有地址访问,无需购买带宽。 专享版实例的API如从公
APP授权管理 环境管理 环境变量管理 流控策略管理 API绑定流控策略 设置特殊流控 ACL策略管理 API绑定ACL策略 云商店订购信息查询 配置管理 概要查询 签名密钥管理 签名密钥绑定关系管理 域名管理 VPC通道管理 监控信息查询 OpenAPI接口 自定义认证管理
0/apigw/throttle-specials/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 特殊配置的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 call_limits 是 Integer 特殊对象在流控时间内能够调用API的最大次数限制
"a5322eb89048eb41d705491a76a05aca" } 可能原因 appkey配置错误。 解决方法 在API网关控制台页面的左侧导航栏中选择“API管理 > 凭据管理”。 单击对应的凭据名称,进入凭据详情。 查看“Key”值,并重新配置appkey。 Incorrect app authentication
修改分组自定义响应 删除分组自定义响应 查看分组下指定错误类型的自定义响应 修改分组下指定错误类型的自定义响应 删除分组指定错误类型的自定义响应配置 查询分组自定义响应列表 父主题: 专享版API(V2)
限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String 特殊配置的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 call_limits 是 Integer 特殊对象在流控时间内能够调用API的最大次数限制
API网关可通过手动创建的负载通道或者导入CCE的工作负载生成的负载通道,动态监测工作负载下所有实例的地址变化,并自动更新到负载通道中。 支持通过CCE工作负载标签配置进行灰度发布,完成灰度测试与版本切换。 提供多种认证方式,增加访问安全性。 提供访问流量控制策略,增加后端服务的安全性 与直接访问容器应用