检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查看监控指标 操作场景 云监控对API网关的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API分组和分组内的API。 操作步骤 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 单击“API名称”,进入“
环境管理 对象模型 创建环境 修改环境 删除环境 查询环境列表 父主题: 共享版API(仅存量用户使用)
域名管理 对象模型 绑定域名 解绑域名 绑定域名证书 删除域名证书 查看域名证书 父主题: 共享版API(仅存量用户使用)
AK/SK认证 使用AK(Access Key ID)、SK(Secret Access Key)对请求进行签名。 AK:访问密钥ID。与私有访问密钥关联的唯一标识符,访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK:与访问密钥ID结合使用的密钥,对请求进行加密签名,
Java 操作场景 使用Java语言进行后端服务签名时,您需要先获取SDK,然后导入工程,最后参考校验后端签名示例校验签名是否一致。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 前提条件 已在API网关控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥
第三方认证策略说明 您可以通过第三方认证策略配置自己的鉴权服务为API的访问进行认证。API网关先调用用户的鉴权服务,收到鉴权服务的鉴权成功响应后再继续调用后端服务。 如果此策略在当前实例中不支持,请联系技术支持升级实例到最新版本。 第三方认证原理图如下,第三方认证策略绑定API后
API管理 创建API 开启跨域访问 调试API 授权API 发布API 下线API 删除API 导入API 导出API 父主题: 共享版操作指导(仅存量用户使用)
应用管理 创建应用并获取授权 删除应用 重置AppSecret 为简易认证添加AppCode 查看应用绑定的API详情 父主题: 共享版操作指导(仅存量用户使用)
创建告警规则 操作场景 通过创建告警规则,您可自定义监控目标与通知策略,及时了解API网关服务运行状况,从而起到预警作用。 告警规则包括告警规则名称、监控对象、监控指标、告警阈值、监控周期和是否发送通知等参数。 前提条件 API已被调用。 操作步骤 进入共享版控制台。 单击“开放API
限制与兼容性说明 在API网关中导入或者导出API时,限制与兼容性如下所示: 限制说明 API网关参数限制,如下所示。 API网关暂不支持formData和body位置的请求参数定义。 API网关暂不支持consumes和produces定义。 API网关中,header位置的参数名称
API调用是否支持长连接 支持。 注意适当使用长连接,避免占用太多资源。 父主题: API调用
API调试的时候,如何指定环境? 不能指定。 API网关控制台提供的调试功能,用的是特定的debug环境,调试完成后需先发布到对应环境,之后可使用代码或者postman等工具,并添加请求消息头X-Stage,才能访问指定环境。 父主题: API发布
API管理 对象模型 创建API 修改API 删除API 发布API 下线API 批量发布或下线API 查看API详情 查询API列表 查询API历史版本列表 根据版本编号下线API 查看版本详情 查询API运行时定义 调试API 父主题: 共享版API(仅存量用户使用)
认证前准备 APP认证方式调用API,需要提前获取如下信息: 获取API的请求信息 在APIG实例控制台选择“API管理 > API列表”,单击API名称进入API详情,在“API运行”页签的API名称下方查看API的域名、请求路径和请求方法。 API已发布到环境 在APIG实例控制台选择
监控 支持的监控指标 创建告警规则 查看监控指标 父主题: 共享版操作指导(仅存量用户使用)
API调用返回错误码如何处理? 如果您直接调用自己创建的API,点此查询错误信息与解决方案。 如果您使用接口管理您的API,点此查询错误信息与解决方案。 父主题: API调用
专享版-实例管理 创建专享版实例(按需) 查看专享版实例详情 更新专享版实例 查看专享版实例创建进度 实例更新或绑定EIP 实例解绑EIP 开启实例公网出口 更新实例出公网带宽 关闭实例公网出口 开启实例公网入口 更新实例入公网带宽 关闭实例公网入口 查看可用区信息 查询专享版实例列表
环境变量管理 对象模型 新建变量 删除变量 查看变量详情 查询变量列表 父主题: 共享版API(仅存量用户使用)
APP认证工作原理 构造规范请求。 将待发送的请求内容按照与API网关(即API管理)后台约定的规则组装,确保客户端签名、API网关后台认证时使用的请求内容一致。 使用规范请求和其他信息创建待签字符串。 使用AK/SK和待签字符串计算签名。 将生成的签名信息作为请求消息头添加到HTTP
下线API 操作场景 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入共享版控制台