检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置API的后端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指APIG使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数
响应内容,符合JSON格式即可。 类型 API类型: 公开:选择“公开”类型时,API支持上架。 私有:选择“私有”类型时,当该API所在分组上架时,该API不会上架。 安全认证 API认证方式: APP认证:表示由API网关服务负责接口请求的安全认证。 华为IAM认证:表示借助IAM服务进行安全认证。
在“API运行”页签,选择待调试的API,单击“调试”。 配置URL和API请求参数。 选择请求方法、请求协议、域名等,然后配置API请求参数。 域名可选调试域名或独立域名。当选择的独立域名为泛域名时,需要填写泛域名的子域名。 当独立域名为泛域名时,用户可以通过泛域名的所有子域名访问所绑定分组下的所有API。
API网关如何开放部署在华为云上的服务? 如果部署在华为云上的服务绑定了公网IP地址,在API网关中创建API时,使用公网IP地址:端口号作为后端服务地址。如果此服务已绑定域名,则优先使用域名作为后端服务地址。创建API的详细步骤请参见创建API。 如果部署在华为云上的服务无公网
查看监控指标与配置告警 APIG支持的监控指标 配置APIG的监控告警 查看APIG的监控指标 查看APIG的带宽监控 查看APIG的API调用日志
专享版-配置管理 查询某个实例的租户配置列表 查询租户实例配置列表 父主题: 专享版API(V2)
”头是否为发布的环境名。 域名解析不正确。如果API的域名、请求方法、路径正确,且已发布到环境,有可能是没有准确解析到您的API所在分组。请检查API所在的分组域名,例如您有多个API分组,每个分组有自己的独立域名,API调用时,使用了其他分组的独立域名。 检查API是否使用OP
操作:终端节点服务对终端节点的连接审批,可选择“接受”或“拒绝”。 须知: 如您仍有业务通过该连接进行访问,拒绝已建立的连接可能导致业务受损,请谨慎操作。 权限管理 权限管理用于控制是否允许跨租户的终端节点进行访问。可以设置允许连接该终端节点服务的授权账号ID,将授权账号ID添加至终端节点服务的白名单中。
方式的配置。 配置APIG的API认证凭据 在API网关中创建一个凭据,生成密钥对(Key、Secret),在调用API时,API网关服务根据密钥对进行身份核对,完成鉴权。Key唯一且不可重置,支持重置Secret。 配置APIG的API简易认证AppCode API配置简易认证
密算法。 域名 调试域名默认只能在与实例相同VPC内的服务器上解析和访问,如果调试域名要支持公网解析与访问,请在实例上绑定公网入口弹性IP。 调试域名不能用于生产业务,且仅限应用程序调试使用。 同一实例下的不同分组不能绑定相同的独立域名。 独立域名绑定端口时,同一域名不支持绑定相同端口。
新建一个华为IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token? x-auth-token在API网关内部已经被定义了,如果您再次创建此参数名,容易导致冲突。 API网关控制台中已经限定您无法创建HEADER位置的x-auth-token
配置API的自定义认证 配置API的前端自定义认证 配置API的后端自定义认证 父主题: 管理API
所有Region都可以配置。 可指定保底带宽和弹性带宽。 约束与限制 对接高防后,如果开启了WEB基础防护或者CC防护,APIG将无法透传真实源IP。 需修改域名的IP,必须使用高防IP。 需依赖公网DNS进行域名切换。 业务带宽需收费。 域名切换有短暂时间间隔,可能会导致网络中断。 父主题:
PI分组的域名,并添加证书。添加域名后,还需执行放行回源IP、本地验证、修改域名DNS解析设置。详细操作步骤请参考网站接入WAF(云模式)。 客户从公网客户端访问WAF时,使用的是WAF对外访问域名,WAF转发给APIG时同样使用该对外访问域名,APIG收到访问该域名的请求无次数限制。
查看API的调用日志 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“监控分析 > 日志分析”。 单击“配置访问日志”,将“启动日志记录”修改为,即启用日志记录能力。 “日志组”和“日志流”设置请参见日志管理,完成后单击“确定”。 查看日志分析可
API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名每天最多可以访问1000次。 共享版中的API,分组子域名可公网访问。 对外开放API时,您需要为API分组绑定您自己的独立域名。 后续操作 API分组创建成功后,您可以为此分组绑定域名,API调用者通过访问独立域名来调用您开放的API。 父主题:
String 配置项的编号 R - module_name String 配置项所属的模块名称 R - config_name String 配置项的名称 R - config_value String 配置项的值 RU - can_special Integer 是否支持特殊配置 1:
配置API的发布环境和环境变量(可选) 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建的一种变量,该变量固定在环境上
测量维度:instance_id 1分钟 req_count 接口调用次数 该指标用于统计测量api接口调用次数 ≥0 测量对象:单个API 测量维度:api_id 1分钟 req_count_2xx 2xx调用次数 该指标用于统计测量api接口调用2xx的次数 ≥0 测量对象:单个API
为什么跨域调用API失败? 可能原因 API的跨域共享配置不正确。 解决方法 检查是否开启CORS。 进入API详情,单击“编辑”,查看是否开启CORS。如果没开启CORS,请开启。 检查是否创建OPTIONS方式的API,每个分组只需创建一个OPTIONS方式的API。 参数配置如下: 所属分