检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API的策略后端有多个时,怎么匹配和执行API请求? 当您的API配置了多个策略后端,API网关会按顺序进行匹配,匹配到其中一个立即执行API请求转发,不会进行后续的匹配。 当策略后端都没有匹配成功,则按照默认后端执行API请求的转发。 父主题: 调用API
添加特殊应用或租户 操作场景 如果需要为某个应用/租户设置特定的流控值,则通过添加特殊应用/租户可以实现。 前提条件 已创建应用,或已获取其他应用ID/租户ID。 添加特殊应用 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。 单击待添加特殊应用的流控策略的名称,进入流控详情页面。
修改域名 功能介绍 修改绑定的域名所对应的配置信息。使用实例自定义入方向端口的特性时,注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_
有的策略(ACL,流控等)。 (可选)单击“全局配置(可选)”。 安全配置。请参考5.b。 后端请求配置。请参考1。 单击“下一步”,支持通过“表单”、“JSON”、“YAML”样式查看配置详情。 确认无误后,单击“提交”,完成配置。 单击“立即导入”,在弹窗中选择是否现在发布API到环境。
无法找到插件配置 联系技术支持 APIG.0105 The backend configurations do not exist. 500 无法找到后端配置 联系技术支持 APIG.0106 Orchestration error. 400 编排错误 检查API配置的前后端参数是否合理
对于共享版,域名必须完成备案,并将其CNAME解析到API分组对应的子域名。不能将无法在公网访问的域名,或者将他人所有的域名绑定给API分组。 对于专享版,可以配置内网域名,域名不需要备案,并将A记录解析到实例的入口地址。 父主题: 开放API
在控制台的主菜单中选择“费用 > 续费管理”。 自定义查询条件。 可在“到期转按需项”页签查询已经设置到期转按需的实例。 可对“手动续费项”、“自动续费项”、“到期不续费项”页签的资源设置到期转按需的操作。 设置包年/包月资源到期后转按需。 单个资源到期转按需:在“手动续费项”页签中选择需要更改
单击“分组名称”,进入分组详细信息页面。单击“域名管理”。 在待绑定域名的分组所在行,单击“更多 > 域名管理”。 单击“绑定独立域名”,设置域名信息。 单击“确定”,将独立域名与API分组绑定。 如果不再需要此域名时,在域名所在行,单击“解除绑定”。 (可选)绑定SSL证书。A
进入API详情,单击“编辑”,查看是否开启CORS。如果没开启CORS,请开启。 检查是否创建OPTIONS方式的API,每个分组只需创建一个OPTIONS方式的API。 参数配置如下: 所属分组:选择已开启CORS的API所在分组。 请求方法:选择OPTIONS。 请求协议:选择与已开启CORS的API相同的请求协议。
参数和返回结果。 如果想要设置之前版本为当前版本,则在版本所在行,单击“切换至此版本”,弹出“切换至此版本”对话框。 单击“确定”,完成版本的切换。此时版本号旁边显示“当前版本”,说明设置成功。 API调用者调用此API时,API参数为“当前版本”设置的参数,不是最后一次编辑保存的API参数。
basic类型需要实例升级到对应版本,如果不存在可联系技术工程师升级。 public_key类型开启实例配置public_key才可使用,实例特性配置详情请参考“附录 > 实例支持的APIG特性”,如确认实例不存在public_key配置可联系技术工程师开启。 aes类型需要实例升级到对应版本,如果不存在可联系技术工程师升级。
选择在FunctionGraph中创建的函数。 身份来源 设置用于认证的请求参数,支持添加Header参数和Query参数,其中Header的参数名不区分大小写。 当“类型”为“前端”,且“缓存时间”不为0时,必须设置此参数。使用缓存时,此参数将作为搜索条件来查询认证结果。 缓存时间 设置认证结果缓存的时间。 值为0时代表不缓存,最大支持3600秒。
因此,要开放API对外提供服务,首先需要创建实例。 实例创建完成后,您可以通过配置实例参数调整组件的相关功能,配置APIG实例标签分组标记实例资源,配置APIG的终端节点信息连接终端节点服务,更多配置操作请参考管理APIG实例章节。 开放API 将成熟的业务能力(如服务、数据等)
在左侧导航栏选择“API管理 > API分组”。 单击“创建API分组 > 导入CSE微服务”。根据下表参数说明,配置信息。微服务引擎详细介绍请参考微服务引擎CSE。 表1 配置信息 参数 说明 所属分组 CSE微服务导入成功后,生成的API所在的API分组。支持同步创建新的分组或选择已有分组。
> API列表”。 单击“创建API > 创建GRPC API”。更多详细指导,请参见创建GRPC API。 配置前端信息后,单击“下一步”。 表1 前端配置 参数 配置说明 API名称 填写API名称,建议您按照一定的命名规则填写,方便您快速识别和查找。 所属分组 默认“DEFAULT”。
新建变量 功能介绍 将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。
使用前必读 欢迎使用API网关(API Gateway),API网关为您提供高性能、高可用、高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。 您可以使用本文档提供的API对API网关进行相关操作,如创建、删除、修改等。支持的全部操作请参见API概览。 在调用A
新建变量 功能介绍 将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。
debug,且API配置了API流量控制时,返回此参数 X-Apig-RateLimit-user 用户流量限制信息 示例:remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug,且API配置了用户流量限制时,返回此参数
云审计服务 CTS的详细介绍和开通配置方法,请参见CTS快速入门。 APIG用户查看云审计日志方法,请参见云审计日志。 日志 APIG支持日志自定义分析模板,便于日志的统一收集和管理,也可通过API异常调用分析进行追查和溯源。 关于APIG日志记录的详细介绍和配置方法,请参见日志分析。 父主题: