检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
APIG业务使用流程 API网关(API Gateway)是为您提供高性能、高可用、高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。 API网关支持专享版和共享版(存量
APIG的API错误码说明 当调用API时,可能遇到下表中的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非固定不变,有时会对错误信息进行优化修改。
错误码 当调用API时,可能遇到如表1所示的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非固定不变,有时会对错误信息进行优化修改。
API分组是同一种业务API的集合,API开发者以API分组为单位,管理分组内的所有API。 环境 为了方便管理API的生命周期,API网关定义了API受限使用范围,这个受限使用的范围,称为环境,例如API的测试环境,开发环境等。 环境定义了API生命周期管理过程中的不同状态,API可以被发布到不同的自定义环境中。
方式一:在API网关控制台的实例管理中变更计费模式。 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待变更计费模式的实例上单击“更多 > 转按需”。 确认信息后,单击“到期转按需”。 方式二:在控制台的费用中心中变更计费模式。 在控制台的主菜单中选择“费用 > 续费管理”。 自定义查询条件。
检查后端服务对应的ECS安全组配置,查看是否已开放您需要的端口。 检查后端服务地址是否使用公网IP地址,如果使用,需要在APIG控制台的“实例管理 > 查看控制台 > 实例信息”界面开启出口地址。 检查VPC网络中的ACL配置,查看是否有相关ACL策略限制了API网关实例与后端服务所在子网的通信。
根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击“创建API分组 > 直接创建”,根据下表参数说明,在弹框中填写分组信息。 表1 分组信息表 参数 说明 分组名称 API分组名称,用于将API接口进行分组管理。 支持中文、英文、数字、中划线、下划线、点、
登录API网关控制台,创建流量控制2.0策略。具体操作步骤请参考《API网关用户指南》中的流量控制2.0策略。 在左侧导航栏中选择“API管理 > API策略”,单击“创建策略”,在弹窗中选择“流量控制2.0”。 根据流控诉求,配置策略基本信息。 表1 策略基本信息 参数 配置说明
已有能力,避免重复开发造成的资源浪费。 企业能力开放 当今企业面临巨大的挑战,企业的发展需要依赖外部合作伙伴的能力,典型的例子如使用第三方平台支付、合作方账户登录等。通过API网关将企业内部服务能力以标准API的形式开放给合作伙伴,与合作伙伴共享服务和数据,达成深度合作,构建企业共赢生态。
更多关于自动续费的规则介绍请参见自动续费规则说明。 前提条件 请确认包年/包月实例还未到期。 操作步骤 方式一:在API网关控制台的实例管理中开通自动续费。 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待续费的实例上单击“更多 > 开通自动续费”。 在“开通自动续费”页面,设置如下参数。。 表1
常会在10:00左右才进行扣费。在“费用 > 账单管理 > 流水和明细账单 > 流水账单”中,“消费时间”即按需产品的实际使用时间。 查看指定资源的账单 使用实例ID查询账单 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待查看的实例上复制实例ID。 在主菜单中选择“费用
创建用于前端自定义认证的函数 操作场景 如果您想要使用自己的认证系统对API的访问进行认证鉴权,您可以在API管理中创建一个前端自定义认证来实现此功能。在使用前端自定义认证对前端请求进行认证鉴权前,您需要先在FunctionGraph创建一个函数,通过函数定义您所需的认证信息。函
√ √ IP&用户访问控制 √ √ 安全认证 √ √ API生命周期管理 √ √ 自定义域名 √ √ Swagger导入导出 √ √ 支持VPC通道(负载通道) √ √ API参数编排 √ √ API分组变量管理 √ √ 高级功能 自定义认证 √ √ 支持对接API云商店 √ 即将支持
专享版-API分组管理 专享版-环境管理 专享版-环境变量管理 专享版-流控策略管理 专享版-API管理 专享版-签名密钥管理 专享版-签名密钥绑定关系管理 专享版-API绑定流控策略 专享版-设置特殊流控 专享版-APP授权管理 专享版-概要查询 专享版-域名管理 专享版-ACL策略管理
共享版API(仅存量用户使用) API分组管理 API管理 APP管理 APP授权管理 环境管理 环境变量管理 流控策略管理 API绑定流控策略 设置特殊流控 ACL策略管理 API绑定ACL策略 云商店订购信息查询 配置管理 概要查询 签名密钥管理 签名密钥绑定关系管理 域名管理 VPC通道管理 监控信息查询
专享版API(V1)(待下线) 使用限制 API分组管理(待下线) API管理(待下线) APP管理(待下线) APP授权管理(待下线) 环境管理(待下线) 环境变量管理(待下线) 流控策略管理(待下线) API绑定流控策略(待下线) 设置特殊流控(待下线) ACL策略管理(待下线) API绑定ACL策略(待下线)
专享版API网关需要购买专享版实例,并在实例中管理API。 计费说明 计费信息 计费模式 价格计算器 快速购买 购买专享版实例 04 使用 API网关提供全生命周期的API管理,从设计、开发、测试、发布、运维、上架、下架等, 实现完整的API解决方案。帮助您轻松构建、管理和部署任意规模的API。 API管理 自定义API的错误响应信息
文档修订记录 发布日期 修订记录 2024-06-26 新增编排规则管理接口。 新增实例自定义入方向端口管理接口。 2024-01-19 新增查询实例支持的特性列表接口。 新增设置调试域名是否可以访问接口。 新增异步任务管理接口。 2023-09-12 增加修改变量接口。 增加校验API定义接口。
共享版操作指导(仅存量用户使用) APIG使用流程 进入共享版控制台 API分组管理 API管理 流量控制 访问控制 环境管理 签名密钥 VPC通道 自定义认证 监控 应用管理 SDK 已购买API 调用已发布的API 云审计服务支持的关键操作
和查询等接口。 APP管理 包括APP的创建、修改、删除、重置密钥和查询等接口。 APP授权管理 包括授权、解除授权、查询授权关系等接口。 环境管理 包括环境的创建、修改、删除和查询接口。 环境变量管理 包括环境变量的创建、删除和查询等接口。 流控策略管理 包括流控策略的创建、修改、删除和查询等接口。