检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
该操作将导致此API无法被访问,可能会影响正在使用此API的应用或者用户,请确保已经告知用户。 已上架云商店的API,无法被删除。 已发布的API,需要先下线API,再删除。 操作步骤 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 通过以下任意一种方法,弹出“删除API”对话框。
调试API的时候,如何指定环境? 调试API时,默认使用APIG特定的debug环境,因此不能指定其他环境。 调试完成后,需将API发布到对应环境上,再使用代码或者postman等工具,并添加请求消息头X-Stage,才能访问指定环境。 父主题: 发布API
端口。 检查后端服务地址是否使用公网IP地址,如果使用,需要在APIG控制台的“实例管理 > 查看控制台 > 实例信息”界面开启出口地址。 检查VPC网络中的ACL配置,查看是否有相关ACL策略限制了API网关实例与后端服务所在子网的通信。 如果使用VPC通道,检查VPC通道业务
该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 通过以下任意一种方法,下线API。 在待下线的API所在行,单击“更多
支持HTTP、HTTPS,传输重要或敏感数据时推荐使用HTTPS。 请求路径前缀 请求路径通过配置“+”做前缀匹配。例如,请求路径为/a/{b+}。 端口 填写CCE工作负载的监测端口号。 安全认证 支持APP认证、华为IAM认证和无认证。 APP认证:表示由API网关服务负责接口请求的安全认证。推荐使用APP认证方式。
0的版本为稳定版本,发布到了生产环境供生产使用,同时,该API正处于迭代中,v1.1的版本是开发人员交付测试人员进行测试的版本,发布在测试环境上,而v1.2的版本目前开发团队正处于开发过程中,可以发布到开发环境进行自测等。 为此,API网关提供多环境管理功能,使租户能够最大化的模拟实际场景,低成本的接入API网关。
的参数值。 创建编排规则 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 单击“编排规则管理”页签。 单击“创建编排规则”,根据下表参数说明,配置编排规则。 表1 编排规则配置 参数 说明 规则名称 填写编排规
选择已有分组。 类型 支持HTTP、HTTPS,传输重要或敏感数据时推荐使用HTTPS。 微服务引擎 选择已创建的CSE微服务引擎。微服务引擎用于微服务应用的云中间件,为用户提供注册发现、服务治理、配置管理等高性能和高韧性的企业级云服务能力。 微服务 选择当前引擎下的微服务或新建
功能介绍 为指定的VPC通道添加后端实例 如果指定地址的后端实例已存在,则更新对应后端实例信息。如果请求体中包含多个重复地址的后端实例定义,则使用第一个定义。 引用负载通道类型的负载通道不支持添加或更新后端实例。 调用方法 请参见如何调用API。 URI POST /v2/{proj
0的版本为稳定版本,发布到了生产环境供生产使用,同时,该API正处于迭代中,v1.1的版本是开发人员交付测试人员进行测试的版本,发布在测试环境上,而v1.2的版本目前开发团队正处于开发过程中,可以发布到开发环境进行自测等。 为此,API网关提供多环境管理功能,使租户能够最大化的模拟实际场景,低成本的接入API网关。
入门实践 您可以根据自身的业务需求使用APIG提供的一系列常用实践。 表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。
自定义认证包含两种认证:前端自定义认证和后端自定义认证。 前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的认证系统时,导致您需要为不同的认证系统定制化开发
当自定义的认证已不再需要时,可以删除自定义认证。 自定义认证依赖函数工作流服务。如果当前Region没有上线函数工作流服务,则不支持使用自定义认证。 已在API中使用的自定义认证无法被删除。 前提条件 已创建自定义认证。 操作步骤 进入共享版控制台。 在“开放API > 自定义认证”页签,
支持的监控指标 功能说明 本节定义了API网关服务上报云监控服务的监控指标的命名空间,监控指标列表和维度定义,用户可以通过云监控服务提供管理控制台或API接口来检索API网关服务产生的监控指标和告警信息。 命名空间 共享版:SYS.APIG API网关监控指标 表1 API网关共享版支持的监控指标
version 版本 未使用 用户指定 未指定则使用当前时间 host server.url API分组域名 未使用 优先使用API分组的第一个自定义域名 如果分组未绑定自定义域名则使用分组的独立域名 basePath - - 将与每条API的请求路径拼接起来使用 未填充 paths
包年/包月实例从购买到被自动删除之前,您可以随时在控制台为实例续费,以延长实例的使用时间。 前提条件 请确认包年/包月实例还未到期。 操作步骤 方式一:在API网关控制台的实例管理中续费。 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待续费的实例上单击“更多 > 续费”。 参考表1选
创建API分组 功能介绍 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 专享版API网关已经陆续开放V2版本的接口,请优先使用V2版本接口管理您的API。 URI HTTP/HTTPS请求方法以及URI如下表所示。
选择“开放API > 环境管理”,进入到环境管理信息页面。 单击“创建环境”,弹出“创建环境”对话框。填写如表1所示信息。 图2 创建环境 表1 环境信息 信息项 描述 环境名称 API环境名称。 描述 环境描述信息。 单击“确定”,创建环境。 创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。
描述 CRU 否 vpc_status Integer 是否使用VPC通道 1:使用 2:不使用 CRU 否,默认不使用 vpc_info String VPC通道信息 CRU 否 如果vpc_status=1,即:使用VPC通道,则该字段必填 authorizer_id String
实例版本单价x使用时长x实例个数+公网带宽单价x使用时长x实例个数 公网带宽 API请求出公网带宽。 购买时长(小时) 使用API网关实例的时间长度,按小时计费,精确到秒。 购买个数(个) 使用API网关实例的个数。 计费示例 以按需使用为例,假设您已开通API网关实例专业版且未使用公网带宽,该版本按需计费的实例版本单价为12