产品优势 开箱即用的服务 只需在管理控制台配置,即可快速创建API。提供页面调试工具,简化API开发。可同时发布一个API到多个环境,快速迭代、测试API。 便捷的API生命周期管理 API网关提供全生命周期的API管理,从设计、开发、测试、发布、运维、上架、下架等, 实现完整的
调试API时,默认使用APIG特定的debug环境,因此不能指定其他环境。 调试完成后,需将API发布到对应环境上,再使用代码或者postman等工具,并添加请求消息头X-Stage,才能访问指定环境。 父主题: 发布API
可用区 选择实例的可用区,此处选择“可用区1,可用区2,可用区3”。 实例名称 填写实例的名称,此处填写“apig-test”。 实例规格 选择实例的规格,此处选择“基础版”。 可维护时间窗 指定可对实例进行维护的时间段,此处默认。 企业项目 选择实例所属的企业项目,此处选择“default”。
创建环境和环境变量 操作场景 API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是默认存在的环境,无需创建。且API网关提供环境变量功能,通过创建环境变量,实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上
≥0 单位:% 测量对象:单个网关节点 测量维度:node_ip 1分钟 node_memory_usage 网关节点内存使用率 该指标用于统计当前数据面网关节点内存使用率 ≥0 单位:% 测量对象:单个网关节点 测量维度:node_ip 1分钟 维度 表2 API网关监控指标测量维度
APIG业务使用流程 API网关(API Gateway)是为您提供高性能、高可用、高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。 API网关支持专享版和共享版(存量
须知: 选择“请求入参”作为策略条件时,入参需要在API前端请求中配置好,如在Header中添加一个参数。 如果未展示“系统参数”请联系技术支持升级实例。 参数名称 当“条件来源”为“请求入参”时,需要设置。选择已创建的入参参数名称。 当“条件来源”为“系统参数”时,需要选择参数名称。
Ingress和Gateway API的功能,不仅大幅提升了性能,还简化了架构,降低了部署和运维成本。 便捷调试工具 API网关提供页面调试工具,您可以使用该工具添加HTTP头部参数与body体参数,对API进行调试,简化API开发,降低API的开发维护成本。 版本管理 API
变更计费模式概述 在开通使用API网关后,如果发现当前计费模式无法满足您的业务需求,您可以变更计费模式。 按需付费变更为包年/包月 按需付费变更为包年/包月,需要您按需购买相应的版本,生成新的订单并支付后,包年/包月计费模式立即生效。 包年/包月变更为按需付费 包年/包月变更为按
调用API失败的可能原因 网络问题 调用API失败的场景分为三种:同一VPC内调用失败、不同VPC之间调用失败、公网调用失败。 VPC内调用API失败时,请检查域名是否和API自动分配的域名一致,如果域名错误,会导致调用API失败。 不同VPC之间调用API失败时,请检查两个VP
在“实例信息”页签,根据下表参数说明,查看或编辑实例的配置信息。 表1 实例信息 可编辑项 说明 基本信息 实例的基本信息,包括实例名称、实例ID、实例规格、可用区、描述、企业项目和时间窗。 用户可以根据实际需要修改基本信息。 用户可以单击“实例ID”右侧的复制实例ID信息。 计费信息 实例的计费模式和创建实例的时间。
变更计费模式 变更计费模式概述 按需转包年/包月 包年/包月转按需
配置API的Kafka日志推送 Kafka日志推送策略提供了把API的详细调用日志推送到Kafka的能力,方便用户获取API的调用日志信息。 如果此策略在当前实例中不支持,可提交工单升级实例到最新版本。 约束与限制 同一个环境中,一个API只能被一个Kafka日志推送策略绑定,但
在左侧导航栏选择“实例管理”。 在待变更计费模式的实例上单击“更多 > 转包周期”。 选择实例的购买时长,判断是否勾选“自动续费”,确认预计到期时间和配置费用后单击“去支付”。 进入支付页面,选择支付方式,确认付款,支付订单后即可完成按需转包年/包月。 父主题: 变更计费模式
操作步骤 方式一:在API网关控制台的实例管理中变更计费模式。 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待变更计费模式的实例上单击“更多 > 转按需”。 确认信息后,单击“到期转按需”。 方式二:在控制台的费用中心中变更计费模式。 在控制台的主菜单中选择“费用 >
支持http to https自动重定向 当用户的API采用http协议访问时,由于http没有传输安全与认证安全保障,可以开启自动重定向功能将API升级为安全的https协议访问,同时兼容已有的http协议。 仅当API的请求协议选择“HTTPS”或“HTTP&HTTPS”,且独立域名已绑
创建包周期规格变更订单 功能介绍 创建包周期规格变更订单。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/prepay-resize 表1 路径参数 参数 是否必选 参数类型 描述
变更APIG的实例规格 当实例规格无法满足您的业务需求时,您可以进行规格变更操作升配到更高规格版本。 约束与限制 规格变更过程中,长连接会发生闪断,需要重新建链,建议业务低峰期进行规格变更。 只能升配到更高规格,无法降配规格。 规格变更时,出私网IP会发生变化,如有相关防火墙配置
在已绑定独立域名所在行单击“选择SSL证书”。 选择已创建的证书单击“确定”。单向认证时,确保客户端认证为关闭状态。 调用API。 使用接口测试工具调用API,状态码为“200”表示调用成功。否则,请参考错误码章节处理。 双向认证 在“SSL证书管理”页签中,单击“创建SSL证书”。 表3
授权项变更公告 公告说明 自2024年9月起,当用户使用以下API的自定义策略授权时,用户需创建或更新自定义策略才可访问。 权限描述 对应的API 新增授权项 依赖授权项 IAM项目(Project) 企业项目(Enterprise Project) 获取SSL证书列表 GET
您即将访问非华为云网站,请注意账号财产安全