检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
专享版API网关需要购买专享版实例,并在实例中管理API。 计费说明 计费信息 计费模式 价格计算器 快速购买 购买专享版实例 04 使用 API网关提供全生命周期的API管理,从设计、开发、测试、发布、运维、上架、下架等, 实现完整的API解决方案。帮助您轻松构建、管理和部署任意规模的API。 API管理 自定义API的错误响应信息
已创建API分组和分组内的API。 已搭建完成后端服务。 操作步骤 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 通过以下任意一种方法,进入API调试页面。 在待调试的API所在行,单击“更多 > 调试”。 单击“API名称”,进入API详情页面。在右上角单击“调试”。
获取API的请求信息 在APIG实例控制台选择“API管理 > API列表”,单击API名称进入API详情,在“API运行”页签的API名称下方查看API的域名、请求路径和请求方法。 API已发布到环境 在APIG实例控制台选择“API管理 > API列表”,单击API名称进入API详情,在“API运行”页签的“前端配置
以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。关于IAM项目与企业项目的区别,详情请参见:IAM项目和企业项目的区别。 API网关服务管理控制操作相关的授权
状态码或网关响应内容,可在API分组管理中新增网关响应,按照您自己的响应内容,符合JSON格式即可。 类型 API类型: 公开:选择“公开”类型时,API支持上架。 私有:选择“私有”类型时,当该API所在分组上架时,该API不会上架。 安全认证 API认证方式: APP认证:表
修改实例配置参数会引起APIG业务中断,建议在无业务运行或业务低峰时修改配置参数。 配置实例参数 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待配置参数的实例上,单击“查看控制台”或实例名称。 单击“配置参数”页签,找到您需要调整的配置项,根据下表参数说明,进行修改。不同
促销季、节假日等,可提前购买包年/包月资源以应对高峰期的需求,避免资源紧张。 数据安全要求高:对于对数据安全性要求较高的业务,包年/包月计费模式可确保资源的持续使用,降低因资源欠费而导致的数据安全风险。 适用计费项 以下计费项支持包年/包月。 表1 适用计费项 计费项 说明 版本(实例规格)
中文字符必须为UTF-8或者unicode编码。 plugin_type 是 String 插件类型。 cors:跨域资源共享 set_resp_headers:HTTP响应头管理 kafka_log:Kafka日志推送 breaker:断路器 rate_limit: 流量控制 third_auth: 第三方认证 proxy_cache:
中文字符必须为UTF-8或者unicode编码。 plugin_type 是 String 插件类型。 cors:跨域资源共享 set_resp_headers:HTTP响应头管理 kafka_log:Kafka日志推送 breaker:断路器 rate_limit: 流量控制 third_auth: 第三方认证 proxy_cache:
新到负载通道中。 支持通过CCE工作负载标签配置进行灰度发布,完成灰度测试与版本切换。 提供多种认证方式,增加访问安全性。 提供访问流量控制策略,增加后端服务的安全性。 与直接访问容器应用相比,API网关提供流量控制,确保后端服务稳定运行。 支持多实例负载均衡,合理利用资源,增加系统可靠性。
路径:接口请求路径。此处填写“/hello”。 网关响应 API网关未能成功处理API请求,从而产生的错误响应。此处默认“default”。 安全认证 选择API认证方式,此处选择“无认证”。(无认证模式,安全级别低,所有用户均可访问,不推荐在实际业务中使用) 单击“下一步”,配置后端信息。 表2 后端配置 参数 配置说明
参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 action 否 String
API网关未能成功处理API请求,从而产生的错误响应。 默认的网关响应为“default”。 匹配模式 此处选择“前缀匹配”。 安全认证 选择API认证方式,此处选择“无认证”。(无认证模式,安全级别低,所有用户均可访问,不推荐在实际业务中使用) 根据下表参数说明,配置后端信息。配置完成后,单击“完成”。
参数”为例,讲述用户如何通过设置“系统参数-前端认证参数”策略条件将API请求转发到指定的后端服务中。 约束与限制 添加策略后端前,前端的安全认证方式应选“自定义认证”或使用双重认证(APP认证或IAM认证)。 添加策略后端前,必须定义一个默认后端,不满足任何一个策略后端的API请求,都将转发到默认的API后端。
up_id、page_size、page_no。 请求消息 表2 参数说明 名称 是否必选 类型 说明 sign_id 是 String 安全密钥编号 env_id 否 String 环境编号 api_id 否 String API编号 api_name 否 String API名称
入门实践 您可以根据自身的业务需求使用APIG提供的一系列常用实践。 表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。
调试APIG创建的API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 约束与限制 后端路径中含有环境变量的API,不支持调试。 如果API绑定了插件策略或传统策略,在调试API时,策略均不生效。 调试API时,后端超时时间最大支持60s。
单个用户调用API次数上限,仅适用于API的安全认证方式为APP认证或IAM认证。 不超过“API流量限制”。 与“时长”配合使用,表示单位时间内的单个用户请求次数上限。 如果主账号下有多个子用户访问API,按主账号累计的调用次数进行限制。 应用流量限制 单个应用调用API次数上限,仅适用于API的安全认证方式为APP认证。
例都会有单独的公网入口IP和公网出口IP,该IP与原有的共享版IP不同,如果上游和下游(服务端和客户端)的相关服务有网络安全策略的设置,需要修改相应的网络安全策略,放通对应IP的访问。 内网出入口的变化 每个专享版实例都会拥有一个VPC内的入口私有IP,以及VPC内的多个出口私有
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 sign_id 是 String 安全密钥编号 env_id 否 String 环境编号 api_id