检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
授权API API在创建后,通过指定授权给某些凭据,让指定凭据能够调用API。 仅在API为APP认证时,才支持授权给凭据。 单个凭据最多同时授权1000个API。 前提条件 API已发布。 已创建环境。 已创建凭据。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例
发布API 创建完成的API,支持发布到不同的环境。API只有在发布到环境后,才支持被调用。API网关支持查看API发布历史(如版本、发布说明、发布时间和发布环境),并支持回滚到不同的API历史版本。 已发布的API,在修改信息后,需要重新发布才能将修改后的信息同步到环境中。 同一个
下线API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API网关控制台页面。
创建GRPC API API网关支持创建GRPC API。gRPC是RPC(远程过程调用)的一种,只需定义每个API的Request和Response,剩下的gRPC框架就可以完成。它的典型特征就是使用protobuf(protocol buffers)作为其接口定义语言(Interface
创建API API提供者把API接口配置在API网关中,开放后端能力。创建API分以下步骤: 前端配置 支持配置前端定义、安全配置和请求参数。 后端配置 支持配置默认后端、策略后端和返回结果。 (可选)为API添加策略 支持配置传统策略和插件策略。 API网关服务基于REST的API
克隆API API网关支持克隆已创建的API,提高API创建效率。您在克隆API时需要自定义API名称和API前端路径。 克隆API暂不支持克隆绑定策略,如果需要绑定策略请手动操作。 前提条件 已创建API,如果未创建API,请创建API。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例
创建API分组 创建API前,需要先创建API分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。 目前支持以下创建分组方式: 直接创建 创建一个简单的分组,不包含API,用户可自行创建API。 导入API设计文件 从本地导入已有的API文件
绑定凭据配额策略 凭据配额策略用于限制客户端(API调用者)在某个时间周期内的API调用次数,支持自定义重置时间。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > 凭据管理”。 单击凭据名称,进入凭据详情页面。 在“凭据配额策略
导入导出API 限制与兼容性说明 导入API 导出API 扩展定义 父主题: API管理
查看API列表 API列表支持查看当前实例下所有的API,包含URL、运行环境、安全认证等信息。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 您可以管理当前实例下的所有API,支持编辑、发布、调试等操作。 在左侧导航栏选择“API管理 > API列表
查看或编辑实例信息 实例创建完成后,可在控制台查看和编辑实例的配置信息。 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待查看或编辑的实例上,单击“查看控制台”或实例名称。 在“实例信息”页签,查看或编辑实例的配置信息。 表1 实例信息 可编辑项 说明 基本信息
扩展定义 x-apigateway-auth-type x-apigateway-request-type x-apigateway-match-mode x-apigateway-cors x-apigateway-is-send-fg-body-base64 x-apigateway-any-method
创建环境变量 API网关提供环境变量功能,通过创建环境变量,实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 当创建API时定义了变量标识,则需要在环境中添加变量
重置Secret Key唯一且不可重置,Secret支持重置,将Secret的值重新改变。重置完成后,原先的Secret将失效,绑定此凭据的API将无法调用,请更新SDK中的密钥对,并重新调用API。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择
变更实例规格 当实例规格无法满足您的业务需求时,您可以进行规格变更操作升配到更高规格版本。 当前支持ELB类型的实例规格变更,除墨西哥城一、北京一区域外,其他区域都支持规格变更。规格变更过程中,长连接会发生闪断,需要重新建链,建议业务低峰期进行规格变更。 只能升配到更高规格,无法降配规格
支持HTTP2.0 API网关支持HTTP/2(超文本传输协议第2版)访问协议,通常称之HTTP2.0。拥有二进制格式编码、多路复用共享连接和请求头压缩的能力,改进传输性能,实现低延迟和高吞吐量。 由于HTTP2.0是强依赖网络稳定性的,建议用户在使用HTTP2.0时使用比较稳定的网络场景
导入CCE工作负载 API网关支持导入云容器引擎(Cloud Container Engine,简称CCE)工作负载,提供API注册开放CCE服务能力。 如果当前实例不支持“导入CCE工作负载”,请联系客服。 注意事项 仅支持华为云CCE Turbo集群、VPC网络模型的CCE集群
导入CSE微服务 API网关支持导入微服务引擎(Cloud Service Engine,简称CSE)的微服务,提供API注册开放CSE服务能力。 如果当前实例不支持“导入CSE微服务”,请联系客服。 注意事项 仅支持导入未开启安全认证的微服务引擎。 您需保证当前实例与微服务实例地址网络可达
创建凭据并绑定API 使用APP认证的API,需要在API网关中创建一个凭据,以生成凭据ID和密钥对(Key、Secret)。将创建的凭据绑定API后,才可以使用APP认证调用API。客户端(API调用者)在调用API过程中,把密钥对替换SDK中的密钥对,API网关服务根据密钥对进行身份核对
自定义入方向端口 API网关提供自定义实例入端口功能,支持客户端通过不同的端口来访问不同的后端服务。 约束与限制 新增端口时,一个端口仅允许配置一种协议。当前仅支持HTTP和HTTPS协议。 独立域名与端口相关约束与限制内容,请参考约束与限制。 操作步骤 进入API网关控制台页面。