检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 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 API提供者在API网关开放自己的API后,API调用者从API网关中调用API。 调用限制 如果您使用调试域名(创建API分组时系统分配的调试域名)访问API,该调试域名每天最多可以访问1000次。 获取API的调用信息 在调用API前,您需要向API提供者获取API的调用信息。
使用APIG专享版的流量控制2.0策略实现API的精细流控实施步骤 创建策略。 登录API网关控制台页面,创建流量控制2.0策略。 在左侧导航栏中选择“API管理 > API策略”,单击“创建策略”,在弹窗中选择“流量控制2.0”。 根据流控诉求,配置策略基本信息。 表1 策略基本信息
基本概念 API API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,应用将自身的服务能力封装成API,并通过API网关开放给用户调用。 API包括基本信息、前后端的请求路径和参数以及请求相关协议。 API分组 AP
包年/包月转按需 创建一个包年/包月实例后,您可以将该实例的计费模式转为按需计费,回收部分成本,同时更加灵活地按需使用实例。 包年/包月转按需,需包年/包月计费模式到期后,按需的计费模式才会生效。 前提条件 实例计费模式为“包年/包月”。 操作步骤 方式一:在API网关控制台的实例管理中变更计费模式。
调用API报“No backend available” 检查后端服务是否可以访问,如果不能访问,请修改后端服务。 检查后端服务对应的ECS安全组配置,查看是否已开放您需要的端口。 检查后端服务地址是否使用公网IP地址,如果使用,需要在APIG控制台的“实例管理 > 查看控制台 >
创建API分组 创建API前,需要先创建API分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。 目前支持以下创建分组方式: 直接创建 创建一个简单的分组,不包含API,用户可自行创建API。具体步骤请参见创建API分组。 导入API设计文件
配置API的流量控制2.0 流量控制2.0策略可以限制单位时间内API的被调用次数,支持参数流控、基础流控和基于基础流控的特殊流控。 基础流控 可以对API、用户、凭据、源IP进行多维度流控,与已有的配置API的流量控制功能一致但不兼容。 参数流控 支持根据Header、Path
自动续费 自动续费可以减少手动续费的管理成本,避免因忘记手动续费而导致实例被自动删除。自动续费的规则如下所述: 以实例的到期日计算第一次自动续费日期和计费周期。 实例自动续费周期以您选择的续费时长为准。例如,您选择了3个月,实例即在每次到期前自动续费3个月。 在实例到期前均可开通
费用账单 您可以在“费用 > 账单管理”查看资源的费用账单,以了解该资源在某个时间段的使用量和计费信息。 账单上报周期 包年/包月计费模式的资源完成支付后,会实时上报一条账单到计费系统进行结算。 按需计费模式的资源按照固定周期上报使用量到计费系统进行结算。按需计费模式产品根据使用
“条件来源”为“系统参数-前端认证参数”时,且当条件值填写boolean类型时,需全部小写。 单击“完成”,进入“API运行”页面,可查看API详情。 相关文档 基于API网关实现gRPC服务的路由转发 父主题: 创建API
配置API的流量控制 流量控制支持从用户、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。支持按分/秒粒度级别的流量控制。为了提供持续稳定的服务,您可以通过配置流控策略,针对部分API进行流量控制。 约束与限制 API配置流控策略相当于流控策略同步绑定了API。同一
添加特殊应用或租户 操作场景 如果需要为某个应用/租户设置特定的流控值,则通过添加特殊应用/租户可以实现。 前提条件 已创建应用,或已获取其他应用ID/租户ID。 添加特殊应用 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。 单击待添加特殊应用的流控策略的名称,进入流控详情页面。
包年/包月 包年/包月是一种先付费再使用的计费模式,适用于对资源需求稳定且希望降低成本的用户。通过选择包年/包月的计费模式,您可以预先购买专享版API网关并获得一定程度的价格优惠。下面介绍包年/包月API网关的计费规则。 适用场景 包年/包月计费模式需要用户预先支付一定时长的费用
构造请求 本节介绍如何构造REST API的请求,并以调用APIG服务的创建API分组(专享版API)说明如何调用API。 请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
删除特殊设置 功能介绍 删除某个流控策略的某个特殊配置。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials/{strategy_id}
解除API与ACL策略的绑定 功能介绍 解除某条API与ACL策略的绑定关系 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/{acl_bindings_id}
查询API分组概况 功能介绍 查询租户名下的API分组概况。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/resources/outline/groups 表1 路径参数 参数 是否必选
查询APP概况 功能介绍 查询租户名下的APP概况:已进行API访问授权的APP个数,未进行API访问授权的APP个数。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/resources/outline/apps