检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调试API 操作场景 API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已创建API分组和分组内的
删除VPC通道 操作场景 已创建的VPC通道不再需要时,可以直接删除。 如果API已经使用VPC通道,且API已发布到环境,此时无法删除此VPC通道。 前提条件 已创建VPC通道。 操作步骤 进入共享版控制台。 单击“开放API > VPC通道”,进入到VPC通道列表页面。 通过以下任意一种方法
访问控制 创建访问控制策略 删除访问控制策略 父主题: 共享版操作指导(仅存量用户使用)
导出API 操作场景 导出JSON或YAML格式的API。API网关支持单个API导出和批量API导出。 云商店购买的API不支持导出。 前提条件 已创建API分组和API。 操作步骤 进入共享版控制台。 单击“导出API”,进入“导出API”界面。 设置如表1所示参数。 图1 导出
API分组管理 创建API分组 绑定域名 删除分组 新增网关响应 父主题: 共享版操作指导(仅存量用户使用)
流量控制 创建流控策略 删除流控策略 添加特殊应用或租户 删除特殊应用或租户 父主题: 共享版操作指导(仅存量用户使用)
API统计信息查询-最近一段时间 功能介绍 根据API的id和最近的一段时间查询API被调用的次数,统计周期为1分钟、小时、天。 查询范围一小时以内,一分钟一个样本,其样本值为一分钟内的累计值,服务器返回服务器的时间的上一分钟到往前推N分钟的数据; 查询范围一天以内,返回一小时一个样本
自定义认证 创建自定义认证 删除自定义认证 父主题: 共享版操作指导(仅存量用户使用)
删除分组 操作场景 API分组在创建后,如需对创建的数据进行删除,可以删除此分组。 如果API分组下存在API,API分组无法被删除。 前提条件 已创建分组。 操作步骤 进入共享版控制台。 单击“开放API > API分组”,进入到API分组信息页面。 通过以下任意一种方式,进入“
已购买API 操作场景 API网关共享版支持查看已购买的API,明确已购买服务的详情。并通过调试API,验证服务是否正常。 已购买的API,需要通过APP认证方式调用。 前提条件 已从云商店购买了API。 操作步骤 进入共享版控制台。 单击“调用API > 已购买API”,进入到已购买
授权API 操作场景 API在创建后,通过指定授权给某些应用,让指定应用能够调用API。 仅在API发布到环境后,才支持被授权。 仅在API为APP认证时,才支持授权给应用。 前提条件 已创建API分组和分组内的API。 (可选)已创建环境。 已创建应用。 操作步骤 进入共享版控制台
环境管理 创建环境和环境变量 删除环境 父主题: 共享版操作指导(仅存量用户使用)
SDK API网关开放的API,安全认证方式可选IAM认证、APP认证、自定义认证或无认证。四者的区别以及如何选择,请参考调用API。 本章节主要提供APP认证的SDK下载以及文档。IAM认证请参考“使用IAM认证调用API”章节。 操作场景 API使用APP认证时,请根据需要下载
支持的监控指标 功能说明 本节定义了API网关服务上报云监控服务的监控指标的命名空间,监控指标列表和维度定义,用户可以通过云监控服务提供管理控制台或API接口来检索API网关服务产生的监控指标和告警信息。 命名空间 共享版:SYS.APIG API网关监控指标 表1 API网关共享版支持的监控指标
新增网关响应 操作场景 网关响应,指API网关未能成功处理API请求,从而产生的错误响应。API网关提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API分组管理中新增网关响应,其中响应内容符合JSON格式即可。 例如,“default”网关的响应内容为
编辑健康检查配置 操作场景 VPC通道创建完成后,可通过编辑健康检查配置修改健康检查项。 前提条件 已创建VPC通道。 操作步骤 进入共享版控制台。 单击“开放API > VPC通道”,进入到VPC通道列表页面。 单击“VPC通道名称”,进入VPC通道详情页面。 单击“健康检查”,
本方案以“系统参数-前端认证参数”为例,讲述用户如何通过设置“系统参数-前端认证参数”策略条件将API请求转发到指定的后端服务中。 约束与限制 添加策略后端前,前端的安全认证方式应选“自定义认证”或使用双重认证(APP认证或IAM认证)。
图1 业务使用流程 创建用户并授权使用APIG 通过IAM服务创建用户并授权使用API网关,如果系统预置的APIG权限不满足授权要求,您也可以创建自定义策略。 创建APIG实例 实例是一个独立的资源空间,所有的操作都是在实例内进行,不同实例间的资源相互隔离。
调用已发布的API 调用API 响应消息头 错误码 父主题: 共享版操作指导(仅存量用户使用)
删除流控策略 操作场景 当已创建的流控策略不再提供服务时,可以将此流控策略删除。 前提条件 已创建流控策略。 操作步骤 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。 通过以下任意一种方式,弹出“删除流控策略”对话框。 在待删除的流控策略所在行,单击